Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yuan-xy/libra_client_ruby

A ruby client for Libra network
https://github.com/yuan-xy/libra_client_ruby

Last synced: 3 months ago
JSON representation

A ruby client for Libra network

Awesome Lists containing this project

README

        

# LibraClient

LibraClient is an unofficial client for [Libra blockchain](http://libra.org). The library allows Ruby program to interact with Libra nodes with [protobuf](https://developers.google.com/protocol-buffers/) message through [grpc](https://grpc.io/).

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'libra_client'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install libra_client

## Usage

### Get Account state
```ruby
require 'libra_client'
client = Libra::Client.new(:testnet)
state = client.get_account_state("000000000000000000000000000000000000000000000000000000000a550c18")
state.balance #the balance of the account
state.sequence_number #the sequence_number of the account
```

### Get Transaction
```ruby
require 'libra_client'
client = Libra::Client.new(:testnet)
client.get_transaction(0) #get the genesis transaction
client.get_transaction(1) #get the first transaction
version = client.get_latest_transaction_version
client.get_transaction(version) #get the latest transaction
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yuanxinyu/libra_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).