Class WalletPluginAnchor

Hierarchy

AbstractWalletPlugin
- WalletPluginAnchor

Index

Constructors

Constructors

constructor

new WalletPluginAnchor(options?: WalletPluginAnchorOptions): WalletPluginAnchor
Parameters
- Optionaloptions: WalletPluginAnchorOptions
Returns WalletPluginAnchor
Overrides AbstractWalletPlugin.constructor
- Defined in wallet-plugin-anchor/src/index.ts:83

Properties

_data

_data: WalletPluginData

auth

auth: PermissionLevel | undefined

buoyUrl

buoyUrl: string

buoyWs

buoyWs: WebSocket | undefined

chain

chain: Checksum256 | undefined

channelName

channelName: string | undefined

channelUrl

channelUrl: string | undefined

`Readonly`config

config: WalletPluginConfig = ...

The logic configuration for the wallet plugin.

id

id: string = 'anchor'

The unique identifier for the wallet plugin.

`Readonly`metadata

metadata: WalletPluginMetadata = ...

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

privateKey

privateKey: PrivateKey | undefined

requestKey

requestKey: PublicKey | undefined

signerKey

signerKey: PublicKey | undefined

translations

translations: {
    en: {
        error: {
            cancelled: string;
            expired: string;
            invalid_response: string;
            not_completed: string;
        };
        fallback: { body: string; label: string };
        login: { body: string; link: string; title: string };
        mode: {
            app: { detail: string; label: string };
            body: string;
            switch: { to_app: string; to_web: string };
            title: string;
            web: { detail: string; detail_no_ledger: string; label: string };
        };
        recovery: { body: string; title: string };
        transact: {
            await: string;
            body: string;
            label: string;
            link: string;
            title: string;
        };
        web: {
            blocked: { body: string; label: string; title: string };
            waiting: { body: string; title: string };
        };
    };
    ko: {
        error: {
            cancelled: string;
            expired: string;
            invalid_response: string;
            not_completed: string;
        };
        fallback: { body: string; label: string };
        login: { body: string; link: string; title: string };
        mode: {
            app: { detail: string; label: string };
            body: string;
            switch: { to_app: string; to_web: string };
            title: string;
            web: { detail: string; detail_no_ledger: string; label: string };
        };
        recovery: { body: string; title: string };
        transact: {
            await: string;
            body: string;
            label: string;
            link: string;
            title: string;
        };
        web: {
            blocked: { body: string; label: string; title: string };
            waiting: { body: string; title: string };
        };
    };
    "zh-Hans": {
        error: {
            cancelled: string;
            expired: string;
            invalid_response: string;
            not_completed: string;
        };
        fallback: { body: string; label: string };
        login: { body: string; link: string; title: string };
        mode: {
            app: { detail: string; label: string };
            body: string;
            switch: { to_app: string; to_web: string };
            title: string;
            web: { detail: string; detail_no_ledger: string; label: string };
        };
        recovery: { body: string; title: string };
        transact: {
            await: string;
            body: string;
            label: string;
            link: string;
            title: string;
        };
        web: {
            blocked: { body: string; label: string; title: string };
            waiting: { body: string; title: string };
        };
    };
    "zh-Hant": {
        error: {
            cancelled: string;
            expired: string;
            invalid_response: string;
            not_completed: string;
        };
        fallback: { body: string; label: string };
        login: { body: string; link: string; title: string };
        mode: {
            app: { detail: string; label: string };
            body: string;
            switch: { to_app: string; to_web: string };
            title: string;
            web: { detail: string; detail_no_ledger: string; label: string };
        };
        recovery: { body: string; title: string };
        transact: {
            await: string;
            body: string;
            label: string;
            link: string;
            title: string;
        };
        web: {
            blocked: { body: string; label: string; title: string };
            waiting: { body: string; title: string };
        };
    };
} = defaultTranslations

The translations for this plugin

webAuthenticatorUrls

webAuthenticatorUrls: Record<string, string>

webFallbackDelayMs

webFallbackDelayMs: number

Accessors

data

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

Returns WalletPluginData
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
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
Inherited from AbstractWalletPlugin.clone
- Defined in session/lib/session.d.ts:588

getMode

getMode(): AnchorMode | undefined
Return the mode stored or inferred for signing; this does not imply a login override.

Returns AnchorMode | undefined
- Defined in wallet-plugin-anchor/src/index.ts:142

handleLogin

handleLogin(context: LoginContext): Promise<WalletPluginLoginResponse>
Parameters
- context: LoginContext
Returns Promise<WalletPluginLoginResponse>
- Defined in wallet-plugin-anchor/src/index.ts:167

login(context: LoginContext): Promise<WalletPluginLoginResponse>
Parameters
- context: LoginContext
Returns Promise<WalletPluginLoginResponse>
Overrides AbstractWalletPlugin.login
- Defined in wallet-plugin-anchor/src/index.ts:126

openWallet

openWallet(
chain?: ChainDefinition<AccountObject> | Checksum256Type,
): Window | null
Open the chain's web authenticator in a user gesture; unsupported chains return null.
Parameters
- Optionalchain: ChainDefinition<AccountObject> | Checksum256Type
Returns Window | null
- Defined in wallet-plugin-anchor/src/index.ts:147

serialize

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

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

setMode

setMode(mode: AnchorMode | undefined): void
Override login routing until cleared; pass undefined to restore the chooser.
Parameters
- mode: AnchorMode | undefined
Returns void
- Defined in wallet-plugin-anchor/src/index.ts:131

sign

sign(
resolved: ResolvedSigningRequest,
context: TransactContext,
): Promise<WalletPluginSignResponse>
Parameters
- resolved: ResolvedSigningRequest
- context: TransactContext
Returns Promise<WalletPluginSignResponse>
Overrides AbstractWalletPlugin.sign
- Defined in wallet-plugin-anchor/src/index.ts:354

`Static`openWallet

openWallet(
chain?: ChainDefinition<AccountObject> | Checksum256Type,
webAuthenticatorUrls?: Record<string, string>,
): Window | null
Open a chain's web authenticator with URL overrides; unsupported chains return null.
Parameters
- Optionalchain: ChainDefinition<AccountObject> | Checksum256Type
- OptionalwebAuthenticatorUrls: Record<string, string>
Returns Window | null
- Defined in wallet-plugin-anchor/src/index.ts:152

Class WalletPluginAnchor

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WalletPluginAnchor

Properties

_data

auth

buoyUrl

buoyWs

chain

channelName

channelUrl

Readonlyconfig

id

Readonlymetadata

privateKey

requestKey

signerKey

translations

webAuthenticatorUrls

webFallbackDelayMs

Accessors

data

Returns WalletPluginData

Parameters

Returns void

Methods

clone

Returns WalletPlugin

getMode

Returns AnchorMode | undefined

handleLogin

Parameters

Returns Promise<WalletPluginLoginResponse>

login

Parameters

Returns Promise<WalletPluginLoginResponse>

openWallet

Parameters

Returns Window | null

serialize

Returns SerializedWalletPlugin

setMode

Parameters

Returns void

sign

Parameters

Returns Promise<WalletPluginSignResponse>

StaticopenWallet

Parameters

Returns Window | null

Settings

On This Page

`Readonly`config

`Readonly`metadata

`Static`openWallet