Class default

The main class of the ain-js SDK library.

Constructors

constructor

Properties

axiosConfig chainId db em eventHandlerUrl? he net provider rawResultMode signer wallet

Accessors

utils

Methods

depositConsensusStake getBlockByHash getBlockByNumber getBlockHeadersList getBlockList getBlockTransactionCountByHash getBlockTransactionCountByNumber getConsensusStakeAmount getLastBlock getLastBlockNumber getPendingTransactions getProposerByHash getProposerByNumber getStateUsage getTransactionByBlockHashAndIndex getTransactionByBlockNumberAndIndex getTransactionByHash getTransactionPoolSizeUtilization getValidatorInfo getValidatorsByHash getValidatorsByNumber sendSignedTransaction sendTransaction sendTransactionBatch setProvider setSigner stakeFunction validateAppName withdrawConsensusStake instanceofTransactionBody

Constructors

constructor

  • new default(providerUrl, eventHandlerUrl?, chainId?, ainOptions?): default

  • Creates a new Ain object.

    Parameters

    • providerUrl: string

      The endpoint URL of the network provider.

    • Optional eventHandlerUrl: null | string

      The endpoint URL of the event handler websocket server.

    • Optional chainId: number

      The chain ID of the blockchain network.

    • Optional ainOptions: AinOptions

      The options of the class.

    Returns default

Properties

axiosConfig

axiosConfig: undefined | AxiosRequestConfig

The axios request config object.

chainId

chainId: number

The chain ID of the blockchain network.

db

db: default

The database object.

em

em: default

The event manager object.

Optional eventHandlerUrl

eventHandlerUrl?: null | string

The endpoint Url of the event handler websocket server.

he

he: default

The homorphic encryption object.

net

net: default

The network object.

provider

provider: default

The network provider object.

rawResultMode

rawResultMode: boolean

The raw result mode option.

signer

signer: Signer

The signer object.

wallet

wallet: default

The wallet object.

Accessors

Static utils

  • get utils(): __module

  • Getter for ain-util library.

    Returns __module

Methods

depositConsensusStake

  • depositConsensusStake(transactionObject): Promise<any>

  • Sends a transaction that deposits AIN for consensus staking.

    Parameters

    Returns Promise<any>

getBlockByHash

  • getBlockByHash(blockHash, returnTransactionObjects?): Promise<Block>

  • Fetches a block with a block hash.

    Parameters

    • blockHash: string

      The block hash.

    • Optional returnTransactionObjects: boolean

      If it's true, returns a block with full transaction objects. Otherwise, returns a block with only transaction hashes.

    Returns Promise<Block>

getBlockByNumber

  • getBlockByNumber(blockNumber, returnTransactionObjects?): Promise<Block>

  • Fetches a block with a block number.

    Parameters

    • blockNumber: number

      The block number.

    • Optional returnTransactionObjects: boolean

      If it's true, returns a block with full transaction objects. Otherwise, returns a block with only transaction hashes.

    Returns Promise<Block>

getBlockHeadersList

  • getBlockHeadersList(from, to): Promise<Block[]>

  • Fetches block headers with a block number range.

    Parameters

    • from: number

      The begining block number (inclusive).

    • to: number

      The ending block number (exclusive).

    Returns Promise<Block[]>

getBlockList

  • getBlockList(from, to): Promise<Block[]>

  • Fetches blocks with a block number range.

    Parameters

    • from: number

      The begining block number (inclusive).

    • to: number

      The ending block number (exclusive).

    Returns Promise<Block[]>

getBlockTransactionCountByHash

  • getBlockTransactionCountByHash(hash): Promise<Number>

  • Fetches block transaction count with a block hash.

    Parameters

    • hash: string

      The block hash.

    Returns Promise<Number>

getBlockTransactionCountByNumber

  • getBlockTransactionCountByNumber(number): Promise<Number>

  • Fetches block transaction count with a block number.

    Parameters

    • number: number

      The block number.

    Returns Promise<Number>

getConsensusStakeAmount

  • getConsensusStakeAmount(account?): Promise<number>

  • Fetches the amount of AIN currently staked for participating in consensus protocol.

    Parameters

    • Optional account: string

      The account to fetch the value with. If not specified, the default account of the signer is used.

    Returns Promise<number>

getLastBlock

getLastBlockNumber

getPendingTransactions

  • getPendingTransactions(): Promise<any>

  • Fetches pending transactions.

    Returns Promise<any>

getProposerByHash

  • getProposerByHash(blockHash): Promise<string>

  • Fetches the block proproser's address of a block with a block hash.

    Parameters

    • blockHash: string

      The block hash.

    Returns Promise<string>

