Skip to content

Commit

Permalink
client: allow past block numbers in RPC queries (#1598)
Browse files Browse the repository at this point in the history 
* client: allow block number arg in rpc

* client rpc: simplify result comparisons

* add getProof

Co-authored-by: Holger Drewes <Holger.Drewes@gmail.com>
  • Loading branch information
@ryanio @holgerd77
ryanio and holgerd77 authored Dec 14, 2021
1 parent 22bc187 commit fe50f4e
Show file tree
Hide file tree
Showing 21 changed files with 368 additions and 565 deletions.
168 changes: 53 additions & 115 deletions packages/client/lib/rpc/modules/eth.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,41 @@ const jsonRpcReceipt = async (
: undefined,
})

/**
* Get block by option
*/
const getBlockByOption = async (blockOpt: string, chain: Chain) => {
if (blockOpt === 'pending') {
throw {
code: INVALID_PARAMS,
message: `"pending" is not yet supported`,
}
}

let block: Block
const latest = chain.blocks.latest ?? (await chain.getLatestBlock())

if (blockOpt === 'latest') {
block = latest
} else if (blockOpt === 'earliest') {
block = await chain.getBlock(new BN(0))
} else {
const blockNumber = new BN(toBuffer(blockOpt))
if (blockNumber.eq(latest.header.number)) {
block = latest
} else if (blockNumber.gt(latest.header.number)) {
throw {
code: INVALID_PARAMS,
message: 'specified block greater than current height',
}
} else {
block = await chain.getBlock(blockNumber)
}
}

return block
}

