Documentation

    Class EnokiWallet

    Interface of a Wallet, also referred to as a Standard Wallet.

    A Standard Wallet implements and adheres to the Wallet Standard.

    Implements

    Index

    Constructors

    • Parameters

      • __namedParameters: {
            client: SuiClient;
            clientId: string;
            extraParams?: Record<string, string>;
            flow: INTERNAL_ONLY_EnokiFlow;
            icon:
                | `data:image/svg+xml;base64,${string}`
                | `data:image/webp;base64,${string}`
                | `data:image/png;base64,${string}`
                | `data:image/gif;base64,${string}`;
            name: string;
            provider: AuthProvider;
            redirectUrl?: string;
            windowFeatures?: string
            | (() => string);
        }

      Returns EnokiWallet

    Accessors

    • get accounts(): ReadonlyWalletAccount[]

      Accounts that the app is authorized to use.

      This can be set by the Wallet so the app can use authorized accounts on the initial page load.

      The "@wallet-standard/features".ConnectFeature | standard:connect feature should be used to obtain authorization to the accounts.

      The "@wallet-standard/features".EventsFeature | standard:events feature should be used to notify the app if the value changes.

      Returns ReadonlyWalletAccount[]

    • get chains(): readonly ["sui:mainnet" | "sui:testnet" | "sui:devnet"]

      Chains supported by the Wallet.

      A chain is an IdentifierString which identifies a blockchain in a canonical, human-readable format. CAIP-2 chain IDs are compatible with this, but are not required to be used.

      Each blockchain should define its own chains by extension of the Wallet Standard, using its own namespace. The standard and experimental namespaces are reserved by the Wallet Standard.

      The "@wallet-standard/features".EventsFeature | standard:events feature should be used to notify the app if the value changes.

      Returns readonly ["sui:mainnet" | "sui:testnet" | "sui:devnet"]

    • get icon(): | `data:image/svg+xml;base64,${string}`
      | `data:image/webp;base64,${string}`
      | `data:image/png;base64,${string}`
      | `data:image/gif;base64,${string}`

      Icon of the Wallet. This may be displayed by the app.

      Must be read-only, static, and canonically defined by the wallet extension or application.

      Returns
          | `data:image/svg+xml;base64,${string}`
          | `data:image/webp;base64,${string}`
          | `data:image/png;base64,${string}`
          | `data:image/gif;base64,${string}`

    • get id(): string

      Unique identifier of the Wallet.

      If not provided, the wallet name will be used as the identifier.

      Returns string

    • get name(): string

      Name of the Wallet. This may be displayed by the app.

      Must be read-only, static, descriptive, unique, and canonically defined by the wallet extension or application.

      Returns string

    • get version(): "1.0.0"

      Version of the Wallet Standard implemented by the Wallet.

      Must be read-only, static, and canonically defined by the Wallet Standard.

      Returns "1.0.0"

    MMNEPVFCICPMFPCPTTAAATR