Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | 22x 1x 1x 2x 1x | import {Checksum256Type, PermissionLevelType} from '@wharfkit/antelope' import type {Cancelable, LocaleDefinitions} from '@wharfkit/common' import {LoginOptions} from './kit' import {LoginContext} from './login' import {CreateAccountContext} from './index-module' /** * The arguments for a [[UserInterface.prompt]] call. */ export interface PromptArgs { title: string body?: string optional?: boolean elements: PromptElement[] } /** * The different types of elements that can be used in a [[PromptArgs]]. */ export interface PromptElement { type: 'accept' | 'asset' | 'button' | 'close' | 'countdown' | 'link' | 'qr' | 'textarea' label?: string data?: unknown } /** * The response for a [[UserInterface.prompt]] call. */ // eslint-disable-next-line @typescript-eslint/no-empty-object-type export interface PromptResponse {} /** * The response for a login call of a [[UserInterface]]. */ export interface UserInterfaceLoginResponse { chainId?: Checksum256Type permissionLevel?: PermissionLevelType walletPluginIndex: number } /** * The response for an account creation call of a [[UserInterface]]. */ export type UserInterfaceAccountCreationResponse = { chain?: Checksum256Type // If account creation can only be done on one chain. pluginId?: string // The id of the plugin that was selected (if more than one plugin was available). } /** * A single whitelist entry for UI display purposes. */ export interface SessionKeyWhitelistItem { /** Contract account name. */ contract: string /** Optional array of action names. If omitted, all actions are whitelisted. */ actions?: string[] } /** * Arguments passed to the session key consent UI callback. */ export interface SessionKeyConsentArgs { /** The name of the application requesting session key creation. */ appName: string /** The list of contracts and actions that will be whitelisted. */ whitelist: SessionKeyWhitelistItem[] } /** * The arguments for a session key conflict call. */ export interface SessionKeyConflictArgs { appName: string existingKeyCount: number } /** * The response for a session key conflict call. */ export type SessionKeyConflictResponse = 'add' | 'replace' | 'cancel' /** * Arguments passed to the session key mismatch UI callback. */ export interface SessionKeyMismatchArgs { /** The name of the application. */ appName: string /** Actions in local whitelist but not linked on-chain. */ added: SessionKeyWhitelistItem[] /** Actions linked on-chain but not in local whitelist. */ removed: SessionKeyWhitelistItem[] } /** * The response for a session key mismatch call. */ export type SessionKeyMismatchResponse = 'update' | 'dismiss' /** * Arguments passed to the session key removal UI callback. */ export interface SessionKeyRemoveArgs { /** The name of the application. */ appName: string } /** * The options to pass to [[UserInterface.translate]]. */ export interface UserInterfaceTranslateOptions { default: string [key: string]: unknown } /** * The translate function the UserInterface expects and uses. */ export type UserInterfaceTranslateFunction = ( key: string, options?: UserInterfaceTranslateOptions, namespace?: string ) => string /** * Interface which all 3rd party user interface plugins must implement. */ export interface UserInterface { /** Interact with the user to collect the data needed for a [[UserInterfaceLoginResponse]]. */ login(context: LoginContext): Promise<UserInterfaceLoginResponse> /** Inform the UI that an error has occurred */ onError: (error: Error) => Promise<void> /** Inform the UI that an account creation process has started */ onAccountCreate: ( context: CreateAccountContext ) => Promise<UserInterfaceAccountCreationResponse> /** Inform the UI that a account creation call has completed **/ onAccountCreateComplete: () => Promise<void> /** Inform the UI that a login call has started **/ onLogin: () => Promise<void> /** Inform the UI that a login call has completed **/ onLoginComplete: () => Promise<void> /** Inform the UI that a transact call has started **/ onTransact: () => Promise<void> /** Inform the UI that a transact call has completed **/ onTransactComplete: () => Promise<void> /** Inform the UI that a transact call has started signing the transaction **/ onSign: () => Promise<void> /** Inform the UI that a transact call has completed signing the transaction **/ onSignComplete: () => Promise<void> /** Inform the UI that a transact call has started broadcasting the transaction **/ onBroadcast: () => Promise<void> /** Inform the UI that a transact call has completed broadcasting the transaction **/ onBroadcastComplete: () => Promise<void> /** Prompt the user with a custom UI element **/ prompt: (args: PromptArgs) => Cancelable<PromptResponse> /** Update the displayed modal status from a TransactPlugin **/ status: (message: string) => void /** Translate a string using the UI's language **/ translate: UserInterfaceTranslateFunction /** Returns a translator for a specific namespace */ getTranslate: (namespace?: string) => UserInterfaceTranslateFunction /** Programmatically add new localization strings to the user interface */ addTranslations: (translations: LocaleDefinitions) => void /** Optional: Show session key consent UI */ onSessionKeyConsent?: (args: SessionKeyConsentArgs) => Promise<boolean> /** Optional: Show session key conflict resolution UI */ onSessionKeyConflict?: (args: SessionKeyConflictArgs) => Promise<SessionKeyConflictResponse> /** Optional: Show session key whitelist mismatch UI */ onSessionKeyMismatch?: (args: SessionKeyMismatchArgs) => Promise<SessionKeyMismatchResponse> /** Optional: Show session key removal confirmation UI */ onSessionKeyRemove?: (args: SessionKeyRemoveArgs) => Promise<boolean> /** Optional: Get current minimal mode state */ getMinimal?: () => boolean /** Optional: Enable/disable minimal mode temporarily for session key transactions */ setMinimal?: (minimal: boolean) => void } /** * Abstract class which all 3rd party [[UserInterface]] implementations may extend. */ export abstract class AbstractUserInterface implements UserInterface { abstract login(context: LoginContext): Promise<UserInterfaceLoginResponse> abstract onError(error: Error): Promise<void> abstract onAccountCreate( context: CreateAccountContext ): Promise<UserInterfaceAccountCreationResponse> abstract onAccountCreateComplete(): Promise<void> abstract onLogin(options?: LoginOptions): Promise<void> abstract onLoginComplete(): Promise<void> abstract onTransact(): Promise<void> abstract onTransactComplete(): Promise<void> abstract onSign(): Promise<void> abstract onSignComplete(): Promise<void> abstract onBroadcast(): Promise<void> abstract onBroadcastComplete(): Promise<void> abstract prompt(args: PromptArgs): Cancelable<PromptResponse> abstract status(message: string): void translate(key: string, options?: UserInterfaceTranslateOptions, namespace?: string): string { throw new Error( 'The `translate` method must be implemented in this UserInterface. Called with: ' + JSON.stringify({ key, options, namespace, }) ) } getTranslate(namespace?: string | undefined): UserInterfaceTranslateFunction { return (key, options) => this.translate(key, options, namespace) } addTranslations(translations: LocaleDefinitions) { throw new Error( 'The `addTranslations` method must be implemented in this UserInterface. Called with: ' + JSON.stringify(translations) ) } } |