chainlib-eth

Ethereum implementation of the chainlib interface
Info | Log | Files | Refs | README | LICENSE

README.md (1961B)

      1 # chainlib-eth
      2 
      3 # Overview
      4 
      5 This is the Ethereum (EVM) implementation of the `chainlib` block
      6 interface.
      7 
      8 It contains implementations for:
      9 
     10 - RPC client implementation.
     11 
     12 - Nonce and fee generators.
     13 
     14 - Transaction and block objects.
     15 
     16 - EVM ABI encoding and decoding.
     17 
     18 - CLI tool suite for common operations.
     19 
     20 Please refer to the documentation for the `chainlib` package to achieve
     21 a broader context of what `chainlib-eth implements`.
     22 
     23 # CLI tooling
     24 
     25 When installed, the python package `chainlib-eth` will install a
     26 selection of CLI tools in the python executable script path.
     27 
     28 It will also install man pages for each tool in the man path. The man
     29 pages describe arguments, configurations and environment variables
     30 relevant for each tool. They will not be repeated here.
     31 
     32 The man pages have been generated using the `chainlib-man.py` script
     33 from the `chainlib` package. Please refer to the `chainlib` package
     34 documentation for further details on the logical structure of the
     35 applicable arguments.
     36 
     37 `eth-balance`  
     38 Gas token balance of a specific address.
     39 
     40 `eth-block`  
     41 Retrieve a block by number or hash.
     42 
     43 `eth-checksum`  
     44 Transform an ethereum address to a checksummed address.
     45 
     46 `eth-count`  
     47 Get the amount of confirmed transactions on network for an account.
     48 Corresponds to the nonce of the next future transaction.
     49 
     50 `eth-decode`  
     51 Decode a transaction from its serialized (wire) format.
     52 
     53 `eth-encode`  
     54 Sncode method calls and/or individual arguments for the EVM ABI. Can be
     55 used to interface with smart contracts and generate constructor
     56 arguments.
     57 
     58 `eth-gas`  
     59 Generate transactions for private accounts and smart contracts, with or
     60 without gas token value.
     61 
     62 `eth-get`  
     63 Retrieve a transaction, or bytecode for an address.
     64 
     65 `eth-info`  
     66 Retrieve general stats for a blockchain network.
     67 
     68 `eth-raw`  
     69 Covert a signed wire format transaction to raw transaction for RPC.
     70 
     71 `eth-wait`  
     72 Block until transaction has been completed (transaction "receipt"
     73 exists).