@zilliqa-js/blockchain
Advanced tools
Classes for high-level interaction with the Zilliqa blockchain.
export interface BlockchainInfo {
NumPeers: number;
NumTxBlocks: string;
NumDSBlocks: string;
NumTransactions: string;
TransactionRate: number;
TxBlockRate: number;
DSBlockRate: number;
CurrentMiniEpoch: string;
CurrentDSEpoch: string;
NumTxnsDSEpoch: string;
NumTxnsTxEpoch: number;
ShardingStructure: ShardingStructure;
}
export interface ShardingStructure {
NumPeers: number[];
}
export interface TransactionObj {
ID: string;
version: string;
nonce: number;
toAddr: string;
code: string;
data: string;
amount: string;
gasPrice: string;
gasLimit: string;
signature: string;
receipt: TransactionReceiptObj;
}
export interface DsBlockHeader {
blockNum: string;
difficulty: number;
leaderPubKey: string;
minerPubKey: string;
nonce: string;
prevhash: string;
// unix epoch
timestamp: string;
}
export interface DsBlockObj {
header: DsBlockHeader;
signature: string;
}
interface BlockShort {
BlockNum: number;
Hash: string;
}
export interface BlockList {
data: BlockShort[];
maxPages: number;
}
const enum TxBlockType {
MICRO,
FINAL,
}
export interface TxBlockHeader {
Type: TxBlockType;
Version: number;
GasLimit: string;
GasUsed: string;
Rewards: string;
PrevBlockHash: string;
BlockNum: string;
Timestamp: string;
TxnHash: string;
StateHash: string;
NumTxns: number;
NumMicroBlocks: number;
MinerPubKey: string;
DSBlockNum: string;
}
export interface TxBlockObj {
body: {
HeaderSign: string;
MicroBlockEmpty: number[];
MicroBlockHashes: string[];
};
header: TxBlockHeader;
}
export interface TxList {
number: number;
TxnHashes: string[];
}
export interface TransactionReceiptObj {
success: boolean;
cumulative_gas: string;
event_logs: EventLogEntry[];
}
export interface EventLogEntry {
address: string;
_eventname: string;
params: EventParam[];
}
export interface EventParam {
vname: string;
type: string;
value: string;
}
BlockchainClass that wraps http requests for blockchain-related RPC calls.
Blockchain(provider: Provider, signer: Wallet): BlockchainParameters
provider: Providersigner: WalletReturns
Blockchainprovider: Providersigner: WalletCreateTransaction(transaction : Transaction, maxAttempts? : number, interval? : interval) : Promise<Transaction>Creates a transaction and polls the lookup node for a transaction receipt. The transaction is considered to be lost if it is not confirmed within the timeout period.
Parameters
transaction: Transaction - the transaction objectattempts (Optional - default 20): number - the number of times to poll the lookup node for transaction receipt.interval (Optional - default 1000): number - the amount of time to wait between attempts. increases linearly (numAttempts * interval)Returns
Promise<Transaction> - the Transaction that has been signed and broadcasted to the network.createBatchTransaction(txList : Transaction[], maxAttempts? : number, interval? : interval) : Promise<Transaction[]>Sends a batch of signed transactions and polls the lookup node for a transaction receipt for each transaction. The transaction is considered to be lost if it is not confirmed within the timeout period.
Parameters
txList: Transaction[] - a list of transaction object already signedattempts (Optional - default 20): number - the number of times to poll the lookup node for transaction receipt.interval (Optional - default 1000): number - the amount of time to wait between attempts. increases linearly (numAttempts * interval)Returns
Promise<Transaction[]> - the list of Transaction that has been signed and broadcasted to the network.Note: Users may use signBatch to sign a list of unsigned Transaction and used the returned results as input for this method.
Example
// zilliqa, wallet obj declaration omitted for clarity
// prepare a list of transactions
let txList = [];
for (let i = 0; i < 2; i++) {
const tx = new Transaction(
{
version: 1,
toAddr: '0x1234567890123456789012345678901234567890',
amount: new BN(0),
gasPrice: new BN(1000),
gasLimit: Long.fromNumber(1000),
},
provider,
);
txList.push(tx);
}
// transactions has to be pre-signed
// broadcast to blockchain, pending for confirmation
const signedTxList = await wallet.signBatch(txList);
const batchResults = await blockchain.createBatchTransaction(signedTxList);
for (const confirmedTx of batchResults) {
console.log('The transaction id is: %o', confirmedTx.id);
console.log(`The transaction status is: %o\n`, confirmedTx.receipt);
}
createBatchTransactionWithoutConfirm(signedTxList : Transaction[]) : Promise<Transaction[]>Sends a batch of signed transactions to the blockchain. Does not poll the lookup node for a transaction receipt. Instead, a id is returned for each transaction. Users have to manually poll the blockchain using for e.g. GetTransaction with the id to get the latest transaction status.
Parameters
signedTxList: Transaction[] - a list of transaction object already signedReturns
Promise<Transaction[]> - the list of Transaction that has been broadcasted to the network.Note: Users may use signBatch to sign a list of unsigned Transaction and used the returned results as input for this method.
Example
// zilliqa, wallet obj declaration omitted for clarity
// prepare a list of transactions
let txList = [];
for (let i = 0; i < 2; i++) {
const tx = new Transaction(
{
version: 1,
toAddr: '0x1234567890123456789012345678901234567890',
amount: new BN(0),
gasPrice: new BN(1000),
gasLimit: Long.fromNumber(1000),
},
provider,
);
txList.push(tx);
}
const signedTxList = await wallet.signBatch(txList); // sign the list of transactions
const batchResults = await blockchain.createBatchTransactionWithoutConfirm(signedTxList); // send to blockchain without confirm
// get the transaction id
for (const tx of batchResults) {
console.log(tx.id);
}
getTransactionStatus(txHash: string): Promise<RPCResponse<TransactionStatusObj>Returns the status of a specified transaction. This API is available from Zilliqa V7.0.0 onwards and supports all transaction statuses (unconfirmed, confirmed, and rejected).
Parameters
txHash: string - Specified TX id to check for the status.Returns
Promise<RPCResponse<TransactionStatusObj> - Status code of the transaction. Refer to GetTransactionStatus for the full list of status code.Note: This API is available only on https://api.zilliqa.com/. It is disabled for community-hosted or private-hosted seed nodes.
getTxnBodiesForTxBlock(txBlock: number): Promise<RPCResponse<TransactionObj[], string>>Returns the validated transactions (in verbose form) included within a specified final transaction block.
Parameters
txBlock: number - Specified TX block number to return.Returns
Promise<RPCResponse<TransactionObj[], string>> - Validated transactions in verbose form.Note: This API is available for private seed nodes only. It is not accessible via the official public API services, i.e., https://api.zilliqa.com.
getBlockChainInfo(): Promise<RPCResponse<ShardingStructure, string>>Retrieves generally blockchain information, such as the number of nodes per shard.
Parameters
None
Returns
Promise<RPCResponse<ShardingStructure, string>>getDSBlock(blockNum: number): Promise<RPCResponse<DsBlockObj, string>>Queries the blockchain for a specific DS block, by number.
Parameters
blockNum: string - the DS block the retrieveReturns
Promise<RPCResponse<DsBlockObj, string>>getLatestDSBlock(): Promise<RPCResponse<DsBlockObj, string>>Gets the most recently confirmed DS block.
Parameters
None
Returns
Promise<RPCResponse<DsBlockObj, string>>getNumDSBlocks(): Promise<RPCResponse<string, string>>Queries the blockchain for the number of confirmed DS blocks in the chain.
Parameters
None
Returns
Promise<RPCResponse<string, string>> - use parseInt as the number is encoded as a string.getDSBlockRate(): Promise<RPCResponse<number, string>>Gets the ds blocks processed per second.
Parameters
None
Returns
Promise<RPCResponse<number, string>>getDSBlockListing(max: number): Promise<RPCResponse<BlockList, string>>Gets a paginated list of DS blocks.
Parameters
max: number - the maximum number of pages to retrieve
Returns
Promise<RPCResponse<BlockList, string>>getTxBlock(blockNum: number): Promise<RPCResponse<TxBlockObj, string>>Retrieves a TxBlock by number.
Parameters
blockNum: number - the tx block to retrieve.
Returns
Promise<RPCResponse<TxBlockObj, string>>getLatestTxBlock(): Promise<RPCResponse<TxBlockObj, string>>Gets the most recently confirmed Tx block.
Parameters
None
Returns
Promise<RPCResponse<DsBlockObj, string>>getNumTxBlocks(): Promise<RPCResponse<string, string>>Queries the blockchain for the number of confirmed Tx blocks in the chain.
Parameters
None
Returns
Promise<RPCResponse<string, string>> - use parseInt as the number is encoded as a string.getTxBlockRate(): Promise<RPCResponse<number, string>>Gets the Tx blocks processed per second.
Parameters
None
Returns
Promise<RPCResponse<number, string>>getTxBlockListing(max: number): Promise<RPCResponse<BlockList, string>>Gets a paginated list of Tx blocks.
Parameters
max: number - the maximum number of pages to retrieve
Returns
Promise<RPCResponse<BlockList, string>>getSmartContractCode(addr: string): Promise<RPCResponse<any, string>>Queries the blockchain for the smart contract's state. Note that this method will return the entire state of the smart contract. As a result, if you have a large amount of data stored in a smart contract do not use this method on a client. Instead, use a server-side layer to cache and proxy such queries.
Parameters
addr: string - the address of a smart contractReturns
Promise<RPCResponse<any, string>> - the Contract state.getSmartContractInit(addr: string): Promise<RPCResponse<Value[], string>>Queries the blockchain for the smart contract's init (a.k.a. immutable variables of a contract)
Parameters
addr: string - the address of a smart contractReturns
Promise<RPCResponse<Value[], string>> - the Contract Init.getSmartContractState(addr: string): Promise<RPCResponse<any, string>>Queries the blockchain for the smart contract's state. Note that this method will return the entire state of the smart contract. As a result, if you have a large amount of data stored in a smart contract do not use this method on a client. Instead, use a server-side layer to cache and proxy such queries.
Parameters
addr: string - the address of a smart contractReturns
Promise<RPCResponse<any, string>> - the Contract state.getSmartContractSubState(addr: string, variableName: string, indices: string[]): Promise<RPCResponse<any, string>>Queries the contract state, filtered by the variable names. This function is the filtered version of getSmartContractState. As getSubState performs the filtering, variableName of a field is required.
If the subState is not found, this returns a null response.
Parameters
addr: string - the address of a smart contractvariableName: string - the variable name within a stateindices : string[] - optional variable. If the variableName is a Map, an array of indices may be provided. See examples/ to see how to use this method.Returns
Promise<RPCResponse<any, string>> - the Contract Init.getSmartContracts(addr: string): Promise<RPCResponse<Omit<ContractObj, 'init' | 'abi'>, string>>Retrieves all smart contracts deployed by a user, including the address and the state. The response object is large, and is not recommended on client-side.
Parameters
addr: string - address of a walletReturns
Promise<RPCResponse<Omit<ContractObj, 'init' | 'abi'>, string>> - A contract addressgetContractAddressFromTransactionID(addr: string): Promise<RPCResponse<string, string>>Retrieves a smart contract address from the transaction ID.
Parameters
txHash: string - the transaction hashReturns
Promise<RPCResponse<string, string>> - A contract addressFAQs
Class(es) for interacting with the Zilliqa blockchain.
We found that @zilliqa-js/blockchain demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."