# Nimbus # Copyright (c) 2018 Status Research & Development GmbH # Licensed under either of # * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE)) # * MIT license ([LICENSE-MIT](LICENSE-MIT)) # at your option. # This file may not be copied, modified, or distributed except according to # those terms. import nimcrypto, json_rpc/rpcserver, eth_p2p, hexstrings, strutils, stint, ../config, ../vm_state, ../constants, eth_trie/[memdb, types], eth_keys, ../db/[db_chain, state_db, storage_types], eth_common, rpc_types, byteutils, ranges/typedranges, times, ../utils/header, rlp #[ Note: * Hexstring types (HexQuantitySt, HexDataStr, EthAddressStr, EthHashStr) are parsed to check format before the RPC blocks are executed and will raise an exception if invalid. * Many of the RPC calls do not validate hex string types when output, only type cast to avoid extra processing. ]# # Work around for https://github.com/nim-lang/Nim/issues/8645 proc `%`*(value: Time): JsonNode = result = %value.toSeconds func strToAddress(value: string): EthAddress = hexToPaddedByteArray[20](value) func toHash(value: array[32, byte]): Hash256 {.inline.} = result.data = value func strToHash(value: string): Hash256 {.inline.} = result = hexToPaddedByteArray[32](value).toHash func headerFromTag(chain:BaseChainDB, blockTag: string): BlockHeader = let tag = blockTag.toLowerAscii case tag of "latest": result = chain.getCanonicalHead() of "earliest": result = chain.getBlockHeader(GENESIS_BLOCK_NUMBER) of "pending": #TODO: Implement get pending block raise newException(ValueError, "Pending tag not yet implemented") else: # Raises are trapped and wrapped in JSON when returned to the user. tag.validateHexQuantity let blockNum = stint.fromHex(UInt256, tag) result = chain.getBlockHeader(blockNum) proc setupP2PRPC*(node: EthereumNode, rpcsrv: RpcServer) = template chain: untyped = BaseChainDB(node.chain) # TODO: Sensible casting proc getAccountDb(readOnly = true): AccountStateDb = ## Retrieves the account db from canonical head let header = chain.getCanonicalHead() vmState = newBaseVMState(header, chain) result = vmState.chaindb.getStateDb(vmState.blockHeader.hash, readOnly) proc getAccountDbFromTag(tag: string, readOnly = true): AccountStateDb = let header = chain.headerFromTag(tag) vmState = newBaseVMState(header, chain) result = vmState.chaindb.getStateDb(vmState.blockHeader.hash, readOnly) rpcsrv.rpc("net_version") do() -> uint: let conf = getConfiguration() result = conf.net.networkId rpcsrv.rpc("eth_syncing") do() -> JsonNode: ## Returns SyncObject or false when not syncing. # TODO: Requires PeerPool to check sync state. # TODO: Use variant objects var res: JsonNode sync: SyncState if true: # TODO: Populate sync state, this is a placeholder sync.startingBlock = GENESIS_BLOCK_NUMBER sync.currentBlock = chain.getCanonicalHead().blockNumber sync.highestBlock = chain.getCanonicalHead().blockNumber result = %sync else: result = newJBool(false) rpcsrv.rpc("eth_coinbase") do() -> EthAddress: ## Returns the current coinbase address. result = chain.getCanonicalHead().coinbase rpcsrv.rpc("eth_mining") do() -> bool: ## Returns true if the client is mining, otherwise false. discard rpcsrv.rpc("eth_hashrate") do() -> int: ## Returns the number of hashes per second that the node is mining with. discard rpcsrv.rpc("eth_gasPrice") do() -> int64: ## Returns an integer of the current gas price in wei. discard rpcsrv.rpc("eth_accounts") do() -> seq[EthAddressStr]: ## Returns a list of addresses owned by client. result = @[] rpcsrv.rpc("eth_blockNumber") do() -> BlockNumber: ## Returns integer of the current block number the client is on. result = chain.getCanonicalHead().blockNumber rpcsrv.rpc("eth_getBalance") do(data: EthAddressStr, quantityTag: string) -> int: ## Returns the balance of the account of given address. ## ## data: address to check for balance. ## quantityTag: integer block number, or the string "latest", "earliest" or "pending", see the default block parameter. ## Returns integer of the current balance in wei. let accountDb = getAccountDbFromTag(quantityTag) addrBytes = strToAddress(data.string) balance = accountDb.get_balance(addrBytes) result = balance.toInt rpcsrv.rpc("eth_getStorageAt") do(data: EthAddressStr, quantity: int, quantityTag: string) -> UInt256: ## Returns the value from a storage position at a given address. ## ## data: address of the storage. ## quantity: integer of the position in the storage. ## quantityTag: integer block number, or the string "latest", "earliest" or "pending", see the default block parameter. ## Returns: the value at this storage position. let accountDb = getAccountDbFromTag(quantityTag) addrBytes = strToAddress(data.string) storage = accountDb.getStorage(addrBytes, quantity.u256) if storage[1]: result = storage[0] rpcsrv.rpc("eth_getTransactionCount") do(data: EthAddressStr, quantityTag: string) -> UInt256: ## Returns the number of transactions sent from an address. ## ## data: address. ## quantityTag: integer block number, or the string "latest", "earliest" or "pending", see the default block parameter. ## Returns integer of the number of transactions send from this address. let addrBytes = data.string.strToAddress() accountDb = getAccountDbFromTag(quantityTag) result = accountDb.getNonce(addrBytes) rpcsrv.rpc("eth_getBlockTransactionCountByHash") do(data: HexDataStr) -> int: ## Returns the number of transactions in a block from a block matching the given block hash. ## ## data: hash of a block ## Returns integer of the number of transactions in this block. var hashData = strToHash(data.string) let body = chain.getBlockBody(hashData) if body == nil: raise newException(ValueError, "Cannot find hash") result = body.transactions.len rpcsrv.rpc("eth_getBlockTransactionCountByNumber") do(quantityTag: string) -> int: ## Returns the number of transactions in a block matching the given block number. ## ## data: integer of a block number, or the string "earliest", "latest" or "pending", as in the default block parameter. ## Returns integer of the number of transactions in this block. let header = chain.headerFromTag(quantityTag) accountDb = getAccountDbFromTag(quantityTag) body = chain.getBlockBody(header.hash) if body == nil: raise newException(ValueError, "Cannot find hash") result = body.transactions.len rpcsrv.rpc("eth_getUncleCountByBlockHash") do(data: HexDataStr) -> int: ## Returns the number of uncles in a block from a block matching the given block hash. ## ## data: hash of a block. ## Returns integer of the number of uncles in this block. var hashData = strToHash(data.string) let body = chain.getBlockBody(hashData) if body == nil: raise newException(ValueError, "Cannot find hash") result = body.uncles.len rpcsrv.rpc("eth_getUncleCountByBlockNumber") do(quantityTag: string) -> int: ## Returns the number of uncles in a block from a block matching the given block number. ## ## quantityTag: integer of a block number, or the string "latest", "earliest" or "pending", see the default block parameter. ## Returns integer of uncles in this block. let header = chain.headerFromTag(quantityTag) body = chain.getBlockBody(header.hash) if body == nil: raise newException(ValueError, "Cannot find hash") result = body.uncles.len rpcsrv.rpc("eth_getCode") do(data: EthAddressStr, quantityTag: string) -> HexDataStr: ## Returns code at a given address. ## ## data: address ## quantityTag: integer block number, or the string "latest", "earliest" or "pending", see the default block parameter. ## Returns the code from the given address. let accountDb = getAccountDbFromTag(quantityTag) addrBytes = strToAddress(data.string) storage = accountDb.getCode(addrBytes) # Easier to return the string manually here rather than expect ByteRange to be marshalled result = byteutils.toHex(storage.toOpenArray).HexDataStr template sign(privateKey: PrivateKey, message: string): string = # TODO: Is message length encoded as bytes or characters? let msgData = "\x19Ethereum Signed Message:\n" & $message.len & message $signMessage(privateKey, msgData) rpcsrv.rpc("eth_sign") do(data: EthAddressStr, message: HexDataStr) -> HexDataStr: ## The sign method calculates an Ethereum specific signature with: sign(keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))). ## By adding a prefix to the message makes the calculated signature recognisable as an Ethereum specific signature. ## This prevents misuse where a malicious DApp can sign arbitrary data (e.g. transaction) and use the signature to impersonate the victim. ## Note the address to sign with must be unlocked. ## ## data: address. ## message: message to sign. ## Returns signature. let accountDb = getAccountDb(true) var privateKey: PrivateKey # TODO: Get from key store result = ("0x" & sign(privateKey, message.string)).HexDataStr rpcsrv.rpc("eth_sendTransaction") do(obj: EthSend) -> HexDataStr: ## Creates new message call transaction or a contract creation, if the data field contains code. ## ## obj: the transaction object. ## Returns the transaction hash, or the zero hash if the transaction is not yet available. ## Note: Use eth_getTransactionReceipt to get the contract address, after the transaction was mined, when you created a contract. discard rpcsrv.rpc("eth_sendRawTransaction") do(data: string, quantityTag: int) -> HexDataStr: ## Creates new message call transaction or a contract creation for signed transactions. ## ## data: the signed transaction data. ## Returns the transaction hash, or the zero hash if the transaction is not yet available. ## Note: Use eth_getTransactionReceipt to get the contract address, after the transaction was mined, when you created a contract. discard rpcsrv.rpc("eth_call") do(call: EthCall, quantityTag: string) -> HexDataStr: ## Executes a new message call immediately without creating a transaction on the block chain. ## ## call: the transaction call object. ## quantityTag: integer block number, or the string "latest", "earliest" or "pending", see the default block parameter. ## Returns the return value of executed contract. discard rpcsrv.rpc("eth_estimateGas") do(call: EthCall, quantityTag: string) -> HexDataStr: # TODO: Int or U/Int256? ## Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. ## 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. ## ## call: the transaction call object. ## quantityTag: integer block number, or the string "latest", "earliest" or "pending", see the default block parameter. ## Returns the amount of gas used. discard func populateBlockObject(header: BlockHeader, blockBody: BlockBodyRef): BlockObject = result.number = new BlockNumber result.number[] = header.blockNumber result.hash = new Hash256 result.hash[] = header.hash result.parentHash = header.parentHash result.nonce = header.nonce.toUint # Calculate hash for all uncle headers var rawdata = newSeq[byte](blockBody.uncles.len * 32) startIdx = 0 for i in 0 ..< blockBody.uncles.len: rawData[startIdx .. startIdx + 32] = blockBody.uncles[i].hash.data startIdx += 32 result.sha3Uncles = keccak256.digest(rawData) result.logsBloom = nil # TODO: Create bloom filter for logs result.transactionsRoot = header.txRoot result.stateRoot = header.stateRoot result.receiptsRoot = header.receiptRoot result.miner = ZERO_ADDRESS # TODO: Get miner address result.difficulty = header.difficulty result.totalDifficulty = header.difficulty # TODO: Calculate result.extraData = header.extraData result.size = 0 # TODO: Calculate block size result.gasLimit = header.gasLimit result.gasUsed = header.gasUsed result.timestamp = header.timeStamp result.transactions = blockBody.transactions result.uncles = @[] for i in 0 ..< blockBody.uncles.len: result.uncles[i] = blockBody.uncles[i].hash rpcsrv.rpc("eth_getBlockByHash") do(data: HexDataStr, fullTransactions: bool) -> BlockObject: ## Returns information about a block by hash. ## ## data: Hash of a block. ## fullTransactions: If true it returns the full transaction objects, if false only the hashes of the transactions. ## Returns BlockObject or nil when no block was found. let h = data.string.strToHash header = chain.getBlockHeader(h) body = chain.getBlockBody(h) if body == nil: raise newException(ValueError, "Cannot find hash") populateBlockObject(header, body) rpcsrv.rpc("eth_getBlockByNumber") do(quantityTag: string, fullTransactions: bool) -> BlockObject: ## Returns information about a block by block number. ## ## quantityTag: integer of a block number, or the string "earliest", "latest" or "pending", as in the default block parameter. ## fullTransactions: If true it returns the full transaction objects, if false only the hashes of the transactions. ## Returns BlockObject or nil when no block was found. let header = chain.headerFromTag(quantityTag) body = chain.getBlockBody(header.hash) if body == nil: raise newException(ValueError, "Cannot find hash") populateBlockObject(header, body) func populateTransactionObject(transaction: Transaction, txHash: Hash256, txCount: UInt256, txIndex: int, blockHeader: BlockHeader, gas: int64): TransactionObject = result.hash = txHash result.nonce = txCount result.blockHash = new Hash256 result.blockHash[] = blockHeader.hash result.blockNumber = new BlockNumber result.blockNumber[] = blockHeader.blockNumber result.transactionIndex = new int64 result.transactionIndex[] = txIndex # TODO: Fetch or calculate `from` address with signature after signing with the private key #result.source: EthAddress result.to = new EthAddress result.to[] = transaction.to result.value = transaction.value result.gasPrice = transaction.gasPrice result.gas = gas result.input = transaction.payload rpcsrv.rpc("eth_getTransactionByHash") do(data: HexDataStr) -> TransactionObject: ## Returns the information about a transaction requested by transaction hash. ## ## data: hash of a transaction. ## Returns requested transaction information. let h = data.string.strToHash() txDetails = chain.getTransactionKey(h) header = chain.getBlockHeader(txDetails.blockNumber) blockHash = chain.getBlockHash(txDetails.blockNumber) body = chain.getBlockBody(blockHash) if body == nil: raise newException(ValueError, "Cannot find hash") let transaction = body.transactions[txDetails.index] vmState = newBaseVMState(header, chain) addressDb = vmState.chaindb.getStateDb(blockHash, true) # TODO: Get/calculate address for this transaction address = ZERO_ADDRESS txCount = addressDb.getNonce(address) txHash = transaction.rlpHash # TODO: Fetch account gas accountGas = 0 populateTransactionObject(transaction, txHash, txCount, txDetails.index, header, accountGas) rpcsrv.rpc("eth_getTransactionByBlockHashAndIndex") do(data: HexDataStr, quantity: int) -> TransactionObject: ## Returns information about a transaction by block hash and transaction index position. ## ## data: hash of a block. ## quantity: integer of the transaction index position. ## Returns requested transaction information. let blockHash = data.string.strToHash() body = chain.getBlockBody(blockHash) if body == nil: raise newException(ValueError, "Cannot find hash") let header = chain.getBlockHeader(blockHash) transaction = body.transactions[quantity] vmState = newBaseVMState(header, chain) addressDb = vmState.chaindb.getStateDb(blockHash, true) # TODO: Get/calculate address for this transaction address = ZERO_ADDRESS txCount = addressDb.getNonce(address) txHash = transaction.rlpHash # TODO: Fetch account gas accountGas = 0 populateTransactionObject(transaction, txHash, txCount, quantity, header, accountGas) rpcsrv.rpc("eth_getTransactionByBlockNumberAndIndex") do(quantityTag: string, quantity: int) -> TransactionObject: ## Returns information about a transaction by block number and transaction index position. ## ## quantityTag: a block number, or the string "earliest", "latest" or "pending", as in the default block parameter. ## quantity: the transaction index position. let header = chain.headerFromTag(quantityTag) blockHash = header.hash body = chain.getBlockBody(blockHash) if body == nil: raise newException(ValueError, "Cannot find hash") let transaction = body.transactions[quantity] vmState = newBaseVMState(header, chain) addressDb = vmState.chaindb.getStateDb(blockHash, true) # TODO: Get/calculate address for this transaction address = ZERO_ADDRESS txCount = addressDb.getNonce(address) txHash = transaction.rlpHash # TODO: Fetch account gas accountGas = 0 populateTransactionObject(transaction, txHash, txCount, quantity, header, accountGas) template toSignature(transaction: Transaction): Signature = var bytes: array[65, byte] bytes[0..31] = cast[array[32, byte]](transaction.R) bytes[32..63] = cast[array[32, byte]](transaction.S) #[ TODO: In the yellow paper: It is assumed that v is the ‘recovery id’, a 1 byte value specifying the sign and finiteness of the curve point; this value is in the range of [27,30]. Does this need to be checked that it is [0, 1] and inc by 27? ]# # TODO: Ugly casting below, is there a better way/helper func? bytes[64] = (cast[uint64](transaction.V.data.lo) and 0xff'u64).uint8 initSignature(bytes) proc getSender(transaction: Transaction): EthAddress = let txHash = transaction.rlpHash sig = transaction.toSignature() pubKey = recoverKeyFromSignature(sig, txHash) const pubKeySize = 64 result[0..19] = pubKey.data[pubKeySize - 20 .. pubKeySize - 1] proc populateReceipt(receipt: Receipt, cumulativeGas: GasInt, transaction: Transaction, txIndex: int, blockHeader: BlockHeader): ReceiptObject = result.transactionHash = transaction.rlpHash result.transactionIndex = txIndex result.blockHash = blockHeader.hash result.blockNumber = blockHeader.blockNumber # TODO: Get sender #result.sender: EthAddress result.to = new EthAddress result.to[] = transaction.to result.cumulativeGasUsed = cumulativeGas result.gasUsed = receipt.gasUsed # TODO: Get contract address if the transaction was a contract creation. result.contractAddress = nil result.logs = receipt.logs result.logsBloom = blockHeader.bloom # post-transaction stateroot (pre Byzantium). result.root = blockHeader.stateRoot # TODO: Respond to success/failure # 1 = success, 0 = failure. result.status = 1 rpcsrv.rpc("eth_getTransactionReceipt") do(data: HexDataStr) -> ReceiptObject: ## Returns the receipt of a transaction by transaction hash. ## ## data: hash of a transaction. ## Returns transaction receipt. let h = data.string.strToHash() txDetails = chain.getTransactionKey(h) header = chain.getBlockHeader(txDetails.blockNumber) body = chain.getBlockBody(h) if body == nil: raise newException(ValueError, "Cannot find hash") var idx = 0 cumulativeGas: GasInt for receipt in chain.getReceipts(header, Receipt): cumulativeGas += receipt.gasUsed if idx == txDetails.index: return populateReceipt(receipt, cumulativeGas, body.transactions[txDetails.index], txDetails.index, header) idx.inc rpcsrv.rpc("eth_getUncleByBlockHashAndIndex") do(data: HexDataStr, quantity: int) -> BlockObject: ## Returns information about a uncle of a block by hash and uncle index position. ## ## data: hash of block. ## quantity: the uncle's index position. ## Returns BlockObject or nil when no block was found. let blockHash = data.string.strToHash() body = chain.getBlockBody(blockHash) if body == nil: raise newException(ValueError, "Cannot find hash") if quantity < 0 or quantity >= body.uncles.len: raise newException(ValueError, "Uncle index out of range") let uncle = body.uncles[quantity] result = populateBlockObject(uncle, body) rpcsrv.rpc("eth_getUncleByBlockNumberAndIndex") do(quantityTag: string, quantity: int) -> BlockObject: # Returns information about a uncle of a block by number and uncle index position. ## ## quantityTag: a block number, or the string "earliest", "latest" or "pending", as in the default block parameter. ## quantity: the uncle's index position. ## Returns BlockObject or nil when no block was found. let header = chain.headerFromTag(quantityTag) body = chain.getBlockBody(header.hash) if body == nil: raise newException(ValueError, "Cannot find hash") if quantity < 0 or quantity >= body.uncles.len: raise newException(ValueError, "Uncle index out of range") let uncle = body.uncles[quantity] result = populateBlockObject(uncle, body) rpcsrv.rpc("eth_newFilter") do(filterOptions: FilterOptions) -> int: ## Creates a filter object, based on filter options, to notify when the state changes (logs). ## To check if the state has changed, call eth_getFilterChanges. ## Topics are order-dependent. A transaction with a log with topics [A, B] will be matched by the following topic filters: ## [] "anything" ## [A] "A in first position (and anything after)" ## [null, B] "anything in first position AND B in second position (and anything after)" ## [A, B] "A in first position AND B in second position (and anything after)" ## [[A, B], [A, B]] "(A OR B) in first position AND (A OR B) in second position (and anything after)" ## ## filterOptions: settings for this filter. ## Returns integer filter id. discard rpcsrv.rpc("eth_newBlockFilter") do() -> int: ## Creates a filter in the node, to notify when a new block arrives. ## To check if the state has changed, call eth_getFilterChanges. ## ## Returns integer filter id. discard rpcsrv.rpc("eth_newPendingTransactionFilter") do() -> int: ## Creates a filter in the node, to notify when a new block arrives. ## To check if the state has changed, call eth_getFilterChanges. ## ## Returns integer filter id. discard rpcsrv.rpc("eth_uninstallFilter") do(filterId: int) -> bool: ## Uninstalls a filter with given id. Should always be called when watch is no longer needed. ## Additonally Filters timeout when they aren't requested with eth_getFilterChanges for a period of time. ## ## filterId: The filter id. ## Returns true if the filter was successfully uninstalled, otherwise false. discard rpcsrv.rpc("eth_getFilterChanges") do(filterId: int) -> seq[FilterLog]: ## Polling method for a filter, which returns an list of logs which occurred since last poll. ## ## filterId: the filter id. result = @[] rpcsrv.rpc("eth_getFilterLogs") do(filterId: int) -> seq[FilterLog]: ## filterId: the filter id. ## Returns a list of all logs matching filter with given id. result = @[] rpcsrv.rpc("eth_getLogs") do(filterOptions: FilterOptions) -> seq[FilterLog]: ## filterOptions: settings for this filter. ## Returns a list of all logs matching a given filter object. result = @[] rpcsrv.rpc("eth_getWork") do() -> array[3, UInt256]: ## Returns the hash of the current block, the seedHash, and the boundary condition to be met ("target"). ## Returned list has the following properties: ## DATA, 32 Bytes - current block header pow-hash. ## DATA, 32 Bytes - the seed hash used for the DAG. ## DATA, 32 Bytes - the boundary condition ("target"), 2^256 / difficulty. discard rpcsrv.rpc("eth_submitWork") do(nonce: int64, powHash: HexDataStr, mixDigest: HexDataStr) -> bool: ## Used for submitting a proof-of-work solution. ## ## nonce: the nonce found. ## headerPow: the header's pow-hash. ## mixDigest: the mix digest. ## Returns true if the provided solution is valid, otherwise false. discard rpcsrv.rpc("eth_submitHashrate") do(hashRate: HexDataStr, id: HexDataStr) -> bool: ## Used for submitting mining hashrate. ## ## hashRate: a hexadecimal string representation (32 bytes) of the hash rate. ## id: a random hexadecimal(32 bytes) ID identifying the client. ## Returns true if submitting went through succesfully and false otherwise. discard