Ruby SDK for CKB
The ckb-sdk-ruby is still under development and NOT production ready. You should get familiar with CKB transaction structure and RPC before using it.
Module Indexer has been removed from ckb_v0.40.0: Please use ckb-indexer as an alternate solution.
The following RPCs hash been removed from ckb_v0.40.0:
get_live_cells_by_lock_hashget_transactions_by_lock_hashindex_lock_hashdeindex_lock_hashget_lock_hash_index_statesget_capacity_by_lock_hash
Since ckb_v0.36.0 SDK use ckb-indexer to collect cells, please see Usage for examples.
Require Ruby 2.4 and above.
sudo apt install libsodium-devThis SDK depends on the rbsecp256k1 gem. You need to install libsecp256k1. Follow this to do so.
brew tap nervosnetwork/tap brew install libsodium libsecp256k1Add this line to your application's Gemfile:
gem 'ckb-sdk-ruby', github: 'nervosnetwork/ckb-sdk-ruby', require: 'ckb'And then execute:
$ bundle install If you just want to use it in a console:
git clone https://github.com/nervosnetwork/ckb-sdk-ruby.git cd ckb-sdk-ruby bundle install bundle exec bin/console RPC interface returns parsed JSON object
rpc = CKB::RPC.new # using RPC `get_tip_header`, it will return a Hash rpc.get_tip_headerAPI interface returns Types instead of Hash
api = CKB::API.new # it will return a CKB::Types::BlockHeader api.get_tip_headerSend capacity
# create api first api = CKB::API.new # create ckb-indexer api indexer_api = CKB::Indexer::API.new # create two wallet object bob = CKB::Wallet.from_hex(api, "0xe79f3207ea4980b7fed79956d5934249ceac4751a4fae01a0f7c4a96884bc4e3", indexer_api: indexer_api) alice = CKB::Wallet.from_hex(api, "0x76e853efa8245389e33f6fe49dcbd359eb56be2f6c3594e12521d2a806d32156", indexer_api: indexer_api) # bob send 1000 bytes to alice tx_hash = bob.send_capacity(alice.address, 1000 * 10**8, fee: 1000) # loop up the transaction by tx_hash api.get_transaction(tx_hash)Provide wallet with a public key
api = CKB::API.new indexer_api = CKB::Indexer::API.new bob = CKB::Wallet.new(api, "0x024a501efd328e062c8675f2365970728c859c592beeefd6be8ead3d901330bc01", indexer_api: indexer_api) alice = CKB::Wallet.new(api, "0x0257623ec521657a27204c5590384cd59d9267c06d75ab308070be692251b67c57", indexer_api: indexer_api) bob_key = "0xe79f3207ea4980b7fed79956d5934249ceac4751a4fae01a0f7c4a96884bc4e3" tx_hash = bob.send_capacity(alice.address, 1000 * 10**8, key: bob_key)BOB_PRIVATE_KEY="0xe79f3207ea4980b7fed79956d5934249ceac4751a4fae01a0f7c4a96884bc4e3" rake specAfter checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install.
The gem is available as open source under the terms of the MIT License.
See CHANGELOG for more information.