Class AeSdkAepp

RPC handler for AEPP side Contain functionality for wallet interaction and connect it to sdk

Hierarchy

AeSdkBase
- AeSdkAepp

Index

Constructors

constructor

Accessors

address api compilerApi

Constructors

constructor

new AeSdkAepp(options: {
    name: string;
    onAddressChange?: ((a: Accounts) => void);
    onDisconnect?: ((p: any) => void);
    onNetworkChange?: ((a: Network) => void);
} & AeSdkMethodsOptions & {
    nodes?: {
        instance: Node;
        name: string;
    }[];
}): AeSdkAepp
Parameters
- options: {
      name: string;
      onAddressChange?: ((a: Accounts) => void);
      onDisconnect?: ((p: any) => void);
      onNetworkChange?: ((a: Network) => void);
  } & AeSdkMethodsOptions & {
      nodes?: {
          instance: Node;
          name: string;
      }[];
  }
  
  Options
Returns AeSdkAepp
Overrides AeSdkBase.constructor
- Defined in AeSdkAepp.ts:46

Properties

`Optional` _accounts

_accounts?: Accounts

_getPollInterval

_getPollInterval: ((...args: ["block" | "microblock"] | ["block" | "microblock", Omit<{
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}>]) => number)

Type declaration

- (...args: ["block" | "microblock"] | ["block" | "microblock", Omit<{
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }>]): number
- Parameters
  - Rest ...args: ["block" | "microblock"] | ["block" | "microblock", Omit<{
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }>]
  Returns number

_options

_options: AeSdkMethodsOptions = {}

aensBid

