Class AeSdkWallet

Contain functionality for aepp interaction and managing multiple aepps

Hierarchy

AeSdk
- AeSdkWallet

Index

Constructors

Properties

_clients _options _type accounts createDelegationSignature id name onAskAccounts onConnection onDisconnect onSubscription pool selectedAddress? selectedNodeName?

Accessors

address api compilerApi

References

_getPollInterval

Re-exports _getPollInterval

aensBid

Re-exports aensBid

aensClaim

Re-exports aensClaim

aensPreclaim

Re-exports aensPreclaim

aensQuery

Re-exports aensQuery

aensRevoke

Re-exports aensRevoke

aensTransfer

Re-exports aensTransfer

aensUpdate

Re-exports aensUpdate

awaitHeight

Re-exports awaitHeight

buildAuthTxHash

Re-exports buildAuthTxHash

buildAuthTxHashByGaMetaTx

Re-exports buildAuthTxHashByGaMetaTx

createGeneralizedAccount

Re-exports createGeneralizedAccount

extendOracleTtl

Re-exports extendOracleTtl

getAccount

Re-exports getAccount

getBalance

Re-exports getBalance

getContract

Re-exports getContract

getContractByteCode

Re-exports getContractByteCode

getCurrentGeneration

Re-exports getCurrentGeneration

getGeneration

Re-exports getGeneration

getHeight

Re-exports getHeight

getKeyBlock

Re-exports getKeyBlock

getMicroBlockHeader

Re-exports getMicroBlockHeader

getMicroBlockTransactions

Re-exports getMicroBlockTransactions

getName

Re-exports getName

getOracleObject

Re-exports getOracleObject

getQueryObject

Re-exports getQueryObject

payForTransaction

Re-exports payForTransaction

poll

Re-exports poll

pollForQueries

Re-exports pollForQueries

pollForQueryResponse

Re-exports pollForQueryResponse

postQueryToOracle

Re-exports postQueryToOracle

registerOracle

Re-exports registerOracle

resolveName

Re-exports resolveName

respondToQuery

Re-exports respondToQuery

sendTransaction

Re-exports sendTransaction

spend

Re-exports spend

transferFunds

Re-exports transferFunds

txDryRun

Re-exports txDryRun

waitForTxConfirm

Re-exports waitForTxConfirm

Constructors

constructor

new AeSdkWallet(options): AeSdkWallet
Parameters
- options: {
      id: string;
      name: string;
      onAskAccounts: OnAskAccounts;
      onConnection: OnConnection;
      onDisconnect: OnDisconnect;
      onSubscription: OnSubscription;
      type: WALLET_TYPE;
  } & {
      accounts?: AccountBase[];
  } & AeSdkMethodsOptions & {
      nodes?: {
          instance: Node;
          name: string;
      }[];
  }
  
  Options
Returns AeSdkWallet
Overrides AeSdk.constructor
- Defined in AeSdkWallet.ts:81

Properties

_clients

_clients: Map<string, RpcClientsInfo> = ...

_options

_options: AeSdkMethodsOptions = {}

_type

_type: WALLET_TYPE

accounts

accounts: {
[key: AccountAddress]: AccountBase;
} = {}

Type declaration

[key: AccountAddress]: AccountBase

createDelegationSignature

createDelegationSignature: ((...args) => Promise<Uint8Array>)

Type declaration

