PlasmaOperator¶
PlasmaOperator handles interaction with the plasma operator.
const PlasmaOperator = require('plasma-js-lib').PlasmaOperator
// Can replace the endpoint with the endpoint of your operator.
const operator = new PlasmaOperator('http://localhost:3000')
getBlockMetadata¶
operator.getBlockMetadata(start, end)
Returns metadata about a list of blocks.
Parameters¶
start-number: First block to query.end-number: Last block to query.
Returns¶
Promise<Array>: A list of metadata objects for each block.
Example¶
const blocks = await operator.getBlockMetadata(0, 3)
console.log(blocks)
> [ { blockNumber: '00000001',
rootHash: '0000000000000000000000000000000000000000000000000000000000000000',
timestamp: '0168c59834e8',
numTxs: '00' },
{ blockNumber: '00000002',
rootHash: '0000000000000000000000000000000000000000000000000000000000000000',
timestamp: '0168c5983bbe',
numTxs: '00' },
{ blockNumber: '00000003',
rootHash: '0000000000000000000000000000000000000000000000000000000000000000',
timestamp: '0168c5983fcf',
numTxs: '00' } ]
getBlockTransactions¶
operator.getBlockTransactions(block, start, end)
Returns the transactions in a specific block.
Queries all transactions between start and end.
Limited to 25 transactions at a time.
Parameters¶
block-number: Number of the block to query.start-number: First transaction to query.end-number: Last transaction to query.
Returns¶
Promise<Array>: A list of transaction objects.
getTransaction¶
operator.getTransaction(hash)
Returns a transaction by its hash.
Parameters¶
hash-string: Hash of the transaction to return.
Returns¶
Promise<SignedTransaction>: The transaction object.
Example¶
const transaction = await operator.getTransaction('0x7b6ced8ecd267f504f86b6cace13f078f936a20adc98b37fc83e1030f976e8e5')
console.log(transaction)
> SignedTransaction {
schema:
Schema {
unparsedFields:
{ block: [Object], transfers: [Object], signatures: [Object] },
fields:
{ block: [SchemaNumber],
transfers: [Schema],
signatures: [Schema] } },
block: <BN: 2>,
transfers:
[ { sender: '0x82A978B3f5962A5b0957d9ee9eEf472EE55B42F1',
recipient: '0x7d577a597B2742b498Cb5Cf0C26cDCD726d39E6e',
token: <BN: 0>,
start: <BN: 0>,
end: <BN: a> } ],
signatures: [] }
getRecentTransactions¶
operator.getRecentTransactions(start, end)
Returns a list of recent transactions.
Parameters¶
start-number: First transaction to query.end-number: Last transaction to query.
Returns¶
Promise<Array>: A list of transaction objects.
Example¶
const transactions = await operator.getRecentTransactions(0, 10)
console.log(transactions)
> [ SignedTransaction {
schema: Schema { unparsedFields: [Object], fields: [Object] },
block: <BN: 5>,
transfers: [ [Object] ],
signatures: [ [Object] ] },
SignedTransaction {
schema: Schema { unparsedFields: [Object], fields: [Object] },
block: <BN: 5>,
transfers: [ [Object] ],
signatures: [ [Object] ] },
SignedTransaction {
schema: Schema { unparsedFields: [Object], fields: [Object] },
block: <BN: 2>,
transfers: [ [Object] ],
signatures: [ [Object] ] } ]
getCurrentBlock¶
operator.getCurrentBlock()
Returns the current block number according to the operator.
Returns¶
Promise<number>: Current block number.
Example¶
const currentBlock = await operator.getCurrentBlock()
console.log(currentBlock)
> 6