Class WalletPluginCloudWallet

Hierarchy

AbstractWalletPlugin
- WalletPluginCloudWallet

Implements

WalletPlugin

Index

Constructors

constructor

new WalletPluginCloudWallet(
options?: WalletPluginCloudWalletOptions,
): WalletPluginCloudWallet
Constructor to allow overriding of plugin configuration.
Parameters
- Optionaloptions: WalletPluginCloudWalletOptions
Returns WalletPluginCloudWallet
Overrides AbstractWalletPlugin.constructor
- Defined in wallet-plugin-cloudwallet/src/index.ts:79

Properties

_data

_data: WalletPluginData

`Readonly`config

config: WalletPluginConfig = ...

The logic configuration for the wallet plugin.

id

id: string = 'cloudwallet'

The unique identifier for the wallet plugin.

loginTimeout

loginTimeout: number = 300000

`Readonly`metadata

metadata: WalletPluginMetadata = ...

The metadata for the wallet plugin to be displayed in the user interface.

translations

translations: {
    en: {
        connecting: string;
        error: {
            closed: string;
            endpoint: string;
            exception: string;
            popup: string;
            response: string;
            timeout: string;
        };
        login: { popup: string };
        transact: { popup: string };
    };
    ko: {
        connecting: string;
        error: {
            closed: string;
            endpoint: string;
            exception: string;
            popup: string;
            response: string;
            timeout: string;
        };
        login: { popup: string };
        transact: { popup: string };
    };
    "zh-Hans": {
        connecting: string;
        error: {
            closed: string;
            endpoint: string;
            exception: string;
            popup: string;
            response: string;
            timeout: string;
        };
        login: { popup: string };
        transact: { popup: string };
    };
    "zh-Hant": {
        connecting: string;
        error: {
            closed: string;
            endpoint: string;
            exception: string;
            popup: string;
            response: string;
            timeout: string;
        };
        login: { popup: string };
        transact: { popup: string };
    };
} = defaultTranslations

The translations for this plugin

url

url: string = 'https://www.mycloudwallet.com'

Cloud Wallet Configuration

Accessors

data

get data(): WalletPluginData
A method to return the data that needs to persist for the plguin - Used in serialization

Returns WalletPluginData
Implementation of WalletPlugin.data

Inherited from AbstractWalletPlugin.data
- Defined in session/lib/session.d.ts:584
set data(data: WalletPluginData): void
A method to return the data that needs to persist for the plguin - Used in serialization
Parameters
- data: WalletPluginData
Returns void
Implementation of WalletPlugin.data

Inherited from AbstractWalletPlugin.data
- Defined in session/lib/session.d.ts:585

Methods

clone

clone(): WalletPlugin
Shallow copy with fresh data and metadata; every other field must be safe to share.

Returns WalletPlugin
Implementation of WalletPlugin.clone

Inherited from AbstractWalletPlugin.clone
- Defined in session/lib/session.d.ts:588

getWalletResponse

getWalletResponse(
    resolved: ResolvedSigningRequest,
    context: TransactContext,
    t: (key: string, options?: UserInterfaceTranslateOptions) => string,
    timeout?: number,
): Promise<WAXCloudWalletSigningResponse>
Parameters
- resolved: ResolvedSigningRequest
- context: TransactContext
- t: (key: string, options?: UserInterfaceTranslateOptions) => string
- timeout: number = 300000
Returns Promise<WAXCloudWalletSigningResponse>
- Defined in wallet-plugin-cloudwallet/src/index.ts:280

login(context: LoginContext): Cancelable<WalletPluginLoginResponse>
Performs the wallet logic required to login and return the chain and permission level to use.
Parameters
- context: LoginContext
Returns Cancelable<WalletPluginLoginResponse>
Promise
Implementation of WalletPlugin.login

Overrides AbstractWalletPlugin.login
- Defined in wallet-plugin-cloudwallet/src/index.ts:99

logout

logout(): Promise<void>
Optional method that is used to signal to the wallet plugin to logout the user.

Returns Promise<void>
A promise that resolves when the wallet plugin logout process is complete.

Throws
An error if the logout could not happen.
Implementation of WalletPlugin.logout
- Defined in wallet-plugin-cloudwallet/src/index.ts:315

serialize

serialize(): SerializedWalletPlugin
Serialize the [[WalletPlugin]] ID and data into a plain object.

Returns SerializedWalletPlugin
Implementation of WalletPlugin.serialize

Inherited from AbstractWalletPlugin.serialize
- Defined in session/lib/session.d.ts:586

sign

sign(
resolved: ResolvedSigningRequest,
context: TransactContext,
): Cancelable<WalletPluginSignResponse>
Performs the wallet logic required to sign a transaction and return the signature.
Parameters
- resolved: ResolvedSigningRequest
  ResolvedSigningRequest
- context: TransactContext
Returns Cancelable<WalletPluginSignResponse>
Promise
Implementation of WalletPlugin.sign

Overrides AbstractWalletPlugin.sign
- Defined in wallet-plugin-cloudwallet/src/index.ts:170

waxLogin

waxLogin(context: LoginContext): Promise<WalletPluginLoginResponse>
Parameters
- context: LoginContext
Returns Promise<WalletPluginLoginResponse>
- Defined in wallet-plugin-cloudwallet/src/index.ts:106

waxSign

waxSign(
resolved: ResolvedSigningRequest,
context: TransactContext,
): Promise<WalletPluginSignResponse>
Parameters
- resolved: ResolvedSigningRequest
- context: TransactContext
Returns Promise<WalletPluginSignResponse>
- Defined in wallet-plugin-cloudwallet/src/index.ts:180

Class WalletPluginCloudWallet

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WalletPluginCloudWallet

Properties

_data

Readonlyconfig

id

loginTimeout

Readonlymetadata

translations

url

Accessors

data

Returns WalletPluginData

Parameters

Returns void

Methods

clone

Returns WalletPlugin

getWalletResponse

Parameters

Returns Promise<WAXCloudWalletSigningResponse>

login

Parameters

Returns Cancelable<WalletPluginLoginResponse>

logout

Returns Promise<void>

Throws

serialize

Returns SerializedWalletPlugin

sign

Parameters

Returns Cancelable<WalletPluginSignResponse>

waxLogin

Parameters

Returns Promise<WalletPluginLoginResponse>

waxSign

Parameters

Returns Promise<WalletPluginSignResponse>

Settings

On This Page

`Readonly`config

`Readonly`metadata