/**
* eth_* RPC module
* @memberof module:rpc/modules
Expand Down Expand Up @@ -381,7 +416,6 @@ export class Eth {

/**
* Executes a new message call immediately without creating a transaction on the block chain.
* Currently only "latest" block is supported.
* @param params An array of two parameters:
* 1. The transaction object
* * from (optional) - The address the transaction is sent from
Expand All @@ -395,24 +429,14 @@ export class Eth {
*/
async call(params: [RpcTx, string]) {
const [transaction, blockOpt] = params
const block = await getBlockByOption(blockOpt, this._chain)

if (!this._vm) {
throw new Error('missing vm')
}

// use a copy of the vm in case new blocks are executed,
// and to not make any underlying changes during the call
const vm = this._vm.copy()

if (blockOpt !== 'latest') {
const latest = await vm.blockchain.getLatestHeader()
if (blockOpt !== bnToHex(latest.number)) {
throw {
code: INVALID_PARAMS,
message: `Currently only "latest" block supported`,
}
}
}
await vm.stateManager.setStateRoot(block.header.stateRoot)

if (!transaction.gas) {
// If no gas limit is specified use the last block gas limit as an upper bound.
Expand Down Expand Up @@ -448,7 +472,6 @@ export class Eth {
* The transaction will not be added to the blockchain.
* Note that the estimate may be significantly more than the amount of gas actually used by the transaction,
* for a variety of reasons including EVM mechanics and node performance.
* Currently only "latest" block is supported.
* @param params An array of two parameters:
* 1. The transaction object
* * from (optional) - The address the transaction is sent from
Expand All @@ -462,23 +485,14 @@ export class Eth {
*/
async estimateGas(params: [RpcTx, string]) {
const [transaction, blockOpt] = params
const block = await getBlockByOption(blockOpt, this._chain)

if (!this._vm) {
throw new Error('missing vm')
}

// use a copy of the vm in case new blocks are executed
const vm = this._vm.copy()

if (blockOpt !== 'latest') {
const latest = await vm.blockchain.getLatestHeader()
if (blockOpt !== bnToHex(latest.number)) {
throw {
code: INVALID_PARAMS,
message: `Currently only "latest" block supported`,
}
}
}
await vm.stateManager.setStateRoot(block.header.stateRoot)

if (!transaction.gas) {
// If no gas limit is specified use the last block gas limit as an upper bound.
Expand Down Expand Up @@ -506,33 +520,22 @@ export class Eth {

/**
* Returns the balance of the account at the given address.
* Currently only "latest" block is supported.
* @param params An array of two parameters:
* 1. address of the account
* 2. integer block number, or the string "latest", "earliest" or "pending"
*/
async getBalance(params: [string, string]) {
const [addressHex, blockOpt] = params
const address = Address.fromString(addressHex)
const block = await getBlockByOption(blockOpt, this._chain)

if (!this._vm) {
throw new Error('missing vm')
}

// use a copy of the vm in case new blocks are sync'd
const vm = this._vm.copy()

if (blockOpt !== 'latest') {
const latest = await vm.blockchain.getLatestHeader()
if (blockOpt !== bnToHex(latest.number)) {
throw {
code: INVALID_PARAMS,
message: `Currently only "latest" block supported`,
}
}
}

const address = Address.fromString(addressHex)
const account: Account = await vm.stateManager.getAccount(address)
await vm.stateManager.setStateRoot(block.header.stateRoot)
const account = await vm.stateManager.getAccount(address)
return bnToHex(account.balance)
}

Expand Down Expand Up @@ -564,34 +567,7 @@ export class Eth {
*/
async getBlockByNumber(params: [string, boolean]) {
const [blockOpt, includeTransactions] = params
const latest = this._chain.blocks.latest ?? (await this._chain.getLatestBlock())
let block: Block

if (blockOpt === 'pending') {
throw {
code: INVALID_PARAMS,
message: `"pending" is not yet supported`,
}
}

if (blockOpt === 'latest') {
block = latest
} else if (blockOpt === 'earliest') {
block = await this._chain.getBlock(new BN(0))
} else {
const blockNumber = new BN(toBuffer(blockOpt))
if (blockNumber.eq(latest.header.number)) {
block = latest
} else if (blockNumber.gt(latest.header.number)) {
throw {
code: INVALID_PARAMS,
message: 'specified block greater than current height',
}
} else {
block = await this._chain.getBlock(blockNumber)
}
}

const block = await getBlockByOption(blockOpt, this._chain)
return await jsonRpcBlock(block, this._chain, includeTransactions)
}

Expand All @@ -614,30 +590,20 @@ export class Eth {

/**
* Returns code of the account at the given address.
* Currently only "latest" block is supported.
* @param params An array of two parameters:
* 1. address of the account
* 2. integer block number, or the string "latest", "earliest" or "pending"
*/
async getCode(params: [string, string]) {
const [addressHex, blockOpt] = params
const block = await getBlockByOption(blockOpt, this._chain)

if (!this._vm) {
throw new Error('missing vm')
}

// use a copy of the vm in case new blocks are sync'd
const vm = this._vm.copy()

if (blockOpt !== 'latest') {
const latest = await vm.blockchain.getLatestHeader()
if (blockOpt !== bnToHex(latest.number)) {
throw {
code: INVALID_PARAMS,
message: `Currently only "latest" block supported`,
}
}
}
await vm.stateManager.setStateRoot(block.header.stateRoot)

const address = Address.fromString(addressHex)
const code = await vm.stateManager.getContractCode(address)
Expand All @@ -646,31 +612,21 @@ export class Eth {

/**
* Returns the value from a storage position at a given address.
* Currently only "latest" block is supported.
* @param params An array of three parameters:
* 1. address of the storage
* 2. integer of the position in the storage
* 3. integer block number, or the string "latest", "earliest" or "pending"
*/
async getStorageAt(params: [string, string, string]) {
const [addressHex, positionHex, blockOpt] = params
const block = await getBlockByOption(blockOpt, this._chain)

if (!this._vm) {
throw new Error('missing vm')
}

// use a copy of the vm in case new blocks are executed
const vm = this._vm.copy()

if (blockOpt !== 'latest') {
const latest = await vm.blockchain.getLatestHeader()
if (blockOpt !== bnToHex(latest.number)) {
throw {
code: INVALID_PARAMS,
message: `Currently only "latest" block supported`,
}
}
}
await vm.stateManager.setStateRoot(block.header.stateRoot)

const address = Address.fromString(addressHex)
const storageTrie = await (vm.stateManager as any)._getStorageTrie(address)
Expand Down Expand Up @@ -704,30 +660,20 @@ export class Eth {

/**
* Returns the number of transactions sent from an address.
* Currently only "latest" block is supported.
* @param params An array of two parameters:
* 1. address of the account
* 2. integer block number, or the string "latest", "earliest" or "pending"
*/
async getTransactionCount(params: [string, string]) {
const [addressHex, blockOpt] = params
const block = await getBlockByOption(blockOpt, this._chain)

if (!this._vm) {
throw new Error('missing vm')
}

// use a copy of the vm in case new blocks are executed
const vm = this._vm.copy()

if (blockOpt !== 'latest') {
const latest = await vm.blockchain.getLatestHeader()
if (blockOpt !== bnToHex(latest.number)) {
throw {
code: INVALID_PARAMS,
message: `Currently only "latest" block supported`,
}
}
}
await vm.stateManager.setStateRoot(block.header.stateRoot)

const address = Address.fromString(addressHex)
const account: Account = await vm.stateManager.getAccount(address)
Expand Down Expand Up @@ -974,23 +920,15 @@ export class Eth {
* @returns The {@link Proof}
*/
async getProof(params: [string, string[], string]): Promise<Proof> {
const [addressHex, slotsHex, blockOption] = params
const [addressHex, slotsHex, blockOpt] = params
const block = await getBlockByOption(blockOpt, this._chain)

if (!this._vm) {
throw new Error('missing vm')
}

// use a copy of the vm in case new blocks are executed
const vm = this._vm.copy()
if (blockOption !== 'latest') {
const latest = await vm.blockchain.getLatestHeader()
if (blockOption !== bnToHex(latest.number)) {
throw {
code: INVALID_PARAMS,
message: `Currently only "latest" block supported`,
}
}
}
await vm.stateManager.setStateRoot(block.header.stateRoot)

const address = Address.fromString(addressHex)
const slots = slotsHex.map((slotHex) => setLengthLeft(toBuffer(slotHex), 32))
Expand Down
Loading

0 comments on commit fe50f4e

Please sign in to comment.