getProposerByNumber

  • getProposerByNumber(blockNumber): Promise<string>

  • Fetches the block proproser's address of a block with a block number.

    Parameters

    • blockNumber: number

      The block number.

    Returns Promise<string>

getStateUsage

  • getStateUsage(appName): Promise<StateUsageInfo>

  • Fetches a blockchain app's state usage information with an app name.

    Parameters

    • appName: string

      The blockchain app name.

    Returns Promise<StateUsageInfo>

getTransactionByBlockHashAndIndex

  • getTransactionByBlockHashAndIndex(blockHash, index): Promise<TransactionInfo>

  • Fetches a transaction's information with a block hash and an index.

    Parameters

    • blockHash: string

      The block hash.

    • index: number

      The transaction index in the block

    Returns Promise<TransactionInfo>

getTransactionByBlockNumberAndIndex

  • getTransactionByBlockNumberAndIndex(blockNumber, index): Promise<TransactionInfo>

  • Fetches a transaction's information with a block hash and an index.

    Parameters

    • blockNumber: number

      The block number.

    • index: number

      The transaction index in the block

    Returns Promise<TransactionInfo>

getTransactionByHash

  • getTransactionByHash(transactionHash): Promise<TransactionInfo>

  • Fetches a transaction's information with a transaction hash.

    Parameters

    • transactionHash: string

      The transaction hash.

    Returns Promise<TransactionInfo>

getTransactionPoolSizeUtilization

  • getTransactionPoolSizeUtilization(): Promise<any>

  • Fetches transaction pool size utilization.

    Returns Promise<any>

getValidatorInfo

  • getValidatorInfo(address): Promise<any>

  • Fetches the information of the given validator address.

    Parameters

    • address: string

      The validator address.

    Returns Promise<any>

getValidatorsByHash

  • getValidatorsByHash(blockHash): Promise<any>

  • Fetches the validator list of a block with a block hash.

    Parameters

    • blockHash: string

      The block hash.

    Returns Promise<any>

getValidatorsByNumber

  • getValidatorsByNumber(blockNumber): Promise<any>

  • Fetches the validator list of a block with a block number.

    Parameters

    • blockNumber: number

      The block number.

    Returns Promise<any>

sendSignedTransaction

  • sendSignedTransaction(signature, txBody, isDryrun?): Promise<any>

  • Sends a signed transaction to the network.

    Parameters

    • signature: string

      The signature of the transaction.

    • txBody: TransactionBody

      The transaction body.

    • isDryrun: boolean = false

      The dryrun option.

    Returns Promise<any>

sendTransaction

  • sendTransaction(transactionObject, isDryrun?): Promise<any>

  • Signs and sends a transaction to the network.

    Parameters

    • transactionObject: TransactionInput

      The transaction input object.

    • isDryrun: boolean = false

      The dryrun option.

    Returns Promise<any>

sendTransactionBatch

  • sendTransactionBatch(transactionObjects): Promise<any>

  • Signs and sends multiple transactions in a batch to the network.

    Parameters

    • transactionObjects: TransactionInput[]

      The list of the transaction input objects.

    Returns Promise<any>

setProvider

  • setProvider(providerUrl, eventHandlerUrl?, chainId?, axiosConfig?): void

  • Sets a new provider.

    Parameters

    • providerUrl: string

      The endpoint URL of the network provider. e.g. http://localhost:8081, https://testnet-api.ainetwork.ai

    • Optional eventHandlerUrl: null | string

      The endpoint URL of the event handler websocket server. e.g. ws://localhost:5100, wss://testnet-event.ainetwork.ai

    • Optional chainId: number

      The chain ID of the blockchain network. e.g. 0 for local or testnet, and 1 for mainnet

    • Optional axiosConfig: AxiosRequestConfig

      The axios request config.

    Returns void

setSigner

  • setSigner(signer): void

  • Sets a new signer.

    Parameters

    • signer: Signer

      The signer to set.

    Returns void

Private stakeFunction

  • stakeFunction(path, transactionObject, isDryrun?): Promise<any>

  • A base function for all staking related database changes. It builds a deposit/withdraw transaction and sends the transaction by calling sendTransaction().

    Parameters

    • path: string

      The path to set a value with.

    • transactionObject: ValueOnlyTransactionInput

      The transaction input object.

    • isDryrun: boolean = false

      The dryrun option.

    Returns Promise<any>

validateAppName

withdrawConsensusStake

  • withdrawConsensusStake(transactionObject): Promise<any>

  • Sends a transaction that withdraws AIN for consensus staking.

    Parameters

    Returns Promise<any>

Static instanceofTransactionBody

  • instanceofTransactionBody(object): object is TransactionBody

  • Checks whether an object is an instance of TransactionBody interface.

    Parameters

    • object: any

      The object to check.

    Returns object is TransactionBody

On This Page