aensBid: ((...args: [name: `${string}.chain`, nameFee: string | number | BigNumber] | [`${string}.chain`, string | number | BigNumber, Omit<Omit<AensClaimOptions, "nameFee">, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<Omit<AensClaimOptions, "nameFee">, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<AensClaimReturnType>)

Type declaration

- (...args: [name: `${string}.chain`, nameFee: string | number | BigNumber] | [`${string}.chain`, string | number | BigNumber, Omit<Omit<AensClaimOptions, "nameFee">, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<Omit<AensClaimOptions, "nameFee">, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<AensClaimReturnType>
- Parameters
  - Rest ...args: [name: `${string}.chain`, nameFee: string | number | BigNumber] | [`${string}.chain`, string | number | BigNumber, Omit<Omit<AensClaimOptions, "nameFee">, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<Omit<AensClaimOptions, "nameFee">, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<AensClaimReturnType>

aensClaim

aensClaim: ((...args: [name: `${string}.chain`, salt: number] | [`${string}.chain`, number, Omit<AensClaimOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensClaimOptions, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<AensClaimReturnType>)

Type declaration

- (...args: [name: `${string}.chain`, salt: number] | [`${string}.chain`, number, Omit<AensClaimOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensClaimOptions, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<AensClaimReturnType>
- Parameters
  - Rest ...args: [name: `${string}.chain`, salt: number] | [`${string}.chain`, number, Omit<AensClaimOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensClaimOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<AensClaimReturnType>

aensPreclaim

aensPreclaim: ((...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<AensPreclaimOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensPreclaimOptions, "onAccount"> & {
    onAccount: OnAccount;
}>]) => Promise<Readonly<SendTransactionReturnType & {
    claim: ((opts?: AensClaimOptions) => Promise<AensClaimReturnType>);
    commitmentId: string;
    salt: number;
}>>)

Type declaration

- (...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<AensPreclaimOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensPreclaimOptions, "onAccount"> & {
      onAccount: OnAccount;
  }>]): Promise<Readonly<SendTransactionReturnType & {
      claim: ((opts?: AensClaimOptions) => Promise<AensClaimReturnType>);
      commitmentId: string;
      salt: number;
  }>>
- Parameters
  - Rest ...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<AensPreclaimOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensPreclaimOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<Readonly<SendTransactionReturnType & {
      claim: ((opts?: AensClaimOptions) => Promise<AensClaimReturnType>);
      commitmentId: string;
      salt: number;
  }>>

aensQuery

aensQuery: ((...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<{
    onNode: Node;
} & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<{
    onNode: Node;
} & AensUpdateOptions & AensTransferOptions, "onAccount"> & {
    onAccount: OnAccount;
}>]) => Promise<Readonly<{
    id: string;
    owner?: string;
    pointers: ({ key: string; id: string; })[];
    ttl: number;
} & {
    extendTtl: ((nameTtl: number, options?: Omit<{
        onNode: Node;
    } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler">) => Promise<SendTransactionReturnType> & Promise<Readonly<{
        id: string;
        owner?: string;
        pointers: ({ key: string; id: string; })[];
        ttl: number;
    } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
    id: `nm_${string}`;
    owner: `ak_${string}`;
    pointers: NamePointer[] | KeyPointers;
    revoke: ((options?: Omit<AensRevokeOptions, "onNode" | "onAccount" | "onCompiler"> & {
        onAccount?: AccountBase;
    }) => Promise<SendTransactionReturnType>);
    transfer: ((account: `ak_${string}`, options?: {
        onNode: Node;
    } & AensUpdateOptions & AensTransferOptions) => Promise<SendTransactionReturnType> & Promise<Readonly<{
        id: string;
        owner?: string;
        pointers: ({ key: string; id: string; })[];
        ttl: number;
    } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
    ttl: number;
    update: ((pointers: KeyPointers, options?: Omit<{
        onNode: Node;
    } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & {
        onAccount?: AccountBase;
    }) => Promise<SendTransactionReturnType> & Promise<Readonly<{
        id: string;
        owner?: string;
        pointers: ({ key: string; id: string; })[];
        ttl: number;
    } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
}>>)

Type declaration

- (...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<{
      onNode: Node;
  } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<{
      onNode: Node;
  } & AensUpdateOptions & AensTransferOptions, "onAccount"> & {
      onAccount: OnAccount;
  }>]): Promise<Readonly<{
      id: string;
      owner?: string;
      pointers: ({ key: string; id: string; })[];
      ttl: number;
  } & {
      extendTtl: ((nameTtl: number, options?: Omit<{
          onNode: Node;
      } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler">) => Promise<SendTransactionReturnType> & Promise<Readonly<{
          id: string;
          owner?: string;
          pointers: ({ key: string; id: string; })[];
          ttl: number;
      } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
      id: `nm_${string}`;
      owner: `ak_${string}`;
      pointers: NamePointer[] | KeyPointers;
      revoke: ((options?: Omit<AensRevokeOptions, "onNode" | "onAccount" | "onCompiler"> & {
          onAccount?: AccountBase;
      }) => Promise<SendTransactionReturnType>);
      transfer: ((account: `ak_${string}`, options?: {
          onNode: Node;
      } & AensUpdateOptions & AensTransferOptions) => Promise<SendTransactionReturnType> & Promise<Readonly<{
          id: string;
          owner?: string;
          pointers: ({ key: string; id: string; })[];
          ttl: number;
      } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
      ttl: number;
      update: ((pointers: KeyPointers, options?: Omit<{
          onNode: Node;
      } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & {
          onAccount?: AccountBase;
      }) => Promise<SendTransactionReturnType> & Promise<Readonly<{
          id: string;
          owner?: string;
          pointers: ({ key: string; id: string; })[];
          ttl: number;
      } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
  }>>
- Parameters
  - Rest ...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<{
        onNode: Node;
    } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<{
        onNode: Node;
    } & AensUpdateOptions & AensTransferOptions, "onAccount"> & {
        onAccount: OnAccount;
    }>]
  Returns Promise<Readonly<{
      id: string;
      owner?: string;
      pointers: ({ key: string; id: string; })[];
      ttl: number;
  } & {
      extendTtl: ((nameTtl: number, options?: Omit<{
          onNode: Node;
      } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler">) => Promise<SendTransactionReturnType> & Promise<Readonly<{
          id: string;
          owner?: string;
          pointers: ({ key: string; id: string; })[];
          ttl: number;
      } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
      id: `nm_${string}`;
      owner: `ak_${string}`;
      pointers: NamePointer[] | KeyPointers;
      revoke: ((options?: Omit<AensRevokeOptions, "onNode" | "onAccount" | "onCompiler"> & {
          onAccount?: AccountBase;
      }) => Promise<SendTransactionReturnType>);
      transfer: ((account: `ak_${string}`, options?: {
          onNode: Node;
      } & AensUpdateOptions & AensTransferOptions) => Promise<SendTransactionReturnType> & Promise<Readonly<{
          id: string;
          owner?: string;
          pointers: ({ key: string; id: string; })[];
          ttl: number;
      } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
      ttl: number;
      update: ((pointers: KeyPointers, options?: Omit<{
          onNode: Node;
      } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & {
          onAccount?: AccountBase;
      }) => Promise<SendTransactionReturnType> & Promise<Readonly<{
          id: string;
          owner?: string;
          pointers: ({ key: string; id: string; })[];
          ttl: number;
      } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
  }>>

aensRevoke

aensRevoke: ((...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<AensRevokeOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensRevokeOptions, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<SendTransactionReturnType>)

Type declaration

- (...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<AensRevokeOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensRevokeOptions, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<SendTransactionReturnType>
- Parameters
  - Rest ...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<AensRevokeOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensRevokeOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<SendTransactionReturnType>

aensTransfer

aensTransfer: ((...args: [name: `${string}.chain`, account: `ak_${string}`] | [`${string}.chain`, `ak_${string}`, Omit<AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensTransferOptions, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<SendTransactionReturnType>)

Type declaration

- (...args: [name: `${string}.chain`, account: `ak_${string}`] | [`${string}.chain`, `ak_${string}`, Omit<AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensTransferOptions, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<SendTransactionReturnType>
- Parameters
  - Rest ...args: [name: `${string}.chain`, account: `ak_${string}`] | [`${string}.chain`, `ak_${string}`, Omit<AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensTransferOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<SendTransactionReturnType>

aensUpdate

aensUpdate: ((...args: [`${string}.chain`, KeyPointers] | [`${string}.chain`, KeyPointers, Omit<AensUpdateOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensUpdateOptions, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<SendTransactionReturnType>)

Type declaration

- (...args: [`${string}.chain`, KeyPointers] | [`${string}.chain`, KeyPointers, Omit<AensUpdateOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensUpdateOptions, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<SendTransactionReturnType>
- Parameters
  - Rest ...args: [`${string}.chain`, KeyPointers] | [`${string}.chain`, KeyPointers, Omit<AensUpdateOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensUpdateOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<SendTransactionReturnType>

awaitHeight

awaitHeight: ((...args: [number] | [number, Omit<{
    interval?: number;
    onNode: Node;
} & {
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    interval?: number;
    onNode: Node;
} & {
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}>]) => Promise<number>)

Type declaration

- (...args: [number] | [number, Omit<{
      interval?: number;
      onNode: Node;
  } & {
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      interval?: number;
      onNode: Node;
  } & {
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }>]): Promise<number>
- Parameters
  - Rest ...args: [number] | [number, Omit<{
        interval?: number;
        onNode: Node;
    } & {
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
        interval?: number;
        onNode: Node;
    } & {
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }>]
  Returns Promise<number>

buildAuthTxHash

buildAuthTxHash: ((...args: [`tx_${string}`] | [`tx_${string}`, Omit<{
    fee?: Int;
    gasPrice?: Int;
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    fee?: Int;
    gasPrice?: Int;
    onNode: Node;
}>]) => Promise<Buffer>)

Type declaration

- (...args: [`tx_${string}`] | [`tx_${string}`, Omit<{
      fee?: Int;
      gasPrice?: Int;
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      fee?: Int;
      gasPrice?: Int;
      onNode: Node;
  }>]): Promise<Buffer>
- Parameters
  - Rest ...args: [`tx_${string}`] | [`tx_${string}`, Omit<{
        fee?: Int;
        gasPrice?: Int;
        onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
        fee?: Int;
        gasPrice?: Int;
        onNode: Node;
    }>]
  Returns Promise<Buffer>

buildAuthTxHashByGaMetaTx

buildAuthTxHashByGaMetaTx: ((...args: [`tx_${string}`] | [`tx_${string}`, Omit<{
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
onNode: Node;
}>]) => Promise<Buffer>)

Type declaration

- (...args: [`tx_${string}`] | [`tx_${string}`, Omit<{
  onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
  onNode: Node;
  }>]): Promise<Buffer>
- Parameters
  - Rest ...args: [`tx_${string}`] | [`tx_${string}`, Omit<{
    onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
    }>]
  Returns Promise<Buffer>

createDelegationSignature

createDelegationSignature: ((...args: [contractAddress: `ct_${string}`, ids: (`${string}.chain` | `kh_${string}` | `mh_${string}` | `bf_${string}` | `bx_${string}` | `bs_${string}` | `ch_${string}` | `ct_${string}` | `cb_${string}` | `ck_${string}` | `cv_${string}` | `tx_${string}` | `th_${string}` | `ok_${string}` | `ov_${string}` | `oq_${string}` | `or_${string}` | `ak_${string}` | `sg_${string}` | `cm_${string}` | `pp_${string}` | `nm_${string}` | `st_${string}` | `pi_${string}` | `ss_${string}` | `cs_${string}` | `ba_${string}`)[]] | [`ct_${string}`, (`${string}.chain` | `kh_${string}` | `mh_${string}` | `bf_${string}` | `bx_${string}` | `bs_${string}` | `ch_${string}` | `ct_${string}` | `cb_${string}` | `ck_${string}` | `cv_${string}` | `tx_${string}` | `th_${string}` | `ok_${string}` | `ov_${string}` | `oq_${string}` | `or_${string}` | `ak_${string}` | `sg_${string}` | `cm_${string}` | `pp_${string}` | `nm_${string}` | `st_${string}` | `pi_${string}` | `ss_${string}` | `cs_${string}` | `ba_${string}`)[], Omit<{
    omitAddress?: boolean;
    onAccount: AccountBase;
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<{
    omitAddress?: boolean;
    onAccount: AccountBase;
    onNode: Node;
}, "onAccount"> & {
    onAccount: OnAccount;
}>]) => Promise<Uint8Array>)

Type declaration

- (...args: [contractAddress: `ct_${string}`, ids: (`${string}.chain` | `kh_${string}` | `mh_${string}` | `bf_${string}` | `bx_${string}` | `bs_${string}` | `ch_${string}` | `ct_${string}` | `cb_${string}` | `ck_${string}` | `cv_${string}` | `tx_${string}` | `th_${string}` | `ok_${string}` | `ov_${string}` | `oq_${string}` | `or_${string}` | `ak_${string}` | `sg_${string}` | `cm_${string}` | `pp_${string}` | `nm_${string}` | `st_${string}` | `pi_${string}` | `ss_${string}` | `cs_${string}` | `ba_${string}`)[]] | [`ct_${string}`, (`${string}.chain` | `kh_${string}` | `mh_${string}` | `bf_${string}` | `bx_${string}` | `bs_${string}` | `ch_${string}` | `ct_${string}` | `cb_${string}` | `ck_${string}` | `cv_${string}` | `tx_${string}` | `th_${string}` | `ok_${string}` | `ov_${string}` | `oq_${string}` | `or_${string}` | `ak_${string}` | `sg_${string}` | `cm_${string}` | `pp_${string}` | `nm_${string}` | `st_${string}` | `pi_${string}` | `ss_${string}` | `cs_${string}` | `ba_${string}`)[], Omit<{
      omitAddress?: boolean;
      onAccount: AccountBase;
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<{
      omitAddress?: boolean;
      onAccount: AccountBase;
      onNode: Node;
  }, "onAccount"> & {
      onAccount: OnAccount;
  }>]): Promise<Uint8Array>
- Parameters
  - Rest ...args: [contractAddress: `ct_${string}`, ids: (`${string}.chain` | `kh_${string}` | `mh_${string}` | `bf_${string}` | `bx_${string}` | `bs_${string}` | `ch_${string}` | `ct_${string}` | `cb_${string}` | `ck_${string}` | `cv_${string}` | `tx_${string}` | `th_${string}` | `ok_${string}` | `ov_${string}` | `oq_${string}` | `or_${string}` | `ak_${string}` | `sg_${string}` | `cm_${string}` | `pp_${string}` | `nm_${string}` | `st_${string}` | `pi_${string}` | `ss_${string}` | `cs_${string}` | `ba_${string}`)[]] | [`ct_${string}`, (`${string}.chain` | `kh_${string}` | `mh_${string}` | `bf_${string}` | `bx_${string}` | `bs_${string}` | `ch_${string}` | `ct_${string}` | `cb_${string}` | `ck_${string}` | `cv_${string}` | `tx_${string}` | `th_${string}` | `ok_${string}` | `ov_${string}` | `oq_${string}` | `or_${string}` | `ak_${string}` | `sg_${string}` | `cm_${string}` | `pp_${string}` | `nm_${string}` | `st_${string}` | `pi_${string}` | `ss_${string}` | `cs_${string}` | `ba_${string}`)[], Omit<{
        omitAddress?: boolean;
        onAccount: AccountBase;
        onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<{
        omitAddress?: boolean;
        onAccount: AccountBase;
        onNode: Node;
    }, "onAccount"> & {
        onAccount: OnAccount;
    }>]
  Returns Promise<Uint8Array>

createGeneralizedAccount

createGeneralizedAccount: ((...args: [string, any[]] | [string, any[], Omit<CreateGeneralizedAccountOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<CreateGeneralizedAccountOptions, "onAccount"> & {
    onAccount: OnAccount;
}>]) => Promise<Readonly<{
    gaContractId: `ct_${string}`;
    owner: `ak_${string}`;
    rawTx: `tx_${string}`;
    transaction: `th_${string}`;
}>>)

Type declaration

- (...args: [string, any[]] | [string, any[], Omit<CreateGeneralizedAccountOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<CreateGeneralizedAccountOptions, "onAccount"> & {
      onAccount: OnAccount;
  }>]): Promise<Readonly<{
      gaContractId: `ct_${string}`;
      owner: `ak_${string}`;
      rawTx: `tx_${string}`;
      transaction: `th_${string}`;
  }>>
- Parameters
  - Rest ...args: [string, any[]] | [string, any[], Omit<CreateGeneralizedAccountOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<CreateGeneralizedAccountOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<Readonly<{
      gaContractId: `ct_${string}`;
      owner: `ak_${string}`;
      rawTx: `tx_${string}`;
      transaction: `th_${string}`;
  }>>

extendOracleTtl

extendOracleTtl: ((...args: [] | [Omit<ExtendOracleTtlOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<ExtendOracleTtlOptions, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<SendTransactionReturnType & GetOracleObjectReturnType>)

Type declaration

- (...args: [] | [Omit<ExtendOracleTtlOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<ExtendOracleTtlOptions, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<SendTransactionReturnType & GetOracleObjectReturnType>
- Parameters
  - Rest ...args: [] | [Omit<ExtendOracleTtlOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<ExtendOracleTtlOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<SendTransactionReturnType & GetOracleObjectReturnType>

getAccount

getAccount: ((...args: [`ct_${string}` | `ak_${string}`] | [`ct_${string}` | `ak_${string}`, Omit<{
    hash?: `kh_${string}` | `mh_${string}`;
    height?: number;
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    hash?: `kh_${string}` | `mh_${string}`;
    height?: number;
    onNode: Node;
}>]) => Promise<{
    authFun?: string;
    balance: bigint;
    contractId?: string;
    id: string;
    kind?: AccountKind;
    nonce: number;
    payable?: boolean;
}>)

Type declaration

- (...args: [`ct_${string}` | `ak_${string}`] | [`ct_${string}` | `ak_${string}`, Omit<{
      hash?: `kh_${string}` | `mh_${string}`;
      height?: number;
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      hash?: `kh_${string}` | `mh_${string}`;
      height?: number;
      onNode: Node;
  }>]): Promise<{
      authFun?: string;
      balance: bigint;
      contractId?: string;
      id: string;
      kind?: AccountKind;
      nonce: number;
      payable?: boolean;
  }>
- Parameters
  - Rest ...args: [`ct_${string}` | `ak_${string}`] | [`ct_${string}` | `ak_${string}`, Omit<{
        hash?: `kh_${string}` | `mh_${string}`;
        height?: number;
        onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
        hash?: `kh_${string}` | `mh_${string}`;
        height?: number;
        onNode: Node;
    }>]
  Returns Promise<{
      authFun?: string;
      balance: bigint;
      contractId?: string;
      id: string;
      kind?: AccountKind;
      nonce: number;
      payable?: boolean;
  }>

getBalance

getBalance: ((...args: [`ct_${string}` | `ok_${string}` | `ak_${string}`] | [`ct_${string}` | `ok_${string}` | `ak_${string}`, Omit<{
    format?: AE_AMOUNT_FORMATS;
} & {
    hash?: `kh_${string}` | `mh_${string}`;
    height?: number;
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    format?: AE_AMOUNT_FORMATS;
} & {
    hash?: `kh_${string}` | `mh_${string}`;
    height?: number;
    onNode: Node;
}>]) => Promise<string>)

Type declaration

- (...args: [`ct_${string}` | `ok_${string}` | `ak_${string}`] | [`ct_${string}` | `ok_${string}` | `ak_${string}`, Omit<{
      format?: AE_AMOUNT_FORMATS;
  } & {
      hash?: `kh_${string}` | `mh_${string}`;
      height?: number;
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      format?: AE_AMOUNT_FORMATS;
  } & {
      hash?: `kh_${string}` | `mh_${string}`;
      height?: number;
      onNode: Node;
  }>]): Promise<string>
- Parameters
  - Rest ...args: [`ct_${string}` | `ok_${string}` | `ak_${string}`] | [`ct_${string}` | `ok_${string}` | `ak_${string}`, Omit<{
        format?: AE_AMOUNT_FORMATS;
    } & {
        hash?: `kh_${string}` | `mh_${string}`;
        height?: number;
        onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
        format?: AE_AMOUNT_FORMATS;
    } & {
        hash?: `kh_${string}` | `mh_${string}`;
        height?: number;
        onNode: Node;
    }>]
  Returns Promise<string>

getContract

getContract: ((...args: [`ct_${string}`] | [`ct_${string}`, Omit<{
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
}>]) => Promise<{
    abiVersion: string;
    active: boolean;
    deposit: bigint;
    id: string;
    ownerId: string;
    referrerIds: string[];
    vmVersion: string;
}>)

Type declaration

- (...args: [`ct_${string}`] | [`ct_${string}`, Omit<{
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      onNode: Node;
  }>]): Promise<{
      abiVersion: string;
      active: boolean;
      deposit: bigint;
      id: string;
      ownerId: string;
      referrerIds: string[];
      vmVersion: string;
  }>
- Parameters
  - Rest ...args: [`ct_${string}`] | [`ct_${string}`, Omit<{
    onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
    }>]
  Returns Promise<{
      abiVersion: string;
      active: boolean;
      deposit: bigint;
      id: string;
      ownerId: string;
      referrerIds: string[];
      vmVersion: string;
  }>

getContractByteCode

getContractByteCode: ((...args: [`ct_${string}`] | [`ct_${string}`, Omit<{
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
}>]) => Promise<{
    bytecode: `cb_${string}`;
}>)

Type declaration

- (...args: [`ct_${string}`] | [`ct_${string}`, Omit<{
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      onNode: Node;
  }>]): Promise<{
      bytecode: `cb_${string}`;
  }>
- Parameters
  - Rest ...args: [`ct_${string}`] | [`ct_${string}`, Omit<{
    onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
    }>]
  Returns Promise<{
  bytecode: `cb_${string}`;
  }>

getCurrentGeneration

getCurrentGeneration: ((...args: [] | [Omit<{
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
}>]) => Promise<{
    keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
    microBlocks: string[];
}>)

Type declaration

- (...args: [] | [Omit<{
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      onNode: Node;
  }>]): Promise<{
      keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
      microBlocks: string[];
  }>
- Parameters
  - Rest ...args: [] | [Omit<{
    onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
    }>]
  Returns Promise<{
  keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
  microBlocks: string[];
  }>

getGeneration

getGeneration: ((...args: [number | `kh_${string}`] | [number | `kh_${string}`, Omit<{
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
}>]) => Promise<{
    keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
    microBlocks: string[];
}>)

Type declaration

- (...args: [number | `kh_${string}`] | [number | `kh_${string}`, Omit<{
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      onNode: Node;
  }>]): Promise<{
      keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
      microBlocks: string[];
  }>
- Parameters
  - Rest ...args: [number | `kh_${string}`] | [number | `kh_${string}`, Omit<{
    onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
    }>]
  Returns Promise<{
  keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
  microBlocks: string[];
  }>

getHeight

getHeight: ((...args: [] | [Omit<{
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
onNode: Node;
}>]) => Promise<number>)

Type declaration

- (...args: [] | [Omit<{
  onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
  onNode: Node;
  }>]): Promise<number>
- Parameters
  - Rest ...args: [] | [Omit<{
    onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
    }>]
  Returns Promise<number>

getKeyBlock

getKeyBlock: ((...args: [number | `kh_${string}`] | [number | `kh_${string}`, Omit<{
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
}>]) => Promise<{
    beneficiary: string;
    hash: string;
    height: number;
    info: string;
    miner: string;
    nonce?: number;
    pow?: string[];
    prevHash: string;
    prevKeyHash: string;
    stateHash: string;
    target: string;
    time: number;
    version: number;
}>)

Type declaration

- (...args: [number | `kh_${string}`] | [number | `kh_${string}`, Omit<{
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      onNode: Node;
  }>]): Promise<{
      beneficiary: string;
      hash: string;
      height: number;
      info: string;
      miner: string;
      nonce?: number;
      pow?: string[];
      prevHash: string;
      prevKeyHash: string;
      stateHash: string;
      target: string;
      time: number;
      version: number;
  }>
- Parameters
  - Rest ...args: [number | `kh_${string}`] | [number | `kh_${string}`, Omit<{
    onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
    }>]
  Returns Promise<{
      beneficiary: string;
      hash: string;
      height: number;
      info: string;
      miner: string;
      nonce?: number;
      pow?: string[];
      prevHash: string;
      prevKeyHash: string;
      stateHash: string;
      target: string;
      time: number;
      version: number;
  }>

getMicroBlockHeader

getMicroBlockHeader: ((...args: [`mh_${string}`] | [`mh_${string}`, Omit<{
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
}>]) => Promise<{
    hash: string;
    height: number;
    pofHash: string;
    prevHash: string;
    prevKeyHash: string;
    signature: string;
    stateHash: string;
    time: number;
    txsHash: string;
    version: number;
}>)

Type declaration

- (...args: [`mh_${string}`] | [`mh_${string}`, Omit<{
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      onNode: Node;
  }>]): Promise<{
      hash: string;
      height: number;
      pofHash: string;
      prevHash: string;
      prevKeyHash: string;
      signature: string;
      stateHash: string;
      time: number;
      txsHash: string;
      version: number;
  }>
- Parameters
  - Rest ...args: [`mh_${string}`] | [`mh_${string}`, Omit<{
    onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
    }>]
  Returns Promise<{
      hash: string;
      height: number;
      pofHash: string;
      prevHash: string;
      prevKeyHash: string;
      signature: string;
      stateHash: string;
      time: number;
      txsHash: string;
      version: number;
  }>

getMicroBlockTransactions

getMicroBlockTransactions: ((...args: [`mh_${string}`] | [`mh_${string}`, Omit<{
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
}>]) => Promise<{
    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; };
}[]>)

Type declaration

- (...args: [`mh_${string}`] | [`mh_${string}`, Omit<{
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      onNode: Node;
  }>]): Promise<{
      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; };
  }[]>
- Parameters
  - Rest ...args: [`mh_${string}`] | [`mh_${string}`, Omit<{
    onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
    }>]
  Returns Promise<{
      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; };
  }[]>

getName

getName: ((...args: [`${string}.chain`] | [`${string}.chain`, Omit<{
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
}>]) => Promise<{
    id: string;
    owner?: string;
    pointers: ({ key: string; id: string; })[];
    ttl: number;
}>)

Type declaration

- (...args: [`${string}.chain`] | [`${string}.chain`, Omit<{
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      onNode: Node;
  }>]): Promise<{
      id: string;
      owner?: string;
      pointers: ({ key: string; id: string; })[];
      ttl: number;
  }>
- Parameters
  - Rest ...args: [`${string}.chain`] | [`${string}.chain`, Omit<{
    onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
    }>]
  Returns Promise<{
      id: string;
      owner?: string;
      pointers: ({ key: string; id: string; })[];
      ttl: number;
  }>

getOracleObject

getOracleObject: ((...args: [oracleId: `ok_${string}`] | [`ok_${string}`, Omit<{
    onAccount: AccountBase;
    onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<{
    onAccount: AccountBase;
    onNode: Node;
}, "onAccount"> & {
    onAccount: OnAccount;
}>]) => Promise<GetOracleObjectReturnType>)

Type declaration

- (...args: [oracleId: `ok_${string}`] | [`ok_${string}`, Omit<{
      onAccount: AccountBase;
      onNode: Node;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<{
      onAccount: AccountBase;
      onNode: Node;
  }, "onAccount"> & {
      onAccount: OnAccount;
  }>]): Promise<GetOracleObjectReturnType>
- Parameters
  - Rest ...args: [oracleId: `ok_${string}`] | [`ok_${string}`, Omit<{
        onAccount: AccountBase;
        onNode: Node;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<{
        onAccount: AccountBase;
        onNode: Node;
    }, "onAccount"> & {
        onAccount: OnAccount;
    }>]
  Returns Promise<GetOracleObjectReturnType>

getQueryObject

getQueryObject: ((...args: [oracleId: `ok_${string}`, queryId: `oq_${string}`] | [`ok_${string}`, `oq_${string}`, Omit<RespondToQueryOptions & {
    interval?: number;
    onNode: Node;
} & {
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<RespondToQueryOptions & {
    interval?: number;
    onNode: Node;
} & {
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}, "onAccount"> & {
    onAccount: OnAccount;
}>]) => Promise<GetQueryObjectReturnType>)

Type declaration

- (...args: [oracleId: `ok_${string}`, queryId: `oq_${string}`] | [`ok_${string}`, `oq_${string}`, Omit<RespondToQueryOptions & {
      interval?: number;
      onNode: Node;
  } & {
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<RespondToQueryOptions & {
      interval?: number;
      onNode: Node;
  } & {
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }, "onAccount"> & {
      onAccount: OnAccount;
  }>]): Promise<GetQueryObjectReturnType>
- Parameters
  - Rest ...args: [oracleId: `ok_${string}`, queryId: `oq_${string}`] | [`ok_${string}`, `oq_${string}`, Omit<RespondToQueryOptions & {
        interval?: number;
        onNode: Node;
    } & {
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<RespondToQueryOptions & {
        interval?: number;
        onNode: Node;
    } & {
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }, "onAccount"> & {
        onAccount: OnAccount;
    }>]
  Returns Promise<GetQueryObjectReturnType>

name

name: string

onAddressChange

onAddressChange: ((a: Accounts) => void)

Type declaration

- (a: Accounts): void
- Parameters
  - a: Accounts
  Returns void

onDisconnect

onDisconnect: ((p: any) => void)

Type declaration

- (p: any): void
- Parameters
  - p: any
  Returns void

onNetworkChange

onNetworkChange: ((a: Network) => void)

Type declaration

- (a: Network): void
- Parameters
  - a: Network
  Returns void

payForTransaction

payForTransaction: ((...args: [transaction: `tx_${string}`] | [`tx_${string}`, Omit<PayForTransactionOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<PayForTransactionOptions, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<SendTransactionReturnType>)

Type declaration

- (...args: [transaction: `tx_${string}`] | [`tx_${string}`, Omit<PayForTransactionOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<PayForTransactionOptions, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<SendTransactionReturnType>
- Parameters
  - Rest ...args: [transaction: `tx_${string}`] | [`tx_${string}`, Omit<PayForTransactionOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<PayForTransactionOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<SendTransactionReturnType>

poll

poll: ((...args: [`th_${string}`] | [`th_${string}`, Omit<{
    blocks?: number;
    interval?: number;
    onNode: Node;
} & {
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    blocks?: number;
    interval?: number;
    onNode: Node;
} & {
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}>]) => Promise<{
    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; };
}>)

Type declaration

- (...args: [`th_${string}`] | [`th_${string}`, Omit<{
      blocks?: number;
      interval?: number;
      onNode: Node;
  } & {
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      blocks?: number;
      interval?: number;
      onNode: Node;
  } & {
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }>]): Promise<{
      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; };
  }>
- Parameters
  - Rest ...args: [`th_${string}`] | [`th_${string}`, Omit<{
        blocks?: number;
        interval?: number;
        onNode: Node;
    } & {
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
        blocks?: number;
        interval?: number;
        onNode: Node;
    } & {
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }>]
  Returns Promise<{
      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; };
  }>

pollForQueries

pollForQueries: ((...args: [`ok_${string}`, ((query: {
    fee: bigint;
    id: string;
    oracleId: string;
    query: string;
    response: string;
    responseTtl: { type: TTLType; value: string; };
    senderId: string;
    senderNonce: string;
    ttl: number;
}) => void)] | [`ok_${string}`, ((query: {
    fee: bigint;
    id: string;
    oracleId: string;
    query: string;
    response: string;
    responseTtl: { type: TTLType; value: string; };
    senderId: string;
    senderNonce: string;
    ttl: number;
}) => void), Omit<{
    interval?: number;
    onNode: Node;
} & {
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    interval?: number;
    onNode: Node;
} & {
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}>]) => (() => void))

Type declaration

- (...args: [`ok_${string}`, ((query: {
      fee: bigint;
      id: string;
      oracleId: string;
      query: string;
      response: string;
      responseTtl: { type: TTLType; value: string; };
      senderId: string;
      senderNonce: string;
      ttl: number;
  }) => void)] | [`ok_${string}`, ((query: {
      fee: bigint;
      id: string;
      oracleId: string;
      query: string;
      response: string;
      responseTtl: { type: TTLType; value: string; };
      senderId: string;
      senderNonce: string;
      ttl: number;
  }) => void), Omit<{
      interval?: number;
      onNode: Node;
  } & {
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      interval?: number;
      onNode: Node;
  } & {
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }>]): (() => void)
- Parameters
  - Rest ...args: [`ok_${string}`, ((query: {
        fee: bigint;
        id: string;
        oracleId: string;
        query: string;
        response: string;
        responseTtl: { type: TTLType; value: string; };
        senderId: string;
        senderNonce: string;
        ttl: number;
    }) => void)] | [`ok_${string}`, ((query: {
        fee: bigint;
        id: string;
        oracleId: string;
        query: string;
        response: string;
        responseTtl: { type: TTLType; value: string; };
        senderId: string;
        senderNonce: string;
        ttl: number;
    }) => void), Omit<{
        interval?: number;
        onNode: Node;
    } & {
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
        interval?: number;
        onNode: Node;
    } & {
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }>]
  Returns (() => void)
  - - (): void
    - Poll for oracle queries
      
      Category
      oracle
      
      Returns
      Callback to stop polling function
      
      Returns void

pollForQueryResponse

pollForQueryResponse: ((...args: [`ok_${string}`, `oq_${string}`] | [`ok_${string}`, `oq_${string}`, Omit<{
    interval?: number;
    onNode: Node;
} & {
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    interval?: number;
    onNode: Node;
} & {
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}>]) => Promise<string>)

Type declaration

- (...args: [`ok_${string}`, `oq_${string}`] | [`ok_${string}`, `oq_${string}`, Omit<{
      interval?: number;
      onNode: Node;
  } & {
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      interval?: number;
      onNode: Node;
  } & {
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }>]): Promise<string>
- Parameters
  - Rest ...args: [`ok_${string}`, `oq_${string}`] | [`ok_${string}`, `oq_${string}`, Omit<{
        interval?: number;
        onNode: Node;
    } & {
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
        interval?: number;
        onNode: Node;
    } & {
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }>]
  Returns Promise<string>

pool

pool: Map<string, Node> = ...

postQueryToOracle

postQueryToOracle: ((...args: [oracleId: `ok_${string}`, query: string] | [`ok_${string}`, string, Omit<PostQueryToOracleOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<PostQueryToOracleOptions, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<SendTransactionReturnType & GetQueryObjectReturnType>)

Type declaration

- (...args: [oracleId: `ok_${string}`, query: string] | [`ok_${string}`, string, Omit<PostQueryToOracleOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<PostQueryToOracleOptions, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<SendTransactionReturnType & GetQueryObjectReturnType>
- Parameters
  - Rest ...args: [oracleId: `ok_${string}`, query: string] | [`ok_${string}`, string, Omit<PostQueryToOracleOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<PostQueryToOracleOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<SendTransactionReturnType & GetQueryObjectReturnType>

registerOracle

registerOracle: ((...args: [queryFormat: string, responseFormat: string] | [string, string, Omit<RegisterOracleOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<RegisterOracleOptions, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<SendTransactionReturnType & GetOracleObjectReturnType>)

Type declaration

- (...args: [queryFormat: string, responseFormat: string] | [string, string, Omit<RegisterOracleOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<RegisterOracleOptions, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<SendTransactionReturnType & GetOracleObjectReturnType>
- Parameters
  - Rest ...args: [queryFormat: string, responseFormat: string] | [string, string, Omit<RegisterOracleOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<RegisterOracleOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<SendTransactionReturnType & GetOracleObjectReturnType>

resolveName

resolveName: ((...args: [`${string}.chain` | `ct_${string}` | `ak_${string}`, string] | [`${string}.chain` | `ct_${string}` | `ak_${string}`, string, Omit<{
    onNode: Node;
    resolveByNode?: boolean;
    verify?: boolean;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    onNode: Node;
    resolveByNode?: boolean;
    verify?: boolean;
}>]) => Promise<`ct_${string}` | `ak_${string}` | `nm_${string}`>)

Type declaration

- (...args: [`${string}.chain` | `ct_${string}` | `ak_${string}`, string] | [`${string}.chain` | `ct_${string}` | `ak_${string}`, string, Omit<{
      onNode: Node;
      resolveByNode?: boolean;
      verify?: boolean;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      onNode: Node;
      resolveByNode?: boolean;
      verify?: boolean;
  }>]): Promise<`ct_${string}` | `ak_${string}` | `nm_${string}`>
- Parameters
  - Rest ...args: [`${string}.chain` | `ct_${string}` | `ak_${string}`, string] | [`${string}.chain` | `ct_${string}` | `ak_${string}`, string, Omit<{
        onNode: Node;
        resolveByNode?: boolean;
        verify?: boolean;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
        onNode: Node;
        resolveByNode?: boolean;
        verify?: boolean;
    }>]
  Returns Promise<`ct_${string}` | `ak_${string}` | `nm_${string}`>

respondToQuery

respondToQuery: ((...args: [queryId: `oq_${string}`, response: string] | [`oq_${string}`, string, Omit<RespondToQueryOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<RespondToQueryOptions, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<SendTransactionReturnType & GetOracleObjectReturnType>)

Type declaration

- (...args: [queryId: `oq_${string}`, response: string] | [`oq_${string}`, string, Omit<RespondToQueryOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<RespondToQueryOptions, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<SendTransactionReturnType & GetOracleObjectReturnType>
- Parameters
  - Rest ...args: [queryId: `oq_${string}`, response: string] | [`oq_${string}`, string, Omit<RespondToQueryOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<RespondToQueryOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<SendTransactionReturnType & GetOracleObjectReturnType>

`Optional` rpcClient

rpcClient?: default<WalletApi, AeppApi>

`Optional` selectedNodeName

selectedNodeName?: string

sendTransaction

sendTransaction: ((...args: [`tx_${string}`] | [`tx_${string}`, Omit<SendTransactionOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<SendTransactionOptions, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<SendTransactionReturnType>)

Type declaration

- (...args: [`tx_${string}`] | [`tx_${string}`, Omit<SendTransactionOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<SendTransactionOptions, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<SendTransactionReturnType>
- Parameters
  - Rest ...args: [`tx_${string}`] | [`tx_${string}`, Omit<SendTransactionOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<SendTransactionOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<SendTransactionReturnType>

spend

spend: ((...args: [amount: string | number, recipientIdOrName: `${string}.chain` | `ak_${string}`] | [string | number, `${string}.chain` | `ak_${string}`, Omit<SpendOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<SpendOptions, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<SendTransactionReturnType>)

Type declaration

- (...args: [amount: string | number, recipientIdOrName: `${string}.chain` | `ak_${string}`] | [string | number, `${string}.chain` | `ak_${string}`, Omit<SpendOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<SpendOptions, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<SendTransactionReturnType>
- Parameters
  - Rest ...args: [amount: string | number, recipientIdOrName: `${string}.chain` | `ak_${string}`] | [string | number, `${string}.chain` | `ak_${string}`, Omit<SpendOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<SpendOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<SendTransactionReturnType>

transferFunds

transferFunds: ((...args: [fraction: string | number, recipientIdOrName: `${string}.chain` | `ak_${string}`] | [string | number, `${string}.chain` | `ak_${string}`, Omit<TransferFundsOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<TransferFundsOptions, "onAccount"> & {
onAccount: OnAccount;
}>]) => Promise<SendTransactionReturnType>)

Type declaration

- (...args: [fraction: string | number, recipientIdOrName: `${string}.chain` | `ak_${string}`] | [string | number, `${string}.chain` | `ak_${string}`, Omit<TransferFundsOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<TransferFundsOptions, "onAccount"> & {
  onAccount: OnAccount;
  }>]): Promise<SendTransactionReturnType>
- Parameters
  - Rest ...args: [fraction: string | number, recipientIdOrName: `${string}.chain` | `ak_${string}`] | [string | number, `${string}.chain` | `ak_${string}`, Omit<TransferFundsOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<TransferFundsOptions, "onAccount"> & {
    onAccount: OnAccount;
    }>]
  Returns Promise<SendTransactionReturnType>

txDryRun

txDryRun: ((...args: [`tx_${string}`, `ak_${string}`] | [`tx_${string}`, `ak_${string}`, Omit<{
    combine?: boolean;
    onNode: Node;
    top?: number | `kh_${string}` | `mh_${string}`;
    txEvents?: boolean;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    combine?: boolean;
    onNode: Node;
    top?: number | `kh_${string}` | `mh_${string}`;
    txEvents?: boolean;
}>]) => Promise<{
    txEvents?: {}[];
} & {
    callObj?: { callerId: string; callerNonce: string; height: number; contractId: string; gasPrice: bigint; gasUsed: number; log: { address: string; topics: string[]; data: string; }[]; returnValue: string; returnType: ContractCallReturnType; };
    reason?: string;
    result: string;
    type: string;
}>)

Type declaration

- (...args: [`tx_${string}`, `ak_${string}`] | [`tx_${string}`, `ak_${string}`, Omit<{
      combine?: boolean;
      onNode: Node;
      top?: number | `kh_${string}` | `mh_${string}`;
      txEvents?: boolean;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      combine?: boolean;
      onNode: Node;
      top?: number | `kh_${string}` | `mh_${string}`;
      txEvents?: boolean;
  }>]): Promise<{
      txEvents?: {}[];
  } & {
      callObj?: { callerId: string; callerNonce: string; height: number; contractId: string; gasPrice: bigint; gasUsed: number; log: { address: string; topics: string[]; data: string; }[]; returnValue: string; returnType: ContractCallReturnType; };
      reason?: string;
      result: string;
      type: string;
  }>
- Parameters
  - Rest ...args: [`tx_${string}`, `ak_${string}`] | [`tx_${string}`, `ak_${string}`, Omit<{
        combine?: boolean;
        onNode: Node;
        top?: number | `kh_${string}` | `mh_${string}`;
        txEvents?: boolean;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
        combine?: boolean;
        onNode: Node;
        top?: number | `kh_${string}` | `mh_${string}`;
        txEvents?: boolean;
    }>]
  Returns Promise<{
      txEvents?: {}[];
  } & {
      callObj?: { callerId: string; callerNonce: string; height: number; contractId: string; gasPrice: bigint; gasUsed: number; log: { address: string; topics: string[]; data: string; }[]; returnValue: string; returnType: ContractCallReturnType; };
      reason?: string;
      result: string;
      type: string;
  }>

waitForTxConfirm

waitForTxConfirm: ((...args: [`th_${string}`] | [`th_${string}`, Omit<{
    confirm?: number;
    onNode: Node;
} & {
    interval?: number;
    onNode: Node;
} & {
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
    confirm?: number;
    onNode: Node;
} & {
    interval?: number;
    onNode: Node;
} & {
    _expectedMineRate?: number;
    _maxPollInterval?: number;
    _microBlockCycle?: number;
}>]) => Promise<number>)

Type declaration

- (...args: [`th_${string}`] | [`th_${string}`, Omit<{
      confirm?: number;
      onNode: Node;
  } & {
      interval?: number;
      onNode: Node;
  } & {
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
      confirm?: number;
      onNode: Node;
  } & {
      interval?: number;
      onNode: Node;
  } & {
      _expectedMineRate?: number;
      _maxPollInterval?: number;
      _microBlockCycle?: number;
  }>]): Promise<number>
- Parameters
  - Rest ...args: [`th_${string}`] | [`th_${string}`, Omit<{
        confirm?: number;
        onNode: Node;
    } & {
        interval?: number;
        onNode: Node;
    } & {
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }, "onNode" | "onAccount" | "onCompiler"> & Partial<{
        confirm?: number;
        onNode: Node;
    } & {
        interval?: number;
        onNode: Node;
    } & {
        _expectedMineRate?: number;
        _maxPollInterval?: number;
        _microBlockCycle?: number;
    }>]
  Returns Promise<number>

Accessors

address

get address(): `ak_${string}`
Returns `ak_${string}`
Inherited from AeSdkBase.address
- Defined in AeSdkBase.ts:130

api

get api(): Node
Returns Node
Inherited from AeSdkBase.api
- Defined in AeSdkBase.ts:45

compilerApi

get compilerApi(): CompilerBase
Returns CompilerBase
Inherited from AeSdkBase.compilerApi
- Defined in AeSdkBase.ts:38

Methods

_ensureAccountAccess

_ensureAccountAccess(): asserts this is AeSdkAepp & {
rpcClient: default<WalletApi, AeppApi>;
}
Returns asserts this is AeSdkAepp & {
rpcClient: default<WalletApi, AeppApi>;
}
- Defined in AeSdkAepp.ts:175

_ensureConnected

_ensureConnected(): asserts this is AeSdkAepp & {
rpcClient: default<WalletApi, AeppApi>;
}
Returns asserts this is AeSdkAepp & {
rpcClient: default<WalletApi, AeppApi>;
}
- Defined in AeSdkAepp.ts:170

_getOptions

_getOptions(): {
    onAccount: AccountBase;
    onCompiler: CompilerBase;
    onNode: Node;
}
Returns {
    onAccount: AccountBase;
    onCompiler: CompilerBase;
    onNode: Node;
}
- onAccount: AccountBase
- onCompiler: CompilerBase
- onNode: Node
Inherited from AeSdkBase._getOptions
- Defined in AeSdkBase.ts:156

_resolveAccount

_resolveAccount(account?: OnAccount): AccountBase
Resolves an account
Parameters
- account: OnAccount = ...
  
  ak-address, instance of AccountBase, or keypair
Returns AccountBase
Overrides AeSdkBase._resolveAccount
- Defined in AeSdkAepp.ts:65

addNode

addNode(name: string, node: Node, select?: boolean): void
Add Node

Example
```
// add and select new node with name 'testNode'
aeSdkBase.addNode('testNode', new Node({ url }), true)
```
Parameters
- name: string
  
  Node name
- node: Node
  
  Node instance
- select: boolean = false
  
  Select this node as current
Returns void
Inherited from AeSdkBase.addNode
- Defined in AeSdkBase.ts:61

addresses

addresses(): `ak_${string}`[]
Returns `ak_${string}`[]
Overrides AeSdkBase.addresses
- Defined in AeSdkAepp.ts:77

askAddresses

askAddresses(): Promise<`ak_${string}`[]>
Ask addresses from wallet

Returns
Addresses from wallet

Returns Promise<`ak_${string}`[]>
- Defined in AeSdkAepp.ts:149

buildTx

buildTx(options: TxParamsAsync): Promise<`tx_${string}`>
Parameters
- options: TxParamsAsync
Returns Promise<`tx_${string}`>
Inherited from AeSdkBase.buildTx
- Defined in AeSdkMethods.ts:103

connectToWallet

connectToWallet(connection: default, options?: {
    connectNode?: boolean;
    name?: string;
}): Promise<WalletInfo & {
    node?: Node;
}>
Connect to wallet
Parameters
- connection: default
  
  Wallet connection object
- options: {
  connectNode?: boolean;
  name?: string;
  } = {}
  
  Options
  - Optional connectNode?: boolean
    
    Request wallet to bind node
  - Optional name?: string
    
    Node name
Returns Promise<WalletInfo & {
node?: Node;
}>
- Defined in AeSdkAepp.ts:93

disconnectWallet

disconnectWallet(): void
Disconnect from wallet

Returns void
- Defined in AeSdkAepp.ts:139

`Protected` ensureNodeConnected

ensureNodeConnected(): asserts this is AeSdkBase & {
selectedNodeName: string;
}
Returns asserts this is AeSdkBase & {
selectedNodeName: string;
}
Inherited from AeSdkBase.ensureNodeConnected
- Defined in AeSdkBase.ts:90

getNodeInfo

getNodeInfo(): Promise<NodeInfo>
Get information about node

Example
```
nodePool.getNodeInfo() // { name, version, networkId, protocol, ... }
```
Returns Promise<NodeInfo>
Inherited from AeSdkBase.getNodeInfo
- Defined in AeSdkBase.ts:103

getNodesInPool

getNodesInPool(): Promise<NodeInfo[]>
Get array of available nodes

Example
```
nodePool.getNodesInPool()
```
Returns Promise<NodeInfo[]>
Inherited from AeSdkBase.getNodesInPool
- Defined in AeSdkBase.ts:116

initializeContract

initializeContract<Methods>(options?: Omit<Omit<{
    aci: Aci;
    address?: `ct_${string}`;
    bytecode?: `cb_${string}`;
    fileSystem?: Record<string, string>;
    onCompiler?: CompilerBase;
    onNode: Node;
    sourceCode?: string;
    sourceCodePath?: string;
} & Partial<BuildTxOptions<ContractCallTx, "callData" | "callerId" | "contractId">> & {
    omitUnknown?: boolean;
} & GetContractNameByEventOptions & Omit<SendTransactionOptions, "onNode" | "onAccount"> & Omit<{
    combine?: boolean;
    onNode: Node;
    top?: number | `kh_${string}` | `mh_${string}`;
    txEvents?: boolean;
}, "onNode"> & {
    callStatic?: boolean;
    onAccount?: AccountBase;
    onNode?: Node;
} & Partial<BuildTxOptions<ContractCreateTx, "code" | "ownerId" | "callData">>, "address" | "aci"> & {
    aci?: Aci;
    address?: `${string}.chain` | `ct_${string}`;
    validateBytecode?: boolean;
}, "onNode"> & {
    onNode?: Node;
}): Promise<Contract<Methods>>
Type Parameters
- Methods extends ContractMethodsBase
Parameters
- Optional options: Omit<Omit<{
      aci: Aci;
      address?: `ct_${string}`;
      bytecode?: `cb_${string}`;
      fileSystem?: Record<string, string>;
      onCompiler?: CompilerBase;
      onNode: Node;
      sourceCode?: string;
      sourceCodePath?: string;
  } & Partial<BuildTxOptions<ContractCallTx, "callData" | "callerId" | "contractId">> & {
      omitUnknown?: boolean;
  } & GetContractNameByEventOptions & Omit<SendTransactionOptions, "onNode" | "onAccount"> & Omit<{
      combine?: boolean;
      onNode: Node;
      top?: number | `kh_${string}` | `mh_${string}`;
      txEvents?: boolean;
  }, "onNode"> & {
      callStatic?: boolean;
      onAccount?: AccountBase;
      onNode?: Node;
  } & Partial<BuildTxOptions<ContractCreateTx, "code" | "ownerId" | "callData">>, "address" | "aci"> & {
      aci?: Aci;
      address?: `${string}.chain` | `ct_${string}`;
      validateBytecode?: boolean;
  }, "onNode"> & {
      onNode?: Node;
  }
Returns Promise<Contract<Methods>>
Inherited from AeSdkBase.initializeContract
- Defined in AeSdkMethods.ts:107

isNodeConnected

isNodeConnected(): this is AeSdkBase & {
selectedNodeName: string;
}
Check if you have selected node

Example
```
nodePool.isNodeConnected()
```
Returns this is AeSdkBase & {
selectedNodeName: string;
}
Inherited from AeSdkBase.isNodeConnected
- Defined in AeSdkBase.ts:86

selectNode

selectNode(name: string): void
Select Node

Example
```
nodePool.selectNode('testNode')
```
Parameters
- name: string
  
  Node name
Returns void
Inherited from AeSdkBase.selectNode
- Defined in AeSdkBase.ts:76

sign

sign(data: string | Uint8Array, __namedParameters?: {
onAccount?: OnAccount;
}): Promise<Uint8Array>
Parameters
- data: string | Uint8Array
- __namedParameters: {
  onAccount?: OnAccount;
  } = {}
  - Optional onAccount?: OnAccount
Returns Promise<Uint8Array>
Inherited from AeSdkBase.sign
- Defined in AeSdkBase.ts:134

signMessage

signMessage(message: string, __namedParameters?: {
    onAccount?: OnAccount;
} & {
    aeppOrigin?: string;
    aeppRpcClientId?: string;
}): Promise<Uint8Array>
Parameters
- message: string
- __namedParameters: {
      onAccount?: OnAccount;
  } & {
      aeppOrigin?: string;
      aeppRpcClientId?: string;
  } = {}
Returns Promise<Uint8Array>
Inherited from AeSdkBase.signMessage
- Defined in AeSdkBase.ts:149

signTransaction

signTransaction(tx: `tx_${string}`, __namedParameters?: {
    onAccount?: OnAccount;
} & {
    aeppOrigin?: string;
    aeppRpcClientId?: string;
    authData?: AuthData | ((tx: `tx_${string}`) => Promise<AuthData>);
    innerTx?: boolean;
    networkId?: string;
    onCompiler?: CompilerBase;
    onNode?: Node;
}): Promise<`tx_${string}`>
Parameters
- tx: `tx_${string}`
- __namedParameters: {
      onAccount?: OnAccount;
  } & {
      aeppOrigin?: string;
      aeppRpcClientId?: string;
      authData?: AuthData | ((tx: `tx_${string}`) => Promise<AuthData>);
      innerTx?: boolean;
      networkId?: string;
      onCompiler?: CompilerBase;
      onNode?: Node;
  } = {}
Returns Promise<`tx_${string}`>
Inherited from AeSdkBase.signTransaction
- Defined in AeSdkBase.ts:141

subscribeAddress

subscribeAddress(type: SUBSCRIPTION_TYPES, value: "connected" | "current"): Promise<Promise<{
address: Accounts;
subscription: ("connected" | "current")[];
}>>
Subscribe for addresses from wallet

Returns
Accounts from wallet
Parameters
- type: SUBSCRIPTION_TYPES
  
  Subscription type
- value: "connected" | "current"
  
  Should be one of 'current' (the selected account), 'connected' (all)
Returns Promise<Promise<{
address: Accounts;
subscription: ("connected" | "current")[];
}>>
- Defined in AeSdkAepp.ts:160

Class AeSdkAepp

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: { name: string; onAddressChange?: ((a: Accounts) => void); onDisconnect?: ((p: any) => void); onNetworkChange?: ((a: Network) => void); } & AeSdkMethodsOptions & { nodes?: { instance: Node; name: string; }[]; }

Returns AeSdkAepp

Properties

Optional _accounts

_getPollInterval

Type declaration

Parameters

Rest ...args: ["block" | "microblock"] | ["block" | "microblock", Omit<{ _expectedMineRate?: number; _maxPollInterval?: number; _microBlockCycle?: number; }, "onNode" | "onAccount" | "onCompiler"> & Partial<{ _expectedMineRate?: number; _maxPollInterval?: number; _microBlockCycle?: number; }>]

Returns number

_options

aensBid

Type declaration

Parameters

Returns Promise<AensClaimReturnType>

aensClaim

Type declaration

Parameters

Rest ...args: [name: `${string}.chain`, salt: number] | [`${string}.chain`, number, Omit<AensClaimOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensClaimOptions, "onAccount"> & { onAccount: OnAccount; }>]

Returns Promise<AensClaimReturnType>

aensPreclaim

Type declaration

Parameters

Rest ...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<AensPreclaimOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensPreclaimOptions, "onAccount"> & { onAccount: OnAccount; }>]

Returns Promise<Readonly<SendTransactionReturnType & { claim: ((opts?: AensClaimOptions) => Promise<AensClaimReturnType>); commitmentId: string; salt: number; }>>

aensQuery

Type declaration

Parameters

Rest ...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onAccount"> & { onAccount: OnAccount; }>]

aensRevoke

Type declaration

Parameters

Rest ...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<AensRevokeOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensRevokeOptions, "onAccount"> & { onAccount: OnAccount; }>]

Returns Promise<SendTransactionReturnType>

aensTransfer

Type declaration

Parameters

Rest ...args: [name: `${string}.chain`, account: `ak_${string}`] | [`${string}.chain`, `ak_${string}`, Omit<AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensTransferOptions, "onAccount"> & { onAccount: OnAccount; }>]

Returns Promise<SendTransactionReturnType>

aensUpdate

Type declaration

Parameters

Rest ...args: [`${string}.chain`, KeyPointers] | [`${string}.chain`, KeyPointers, Omit<AensUpdateOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensUpdateOptions, "onAccount"> & { onAccount: OnAccount; }>]

Returns Promise<SendTransactionReturnType>

awaitHeight

Type declaration

Parameters

Returns Promise<number>

buildAuthTxHash

Type declaration

Parameters

Rest ...args: [`tx_${string}`] | [`tx_${string}`, Omit<{ fee?: Int; gasPrice?: Int; onNode: Node; }, "onNode" | "onAccount" | "onCompiler"> & Partial<{ fee?: Int; gasPrice?: Int; onNode: Node; }>]

Returns Promise<Buffer>

buildAuthTxHashByGaMetaTx

Type declaration

Parameters

Rest ...args: [`tx_${string}`] | [`tx_${string}`, Omit<{ onNode: Node; }, "onNode" | "onAccount" | "onCompiler"> & Partial<{ onNode: Node; }>]

Returns Promise<Buffer>

createDelegationSignature

Type declaration

Parameters

Returns Promise<Uint8Array>

createGeneralizedAccount

Type declaration

Parameters

Rest ...args: [string, any[]] | [string, any[], Omit<CreateGeneralizedAccountOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<CreateGeneralizedAccountOptions, "onAccount"> & { onAccount: OnAccount; }>]

Returns Promise<Readonly<{ gaContractId: `ct_${string}`; owner: `ak_${string}`; rawTx: `tx_${string}`; transaction: `th_${string}`; }>>

extendOracleTtl

Type declaration

Parameters

Rest ...args: [] | [Omit<ExtendOracleTtlOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<ExtendOracleTtlOptions, "onAccount"> & { onAccount: OnAccount; }>]

options: {
name: string;
onAddressChange?: ((a: Accounts) => void);
onDisconnect?: ((p: any) => void);
onNetworkChange?: ((a: Network) => void);
} & AeSdkMethodsOptions & {
nodes?: {
instance: Node;
name: string;
}[];
}

`Optional` _accounts

`Rest` ...args: ["block" | "microblock"] | ["block" | "microblock", Omit<{
_expectedMineRate?: number;
_maxPollInterval?: number;
_microBlockCycle?: number;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
_expectedMineRate?: number;
_maxPollInterval?: number;
_microBlockCycle?: number;
}>]

`Rest` ...args: [name: `${string}.chain`, salt: number] | [`${string}.chain`, number, Omit<AensClaimOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensClaimOptions, "onAccount"> & {
onAccount: OnAccount;
}>]

`Rest` ...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<AensPreclaimOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensPreclaimOptions, "onAccount"> & {
onAccount: OnAccount;
}>]

Returns Promise<Readonly<SendTransactionReturnType & {
claim: ((opts?: AensClaimOptions) => Promise<AensClaimReturnType>);
commitmentId: string;
salt: number;
}>>

`Rest` ...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<{
onNode: Node;
} & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<{
onNode: Node;
} & AensUpdateOptions & AensTransferOptions, "onAccount"> & {
onAccount: OnAccount;
}>]

`Rest` ...args: [name: `${string}.chain`] | [`${string}.chain`, Omit<AensRevokeOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensRevokeOptions, "onAccount"> & {
onAccount: OnAccount;
}>]

`Rest` ...args: [name: `${string}.chain`, account: `ak_${string}`] | [`${string}.chain`, `ak_${string}`, Omit<AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensTransferOptions, "onAccount"> & {
onAccount: OnAccount;
}>]

`Rest` ...args: [`${string}.chain`, KeyPointers] | [`${string}.chain`, KeyPointers, Omit<AensUpdateOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<AensUpdateOptions, "onAccount"> & {
onAccount: OnAccount;
}>]

`Rest` ...args: [`tx_${string}`] | [`tx_${string}`, Omit<{
fee?: Int;
gasPrice?: Int;
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
fee?: Int;
gasPrice?: Int;
onNode: Node;
}>]

`Rest` ...args: [`tx_${string}`] | [`tx_${string}`, Omit<{
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
onNode: Node;
}>]

`Rest` ...args: [string, any[]] | [string, any[], Omit<CreateGeneralizedAccountOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<CreateGeneralizedAccountOptions, "onAccount"> & {
onAccount: OnAccount;
}>]

Returns Promise<Readonly<{
gaContractId: `ct_${string}`;
owner: `ak_${string}`;
rawTx: `tx_${string}`;
transaction: `th_${string}`;
}>>

`Rest` ...args: [] | [Omit<ExtendOracleTtlOptions, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<ExtendOracleTtlOptions, "onAccount"> & {
onAccount: OnAccount;
}>]

`Rest` ...args: [`ct_${string}` | `ak_${string}`] | [`ct_${string}` | `ak_${string}`, Omit<{
hash?: `kh_${string}` | `mh_${string}`;
height?: number;
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
hash?: `kh_${string}` | `mh_${string}`;
height?: number;
onNode: Node;
}>]

Returns Promise<{
authFun?: string;
balance: bigint;
contractId?: string;
id: string;
kind?: AccountKind;
nonce: number;
payable?: boolean;
}>

`Rest` ...args: [`ct_${string}`] | [`ct_${string}`, Omit<{
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
onNode: Node;
}>]

Returns Promise<{
abiVersion: string;
active: boolean;
deposit: bigint;
id: string;
ownerId: string;
referrerIds: string[];
vmVersion: string;
}>

`Rest` ...args: [`ct_${string}`] | [`ct_${string}`, Omit<{
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
onNode: Node;
}>]

Returns Promise<{
bytecode: `cb_${string}`;
}>

`Rest` ...args: [] | [Omit<{
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
onNode: Node;
}>]

Returns Promise<{
keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
microBlocks: string[];
}>

`Rest` ...args: [number | `kh_${string}`] | [number | `kh_${string}`, Omit<{
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
onNode: Node;
}>]

Returns Promise<{
keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
microBlocks: string[];
}>

`Rest` ...args: [] | [Omit<{
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
onNode: Node;
}>]

`Rest` ...args: [number | `kh_${string}`] | [number | `kh_${string}`, Omit<{
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
onNode: Node;
}>]

Returns Promise<{
beneficiary: string;
hash: string;
height: number;
info: string;
miner: string;
nonce?: number;
pow?: string[];
prevHash: string;
prevKeyHash: string;
stateHash: string;
target: string;
time: number;
version: number;
}>

`Rest` ...args: [`mh_${string}`] | [`mh_${string}`, Omit<{
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
onNode: Node;
}>]

Returns Promise<{
hash: string;
height: number;
pofHash: string;
prevHash: string;
prevKeyHash: string;
signature: string;
stateHash: string;
time: number;
txsHash: string;
version: number;
}>

`Rest` ...args: [`mh_${string}`] | [`mh_${string}`, Omit<{
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
onNode: Node;
}>]

`Rest` ...args: [`${string}.chain`] | [`${string}.chain`, Omit<{
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<{
onNode: Node;
}>]

Returns Promise<{
id: string;
owner?: string;
pointers: ({ key: string; id: string; })[];
ttl: number;
}>

`Rest` ...args: [oracleId: `ok_${string}`] | [`ok_${string}`, Omit<{
onAccount: AccountBase;
onNode: Node;
}, "onNode" | "onAccount" | "onCompiler"> & Partial<Omit<{
onAccount: AccountBase;
onNode: Node;
}, "onAccount"> & {
onAccount: OnAccount;
}>]