Class AccountBase`Abstract`

Account is one of the three basic building blocks of an AeSdk and provides access to a signing key pair.

Hierarchy

AccountBase
- MemoryAccount

Index

Constructors

constructor

new AccountBase(options?: { networkId?: string }): AccountBase
Parameters
- options: { networkId?: string } = {}
  
  Options
  - Optional networkId?: string
    
    Using for signing transactions
Returns AccountBase
- Defined in account/Base.ts:44

Properties

`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>

`Optional` networkId

networkId?: string

Methods

`Abstract` address

address(opt?: object): Promise<`ak_${string}`>
Obtain account address

Returns
Public account address
Parameters
- Optional opt: object
Returns Promise<`ak_${string}`>
- Defined in account/Base.ts:123

`Abstract` sign

sign(data: string | Uint8Array, options?: any): Promise<Uint8Array>
Sign data blob

Returns
Signed data blob
Parameters
- data: string | Uint8Array
  
  Data blob to sign
- Optional options: any
  
  Options
Returns Promise<Uint8Array>
- Defined in account/Base.ts:117

signMessage

signMessage(message: string, opt?: { returnHex?: boolean }): Promise<string | Uint8Array>
Sign message

Returns
Signature as hex string of Uint8Array
Parameters
- message: string
  
  Message to sign
- opt: { returnHex?: boolean } = {}
  
  Options
  - Optional returnHex?: boolean
Returns Promise<string | Uint8Array>
- Defined in account/Base.ts:85

signTransaction

signTransaction(tx: `tx_${string}`, opt?: { 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}`>
Sign encoded transaction

Returns
Signed transaction
Parameters
- tx: `tx_${string}`
  
  Transaction to sign
- opt: { 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"> = {}
  
  Options
Returns Promise<`tx_${string}`>
- Defined in account/Base.ts:55

verifyMessage

verifyMessage(message: string, signature: string | Uint8Array, options?: object): Promise<boolean>
Verify message
Parameters
- message: string
  
  Message to verify
- signature: string | Uint8Array
  
  Signature
- Optional options: object
  
  Options
Returns Promise<boolean>
- Defined in account/Base.ts:99

Class AccountBaseAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: { networkId?: string } = {}

Optional networkId?: string

Returns AccountBase

Properties

Readonly getNetworkId

Type declaration

Parameters

__namedParameters: { networkId?: string } = {}

Optional networkId?: string

Returns Promise<string>

Optional networkId

Methods

Abstract address

Returns

Parameters

Optional opt: object

Returns Promise<`ak_${string}`>

Abstract sign

Returns

Parameters

data: string | Uint8Array

Optional options: any

Returns Promise<Uint8Array>

signMessage

Returns

Parameters

message: string

opt: { returnHex?: boolean } = {}

Optional returnHex?: boolean

Returns Promise<string | Uint8Array>

signTransaction

Returns

Parameters

tx: `tx_${string}`

opt: { 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}`>

verifyMessage

Parameters

message: string

signature: string | Uint8Array

Optional options: object

Returns Promise<boolean>

Settings

Member Visibility

Theme

Class AccountBase`Abstract`

`Optional` networkId?: string

`Readonly` getNetworkId

`Optional` networkId?: string

`Optional` networkId

`Abstract` address

`Optional` opt: object

`Abstract` sign

`Optional` options: any

`Optional` returnHex?: boolean

`Optional` options: object