muyinliu / web3.lisp

Ethereum JSONRPC Common Lisp API

Web3.lisp

A common lisp client library to communicate with Ethereum RPC server.

Inspire and steal from https://github.com/tsikov/ethi

Usage

1. Clone to somewhere quicklisp can find, such as /quicklisp/local-projects
2. Run (ql:quickload :web3) in lisp repl to load it
3. In repl

Demo1: call web3_clientVersion with http

;; set global web3:*provider*, then call method

(setf web3:*provider* (make-instance 'web3:HTTPProvider :uri "http://localhost:8545"))

(web3:web3/client-version)


;; Or pass provider as key argument

(web3/client-version :key provider (make-instance 'web3:HTTPProvider :uri "http://localhost:8545"))

Demo2: call web3_clientVersion with ipc

;; set global web3:*provider*, then call method

(setf web3:*provider* (make-instance 'web3:IPCProvider :uri "/path/to/geth.ipc"))

(web3:web3/client-version)


;; Or pass provider as key argument

(web3/client-version :key provider (make-instance 'web3:IPCProvider :uri "/path/to/geth.ipc"))

You can check examples in test code tests/web.lisp.

Run test

To run the tests locally you will need to run a local private testnet.

1. Install geth

2. cd to the project's directory and start it with:

   ;; First, init genesis block

   geth --rpc --nodiscover --maxpeers 0 --datadir "tests/client-data" init tests/CustomGenesis.json

   ;; Second, run geth

   geth --nodiscover --maxpeers 0 --shh --rpc --rpcapi web3,eth,net,shh --datadir tests/client-data --networkid 555 --unlock "0,1" --password tests/password.txt console Explain:

   • --shh enable Whisper(EXPERIMENTAL)
   • --rpc enables the rpc. Duh...
   • --nodiscover will make sure your node is not discoverable.
   • --rpcapi web3,eth,net,shh enable web3,eth,net,shh API over the HTTP-RPC interface
   • --maxpeers 0 will prevent the node from syncing.
   • init t/CustomGenesis.json will ensure you create a custom testing blockchain.
   • --unlock "0,1" will unlock the first two accounts
   • --password will use the password provided in the text file
   • console will open the console

3. In the step2 opend console, run miner.start(1) to start mining.

4. Run (asdf:test-system :web3) inside your repl. I am assuming you cloned the project in a directory that asdf can see.

Implemented JSON-RPC methods

• web3_clientVersion
• web3_sha3
• net_version
• net_listening
• net_peerCount
• eth_protocolVersion
• eth_syncing
• eth_coinbase
• eth_mining
• eth_hashrate
• eth_gasPrice
• eth_accounts
• eth_blockNumber
• eth_getBalance
• eth_getStorageAt
• eth_getTransactionCount
• eth_getBlockTransactionCountByHash
• eth_getBlockTransactionCountByNumber
• eth_getUncleCountByBlockHash
• eth_getUncleCountByBlockNumber
• eth_getCode
• eth_sign
• eth_sendTransaction
• eth_sendRawTransaction
• eth_call
• eth_estimateGas
• eth_getBlockByHash
• eth_getBlockByNumber
• eth_getTransactionByHash
• eth_getTransactionByBlockHashAndIndex
• eth_getTransactionByBlockNumberAndIndex
• eth_getTransactionReceipt
• eth_getUncleByBlockHashAndIndex
• eth_getUncleByBlockNumberAndIndex
• eth_newFilter
• eth_newBlockFilter
• eth_newPendingTransactionFilter
• eth_uninstallFilter
• eth_getFilterChanges
• eth_getFilterLogs
• eth_getLogs
• eth_getWork
• eth_submitWork
• eth_submitHashrate
• eth_getProof
• shh_version
• shh_post
• shh_newIdentity
• shh_hasIdentity
• shh_newGroup
• shh_addTogroup
• shh_newFilter
• shh_uninstallFilter
• shh_getFilterChanges
• shh_getMessages

Author

• Nisen ([e-mail])

Copyright

This project comes with a BSD-style license so you can basically do with it whatever you want.

TODO LIST

• Add missing inteface tests
• Add websocket support
• Maybe make long lived provider?

Reference

Jsonrpc wiki

https://github.com/ethereum/wiki/wiki/JSON-RPC

web3.py

• https://github.com/ethereum/web3.py
• http://web3py.readthedocs.io/

common lisp ethi

• https://github.com/tsikov/ethi
• Mine https://github.com/imnisen/ethi

iosocket sample

• https://sourceforge.net/p/sbcl/mailman/message/32846557/
• Tutorial http://pages.cs.wisc.edu/~psilord/blog/data/iolib-tutorial/tutorial.html