Class AeSdkBase

Basic AeSdk class

AeSdkBase objects are the composition of:

chain methods
tx methods
aens methods
spend methods
oracle methods
contract methods
contract ga methods Only by providing the joint functionality of them, most more advanced operations, i.e. the ones with actual use value on the chain, become available.

Hierarchy

AeSdkBase

Index

Constructors

constructor

new AeSdkBase(options?: { compilerUrl?: string; ignoreVersion?: boolean; nodes?: { instance: Node; name: string }[]; [key: string]: any }): <internal>.AeSdkBase
Parameters
- options: { compilerUrl?: string; ignoreVersion?: boolean; nodes?: { instance: Node; name: string }[]; [key: string]: any } = {}
  
  Options
  - [key: string]: any
  - Optional compilerUrl?: string
    
    Url for compiler API
  - Optional ignoreVersion?: boolean
    
    Don't check node or compiler version
  - Optional nodes?: { instance: Node; name: string }[]
    
    Array of nodes
Returns <internal>.AeSdkBase
- Defined in AeSdkBase.ts:76

Properties

_options

_options: { amount: number; denomination: AE_AMOUNT_FORMATS; [key: string]: any } = ...

Type declaration

[key: string]: any
amount: number
denomination: AE_AMOUNT_FORMATS

compilerApi

compilerApi: Compiler

`Readonly` getNetworkId

getNetworkId: ((__namedParameters?: { networkId?: string }) => Promise<string>) = getNetworkId

Type declaration

- (__namedParameters?: { networkId?: string }): Promise<string>
- Obtain networkId from account or node
  Parameters
  - __namedParameters: { networkId?: string } = {}
    - Optional networkId?: string
  Returns Promise<string>

pool

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

`Optional` selectedNodeName

selectedNodeName?: string

Accessors

api

get api(): Node
Returns Node
- Defined in AeSdkBase.ts:105

Methods

_getOptions

_getOptions(): { onAccount: AccountBase; onCompiler: Compiler; onNode: Node }
Returns { onAccount: AccountBase; onCompiler: Compiler; onNode: Node }
- onAccount: AccountBase
- onCompiler: Compiler
- onNode: Node
- Defined in AeSdkBase.ts:250

_resolveAccount

_resolveAccount(account?: any): AccountBase
Resolves an account
Parameters
- Optional account: any
  
  ak-address, instance of AccountBase, or keypair
Returns AccountBase
- Defined in AeSdkBase.ts:236

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

address

address(__namedParameters?: { onAccount?: any }): Promise<`ak_${string}`>
Parameters
- __namedParameters: { onAccount?: any } = {}
  - Optional onAccount?: any
Returns Promise<`ak_${string}`>
- Defined in AeSdkBase.ts:197

addresses

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

buildTx

buildTx<TxType>(txType: TxType, options: Omit<Omit<Omit<TxTypeSchemas[TxType], "tag" | "VSN"> & { VSN?: number }, "nonce" | "fee" | "ttl" | "abiVersion" | "ctVersion"> & { absoluteTtl?: boolean; denomination?: AE_AMOUNT_FORMATS; fee?: <internal>.Int; nonce?: number; onNode: Node; ttl?: number } & (TxType extends OracleResponseTx | OracleExtendTx ? { callerId: `ak_${string}` } : {}) & (TxType extends ContractCreateTx | GaAttachTx ? { ctVersion?: CtVersion } : {}) & (TxType extends OracleRegisterTx | ContractCallTx ? { abiVersion?: ABI_VERSIONS } : {}), "onNode"> & { onNode?: Node }): Promise<`tx_${string}`>
Type Parameters
- TxType extends Tag
Parameters
- txType: TxType
- options: Omit<Omit<Omit<TxTypeSchemas[TxType], "tag" | "VSN"> & { VSN?: number }, "nonce" | "fee" | "ttl" | "abiVersion" | "ctVersion"> & { absoluteTtl?: boolean; denomination?: AE_AMOUNT_FORMATS; fee?: <internal>.Int; nonce?: number; onNode: Node; ttl?: number } & (TxType extends OracleResponseTx | OracleExtendTx ? { callerId: `ak_${string}` } : {}) & (TxType extends ContractCreateTx | GaAttachTx ? { ctVersion?: CtVersion } : {}) & (TxType extends OracleRegisterTx | ContractCallTx ? { abiVersion?: ABI_VERSIONS } : {}), "onNode"> & { onNode?: Node }
Returns Promise<`tx_${string}`>
- Defined in AeSdkBase.ts:263

`Protected` ensureNodeConnected

ensureNodeConnected(): asserts this is <internal>.AeSdkBase & { selectedNodeName: string }
Returns asserts this is <internal>.AeSdkBase & { selectedNodeName: string }
- Defined in AeSdkBase.ts:157

getNodeInfo

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

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

