Class AeSdkAepp

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

Hierarchy

AeSdkBase
- AeSdkAepp

Index

Constructors

Properties

_accounts? _options createDelegationSignature name onAddressChange onDisconnect onNetworkChange pool rpcClient? 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 AeSdkAepp(options): AeSdkAepp
Parameters
- options: {
      name: string;
      onAddressChange?: ((a) => void);
      onDisconnect?: ((p) => void);
      onNetworkChange?: ((a) => void);
  } & AeSdkMethodsOptions & {
      nodes?: {
          instance: Node;
          name: string;
      }[];
  }
  
  Options
Returns AeSdkAepp
Overrides AeSdkBase.constructor
- Defined in AeSdkAepp.ts:46

Properties

`Optional` _accounts

_accounts?: Accounts

_options

_options: AeSdkMethodsOptions = {}

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>

name

name: string

onAddressChange

onAddressChange: ((a) => void)

Type declaration

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

onDisconnect

onDisconnect: ((p) => void)

Type declaration

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

onNetworkChange

onNetworkChange: ((a) => void)

Type declaration

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

pool

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

`Optional` rpcClient

rpcClient?: default<WalletApi, AeppApi>

`Optional` selectedNodeName

selectedNodeName?: string

Accessors

address

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

api

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

compilerApi

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

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(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 AeSdkBase._getOptions
- Defined in AeSdkBase.ts:215

_resolveAccount

_resolveAccount(account?): 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, 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 AeSdkBase.addNode
- Defined in AeSdkBase.ts:64

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 Promise<`ak_${string}`[]>
Addresses from wallet
- Defined in AeSdkAepp.ts:149

buildTx

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

connectToWallet

connectToWallet(connection, options?): 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:93

getNodeInfo

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

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

getNodesInPool

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

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

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 AeSdkBase.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 AeSdkBase.isNodeConnected
- Defined in AeSdkBase.ts:89

selectNode

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

sign

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

subscribeAddress

subscribeAddress(type, value): Promise<Promise<{
address: Accounts;
subscription: ("connected" | "current")[];
}>>
Subscribe for addresses 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")[];
}>>
Accounts from wallet
- Defined in AeSdkAepp.ts:160

Generated using TypeDoc