Interface WalletApi

Hierarchy

  • WalletApi

Properties

address.get address.subscribe connection.close connection.open message.sign transaction.sign typedData.sign

Properties

address.get

address.get: (() => Promise<`ak_${string}`[]>)

Type declaration

    • (): Promise<`ak_${string}`[]>

    • Returns Promise<`ak_${string}`[]>

address.subscribe

address.subscribe: ((p: {
    type: SUBSCRIPTION_TYPES;
    value: "connected" | "current";
}) => Promise<{
    address: Accounts;
    subscription: ("connected" | "current")[];
}>)

Type declaration

    • (p: {
          type: SUBSCRIPTION_TYPES;
          value: "connected" | "current";
      }): Promise<{
          address: Accounts;
          subscription: ("connected" | "current")[];
      }>

    • Parameters

      Returns Promise<{
          address: Accounts;
          subscription: ("connected" | "current")[];
      }>

connection.close

connection.close: ((p: any) => void)

Type declaration

    • (p: any): void

    • Parameters

      • p: any

      Returns void

connection.open

connection.open: ((p: {
    connectNode: boolean;
    icons?: Icons;
    name: string;
    version: 1;
}) => Promise<WalletInfo & {
    node?: Node;
}>)

Type declaration

    • (p: {
          connectNode: boolean;
          icons?: Icons;
          name: string;
          version: 1;
      }): Promise<WalletInfo & {
          node?: Node;
      }>

    • Parameters

      • p: {
            connectNode: boolean;
            icons?: Icons;
            name: string;
            version: 1;
        }
        • connectNode: boolean
        • Optional icons?: Icons
        • name: string
        • version: 1

      Returns Promise<WalletInfo & {
          node?: Node;
      }>

message.sign

message.sign: ((p: {
    message: string;
    onAccount: `ak_${string}`;
}) => Promise<{
    signature: string;
}>)

Type declaration

    • (p: {
          message: string;
          onAccount: `ak_${string}`;
      }): Promise<{
          signature: string;
      }>

    • Parameters

      • p: {
            message: string;
            onAccount: `ak_${string}`;
        }
        • message: string
        • onAccount: `ak_${string}`

      Returns Promise<{
          signature: string;
      }>

transaction.sign

transaction.sign: ((p: {
    innerTx?: boolean;
    networkId: string;
    onAccount: `ak_${string}`;
    returnSigned: boolean;
    tx: `tx_${string}`;
}) => Promise<{
    signedTransaction?: `tx_${string}`;
    transactionHash?: Partial<{
        blockHash: string;
        blockHeight: number;
        hash: string;
        signatures: string[];
        tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; };
    }> & {
        hash: `th_${string}`;
        rawTx: `tx_${string}`;
    };
}>)

Type declaration

    • (p: {
          innerTx?: boolean;
          networkId: string;
          onAccount: `ak_${string}`;
          returnSigned: boolean;
          tx: `tx_${string}`;
      }): Promise<{
          signedTransaction?: `tx_${string}`;
          transactionHash?: Partial<{
              blockHash: string;
              blockHeight: number;
              hash: string;
              signatures: string[];
              tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; };
          }> & {
              hash: `th_${string}`;
              rawTx: `tx_${string}`;
          };
      }>

    • Parameters

      • p: {
            innerTx?: boolean;
            networkId: string;
            onAccount: `ak_${string}`;
            returnSigned: boolean;
            tx: `tx_${string}`;
        }

      Returns Promise<{
          signedTransaction?: `tx_${string}`;
          transactionHash?: Partial<{
              blockHash: string;
              blockHeight: number;
              hash: string;
              signatures: string[];
              tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; };
          }> & {
              hash: `th_${string}`;
              rawTx: `tx_${string}`;
          };
      }>

typedData.sign

typedData.sign: ((p: {
    aci: AciValue;
    data: `cb_${string}`;
    domain: Domain;
    onAccount: `ak_${string}`;
}) => Promise<{
    signature: `sg_${string}`;
}>)

Type declaration

    • (p: {
          aci: AciValue;
          data: `cb_${string}`;
          domain: Domain;
          onAccount: `ak_${string}`;
      }): Promise<{
          signature: `sg_${string}`;
      }>

    • Parameters

      • p: {
            aci: AciValue;
            data: `cb_${string}`;
            domain: Domain;
            onAccount: `ak_${string}`;
        }
        • aci: AciValue
        • data: `cb_${string}`
        • domain: Domain
        • onAccount: `ak_${string}`

      Returns Promise<{
          signature: `sg_${string}`;
      }>

Settings

Member Visibility

Theme

Generated using TypeDoc