Class: Client ​

Nimiq Albatross client that runs in browsers via WASM and is exposed to Javascript.

Usage: ​

js
import init, * as Nimiq from "./pkg/nimiq_web_client.js";

init().then(async () => {
    const config = new Nimiq.ClientConfiguration();
    const client = await config.instantiateClient();
    // ...
});

Constructors ​

new Client() ​

new Client(): Client

Returns ​

Client

Methods ​

addConsensusChangedListener() ​

addConsensusChangedListener(listener): Promise<number>

Adds an event listener for consensus-change events, such as when consensus is established or lost.

Parameters ​

• listener

Returns ​

Promise<number>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:801

addHeadChangedListener() ​

addHeadChangedListener(listener): Promise<number>

Adds an event listener for new blocks added to the blockchain.

Parameters ​

• listener

Returns ​

Promise<number>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:807

addPeerChangedListener() ​

addPeerChangedListener(listener): Promise<number>

Adds an event listener for peer-change events, such as when a new peer joins, or a peer leaves.

Parameters ​

• listener

Returns ​

Promise<number>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:813

addTransactionListener() ​

addTransactionListener(listener, addresses): Promise<number>

Adds an event listener for transactions to and from the provided addresses.

The listener is called for transactions when they are included in the blockchain.

Parameters ​

• listener

• addresses: (string | Uint8Array | Address)[]

Returns ​

Promise<number>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:822

free() ​

free(): void

Returns ​

void

Defined in ​

@nimiq/core/types/wasm/web.d.ts:789

getAccount() ​

getAccount(address): Promise<PlainAccount>

Fetches the account for the provided address from the network.

Throws if the address cannot be parsed and on network errors.

Parameters ​

• address: string | Uint8Array | Address

Returns ​

Promise<PlainAccount>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:895

getAccounts() ​

getAccounts(addresses): Promise<PlainAccount[]>

Fetches the accounts for the provided addresses from the network.

Throws if an address cannot be parsed and on network errors.

Parameters ​

• addresses: (string | Uint8Array | Address)[]

Returns ​

Promise<PlainAccount[]>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:903

getAddressBook() ​

getAddressBook(): Promise<PlainPeerInfo[]>

Returns the current address books peers. Each peer will have one address and currently no guarantee for the usefulness of that address can be given.

The resulting Array may be empty if there is no peers in the address book.

Returns ​

Promise<PlainPeerInfo[]>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:867

getBlock() ​

getBlock(hash): Promise<PlainBlock>

Fetches a block by its hash.

Throws if the client does not have the block.

Fetching blocks from the network is not yet available.

Parameters ​

• hash: string

Returns ​

Promise<PlainBlock>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:877

getBlockAt() ​

getBlockAt(height): Promise<PlainBlock>

Fetches a block by its height (block number).

Throws if the client does not have the block.

Fetching blocks from the network is not yet available.

Parameters ​

• height: number

Returns ​

Promise<PlainBlock>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:887

getHeadBlock() ​

getHeadBlock(): Promise<PlainBlock>

Returns the current blockchain head block. Note that the web client is a light client and does not have block bodies, i.e. no transactions.

Returns ​

Promise<PlainBlock>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:859

getHeadHash() ​

getHeadHash(): Promise<string>

Returns the block hash of the current blockchain head.

Returns ​

Promise<string>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:848

getHeadHeight() ​

getHeadHeight(): Promise<number>

Returns the block number of the current blockchain head.

Returns ​

Promise<number>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:853

getNetworkId() ​

getNetworkId(): Promise<number>

Returns the network ID that the client is connecting to.

Returns ​

Promise<number>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:833

getStaker() ​

getStaker(address): Promise<PlainStaker>

Fetches the staker for the provided address from the network.

Throws if the address cannot be parsed and on network errors.

Parameters ​

• address: string | Uint8Array | Address

Returns ​

Promise<PlainStaker>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:911

getStakers() ​

getStakers(addresses): Promise<PlainStaker[]>

Fetches the stakers for the provided addresses from the network.

Throws if an address cannot be parsed and on network errors.

Parameters ​

• addresses: (string | Uint8Array | Address)[]

Returns ​

Promise<PlainStaker[]>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:919

getTransaction() ​

getTransaction(hash): Promise<PlainTransactionDetails>

Fetches the transaction details for the given transaction hash.

Parameters ​

• hash: string

Returns ​

Promise<PlainTransactionDetails>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:949

getTransactionReceiptsByAddress() ​

getTransactionReceiptsByAddress(address, limit?, min_peers?): Promise<PlainTransactionReceipt[]>

This function is used to query the network for transaction receipts from and to a specific address, that have been included in the chain.

The obtained receipts are not verified before being returned.

Up to a limit number of transaction receipts are returned from newest to oldest. If the network does not have at least min_peers to query, then an error is returned.

Parameters ​

• address: string | Uint8Array | Address

• limit?: number

• min_peers?: number

Returns ​

Promise<PlainTransactionReceipt[]>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:963

getTransactionsByAddress() ​

getTransactionsByAddress(address, since_block_height?, known_transaction_details?, limit?, min_peers?): Promise<PlainTransactionDetails[]>

This function is used to query the network for transactions from and to a specific address, that have been included in the chain.

The obtained transactions are verified before being returned.

If you already have transactions belonging to this address, you can provide some of that information to reduce the amount of network requests made:

  • Provide the since_block_height parameter to exclude any history from before that block height. You should be completely certain about its state. This should not be the last known block height, but an earlier block height that could not have been forked from (e.g. the last known election or checkpoint block).
  • Provide a list of known_transaction_details to have them verified and/or broadcasted again.

Up to a limit number of transactions are returned from newest to oldest. If the network does not have at least min_peers to query, an error is returned.

Parameters ​

• address: string | Uint8Array | Address

• since_block_height?: number

• known_transaction_details?: PlainTransactionDetails[]

• limit?: number

• min_peers?: number

Returns ​

Promise<PlainTransactionDetails[]>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:988

getValidator() ​

getValidator(address): Promise<PlainValidator>

Fetches the validator for the provided address from the network.

Throws if the address cannot be parsed and on network errors.

Parameters ​

• address: string | Uint8Array | Address

Returns ​

Promise<PlainValidator>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:927

getValidators() ​

getValidators(addresses): Promise<PlainValidator[]>

Fetches the validators for the provided addresses from the network.

Throws if an address cannot be parsed and on network errors.

Parameters ​

• addresses: (string | Uint8Array | Address)[]

Returns ​

Promise<PlainValidator[]>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:935

isConsensusEstablished() ​

isConsensusEstablished(): Promise<boolean>

Returns if the client currently has consensus with the network.

Returns ​

Promise<boolean>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:838

removeListener() ​

removeListener(handle): Promise<void>

Removes an event listener by its handle.

Parameters ​

• handle: number

Returns ​

Promise<void>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:828

sendTransaction() ​

sendTransaction(transaction): Promise<PlainTransactionDetails>

Sends a transaction to the network and returns PlainTransactionDetails.

Throws in case of network errors.

Parameters ​

• transaction: string | Uint8Array | PlainTransaction | Transaction

Returns ​

Promise<PlainTransactionDetails>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:943

waitForConsensusEstablished() ​

waitForConsensusEstablished(): Promise<void>

Returns a promise that resolves when the client has established consensus with the network.

Returns ​

Promise<void>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:843

create() ​

static create(config): Promise<Client>

Creates a new Client that automatically starts connecting to the network.

Parameters ​

• config: PlainClientConfiguration

Returns ​

Promise<Client>

Defined in ​

@nimiq/core/types/wasm/web.d.ts:795