- (...args): Promise<Uint8Array>
- Parameters
  - Rest ...args: [`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}`)[]] | [`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>

id

id: string

name

name: string

onAskAccounts

onAskAccounts: OnAskAccounts

onConnection

onConnection: OnConnection

onDisconnect

onDisconnect: OnDisconnect

onSubscription

onSubscription: OnSubscription

pool

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

`Optional` selectedAddress

selectedAddress?: `ak_${string}`

`Optional` selectedNodeName

selectedNodeName?: string

Accessors

address

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

api

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

compilerApi

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

Methods

_disconnectRpcClient

_disconnectRpcClient(clientId): void
Parameters
- clientId: string
Returns void
- Defined in AeSdkWallet.ts:168

_getAccountsForClient

_getAccountsForClient(__namedParameters): Accounts
Parameters
- __namedParameters: RpcClientsInfo
Returns Accounts
- Defined in AeSdkWallet.ts:109

_getClient

_getClient(clientId): RpcClientsInfo
Parameters
- clientId: string
Returns RpcClientsInfo
- Defined in AeSdkWallet.ts:157

_getNode

_getNode(): {
node: undefined | Node;
}
Returns {
node: undefined | Node;
}
- node: undefined | Node
- Defined in AeSdkWallet.ts:138

_getOptions

_getOptions(callOptions?): {
    onAccount: AccountBase;
    onCompiler: CompilerBase;
    onNode: Node;
}
Parameters
- callOptions: AeSdkMethodsOptions = {}
Returns {
    onAccount: AccountBase;
    onCompiler: CompilerBase;
    onNode: Node;
}
- onAccount: AccountBase
- onCompiler: CompilerBase
- onNode: Node
Inherited from AeSdk._getOptions
- Defined in AeSdkBase.ts:215

_isRpcClientConnected

_isRpcClientConnected(clientId): boolean
Parameters
- clientId: string
Returns boolean
- Defined in AeSdkWallet.ts:163

_pushAccountsToApps

_pushAccountsToApps(): void
Returns void
- Defined in AeSdkWallet.ts:118

_resolveAccount

_resolveAccount(account?): AccountBase
Resolves an account
Parameters
- account: OnAccount = ...
  
  ak-address, instance of AccountBase, or keypair
Returns AccountBase
Inherited from AeSdk._resolveAccount
- Defined in AeSdk.ts:20

addAccount

addAccount(account, options?): void
Add specific account
Parameters
- account: AccountBase
  
  Account instance
- Optional options: {
  select?: boolean;
  }
  
  Options
  - Optional select?: boolean
Returns void
Example
```
addAccount(account)
```
Overrides AeSdk.addAccount
- Defined in AeSdkWallet.ts:133

addNode

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

addRpcClient

addRpcClient(clientConnection): string
Add new client by AEPP connection
Parameters
- clientConnection: default
  
  AEPP connection object
Returns string
Client ID
- Defined in AeSdkWallet.ts:189

addresses

addresses(): `ak_${string}`[]
Get accounts addresses

Returns `ak_${string}`[]
Example
```
addresses()
```
Inherited from AeSdk.addresses
- Defined in AeSdk.ts:34

buildTx

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

`Protected` ensureNodeConnected

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

getAccounts

getAccounts(): Accounts
Get Wallet accounts

Returns Accounts
Object with accounts information ({ connected: Object, current: Object })
- Defined in AeSdkWallet.ts:355

getNodeInfo

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

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

getNodesInPool

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

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

getWalletInfo

getWalletInfo(): Promise<WalletInfo>
Get Wallet info object

Returns Promise<WalletInfo>
Object with wallet information
- Defined in AeSdkWallet.ts:341

initializeContract

initializeContract<Methods>(options?): 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 AeSdk.initializeContract
- Defined in AeSdkMethods.ts:99

isNodeConnected

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

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

removeAccount

removeAccount(address): void
Remove specific account
Parameters
- address: `ak_${string}`
  
  Address of account to remove
Returns void
Example
```
removeAccount(address)
```
Inherited from AeSdk.removeAccount
- Defined in AeSdk.ts:56

removeRpcClient

removeRpcClient(id): void
Remove specific RpcClient by ID
Parameters
- id: string
  
  Client ID
Returns void
- Defined in AeSdkWallet.ts:179

selectAccount

selectAccount(address): void
Select specific account
Parameters
- address: `ak_${string}`
  
  Address of account to select
Returns void
Example
```
selectAccount('ak_xxxxxxxx')
```
Overrides AeSdk.selectAccount
- Defined in AeSdkWallet.ts:128

selectNode

selectNode(name): Promise<void>
Select Node
Parameters
- name: string
  
  Node name
Returns Promise<void>
Example
```
nodePool.selectNode('testNode')
```
Overrides AeSdk.selectNode
- Defined in AeSdkWallet.ts:143

shareWalletInfo

shareWalletInfo(clientId): Promise<void>
Send shareWalletInfo message to notify AEPP about wallet
Parameters
- clientId: string
  
  ID of RPC client send message to
Returns Promise<void>
- Defined in AeSdkWallet.ts:333

sign

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

signDelegationToContract

signDelegationToContract(contractAddress, __namedParameters?): Promise<`sg_${string}`>
Parameters
- contractAddress: `ct_${string}`
- __namedParameters: {
      onAccount?: OnAccount;
  } & {
      aeppOrigin?: string;
      aeppRpcClientId?: string;
      networkId?: string;
  } = {}
Returns Promise<`sg_${string}`>
Inherited from AeSdk.signDelegationToContract
- Defined in AeSdkBase.ts:180

signMessage

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

signNameDelegationToContract

signNameDelegationToContract(contractAddress, name, __namedParameters?): Promise<`sg_${string}`>
Parameters
- contractAddress: `ct_${string}`
- name: `${string}.chain`
- __namedParameters: {
      onAccount?: OnAccount;
  } & {
      aeppOrigin?: string;
      aeppRpcClientId?: string;
      networkId?: string;
  } = {}
Returns Promise<`sg_${string}`>
Inherited from AeSdk.signNameDelegationToContract
- Defined in AeSdkBase.ts:191

signOracleQueryDelegationToContract

signOracleQueryDelegationToContract(contractAddress, oracleQueryId, __namedParameters?): Promise<`sg_${string}`>
Parameters
- contractAddress: `ct_${string}`
- oracleQueryId: `oq_${string}`
- __namedParameters: {
      onAccount?: OnAccount;
  } & {
      aeppOrigin?: string;
      aeppRpcClientId?: string;
      networkId?: string;
  } = {}
Returns Promise<`sg_${string}`>
Inherited from AeSdk.signOracleQueryDelegationToContract
- Defined in AeSdkBase.ts:203

signTransaction

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

signTypedData

signTypedData(data, aci, __namedParameters?): Promise<`sg_${string}`>
Parameters
- data: `cb_${string}`
- aci: AciValue
- __namedParameters: {
      onAccount?: OnAccount;
  } & Domain & {
      aeppOrigin?: string;
      aeppRpcClientId?: string;
  } = {}
Returns Promise<`sg_${string}`>
Inherited from AeSdk.signTypedData
- Defined in AeSdkBase.ts:172

Generated using TypeDoc