getNodesInPool

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

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

isNodeConnected

isNodeConnected(): this is <internal>.AeSdkBase & { selectedNodeName: string }
Check if you have selected node

Example
```
nodePool.isNodeConnected()
```
Returns this is <internal>.AeSdkBase & { selectedNodeName: string }
- Defined in AeSdkBase.ts:153

selectNode

selectNode(name: string): void
Select Node

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

setCompilerUrl

setCompilerUrl(compilerUrl: string, __namedParameters?: { ignoreVersion?: boolean }): void
Parameters
- compilerUrl: string
- __namedParameters: { ignoreVersion?: boolean } = {}
  - Optional ignoreVersion?: boolean
Returns void
- Defined in AeSdkBase.ts:98

sign

sign(data: string | Uint8Array, __namedParameters?: { onAccount?: any }): Promise<Uint8Array>
Parameters
- data: string | Uint8Array
- __namedParameters: { onAccount?: any } = {}
  - Optional onAccount?: any
Returns Promise<Uint8Array>
- Defined in AeSdkBase.ts:201

signMessage

signMessage(message: string, __namedParameters?: { onAccount?: any } & { returnHex?: boolean }): Promise<string | Uint8Array>
Parameters
- message: string
- __namedParameters: { onAccount?: any } & { returnHex?: boolean } = {}
Returns Promise<string | Uint8Array>
- Defined in AeSdkBase.ts:216

signTransaction

signTransaction(tx: `tx_${string}`, __namedParameters?: { onAccount?: any } & { authData?: { args?: any[]; callData?: `cb_${string}`; gasLimit?: number; source?: string }; authFun?: string; innerTx?: boolean; networkId?: string } & Omit<Partial<{ onAccount: AccountBase; onCompiler: Compiler; onNode: Node } & object>, "onAccount">): Promise<`tx_${string}`>
Parameters
- tx: `tx_${string}`
- __namedParameters: { onAccount?: any } & { authData?: { args?: any[]; callData?: `cb_${string}`; gasLimit?: number; source?: string }; authFun?: string; innerTx?: boolean; networkId?: string } & Omit<Partial<{ onAccount: AccountBase; onCompiler: Compiler; onNode: Node } & object>, "onAccount"> = {}
Returns Promise<`tx_${string}`>
- Defined in AeSdkBase.ts:208

verifyMessage

verifyMessage(message: string, signature: string | Uint8Array, __namedParameters?: { onAccount?: any } & object): Promise<boolean>
Parameters
- message: string
- signature: string | Uint8Array
- __namedParameters: { onAccount?: any } & object = {}
Returns Promise<boolean>
- Defined in AeSdkBase.ts:223

Class AeSdkBase

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: { compilerUrl?: string; ignoreVersion?: boolean; nodes?: { instance: Node; name: string }[]; [key: string]: any } = {}

[key: string]: any

Optional compilerUrl?: string

Optional ignoreVersion?: boolean

Optional nodes?: { instance: Node; name: string }[]

Returns <internal>.AeSdkBase

Properties

_options

Type declaration

[key: string]: any

amount: number

denomination: AE_AMOUNT_FORMATS

compilerApi

Readonly getNetworkId

Type declaration

Parameters

__namedParameters: { networkId?: string } = {}

Optional networkId?: string

Returns Promise<string>

pool

Optional selectedNodeName

Accessors

api

Returns Node

Methods

_getOptions

Returns { onAccount: AccountBase; onCompiler: Compiler; onNode: Node }

onAccount: AccountBase

onCompiler: Compiler

onNode: Node

_resolveAccount

Parameters

Optional account: any

Returns AccountBase

addNode

Example

Parameters

name: string

node: Node

select: boolean = false

Returns void

address

Parameters

__namedParameters: { onAccount?: any } = {}

Optional onAccount?: any

Returns Promise<`ak_${string}`>

addresses

Returns `ak_${string}`[]

buildTx

Type Parameters

TxType extends Tag

Parameters

txType: TxType

Returns Promise<`tx_${string}`>

Protected ensureNodeConnected

Returns asserts this is <internal>.AeSdkBase & { selectedNodeName: string }

getNodeInfo

Example

Returns Promise<<internal>.NodeInfo>

getNodesInPool

Example

Returns Promise<<internal>.NodeInfo[]>

isNodeConnected

Example

Returns this is <internal>.AeSdkBase & { selectedNodeName: string }

selectNode

Example

Parameters

name: string

Returns void

`Optional` compilerUrl?: string

`Optional` ignoreVersion?: boolean

`Optional` nodes?: { instance: Node; name: string }[]

`Readonly` getNetworkId

`Optional` networkId?: string

`Optional` selectedNodeName

`Optional` account: any

`Optional` onAccount?: any

`Protected` ensureNodeConnected

`Optional` ignoreVersion?: boolean

`Optional` onAccount?: any