Main Stellar client library for the Ruby language
Ruby
Clone or download

README.md

Ruby Stellar

Build Status Code Climate

STATUS: this library is very early and incomplete. The examples provided do not work, yet

This library helps you to integrate your application into the Stellar network.

Installation

Add this line to your application's Gemfile:

gem 'stellar-sdk'

And then execute:

$ bundle

Or install it yourself as:

$ gem install stellar-sdk

Also requires libsodium. Installable via brew install libsodium on OS X.

Usage

See examples.

A simple payment from the root account to some random accounts

require 'stellar-sdk'

account   = Stellar::Account.master
client    = Stellar::Client.default_testnet()
recipient = Stellar::Account.random

client.send_payment({
  from:   account,
  to:     recipient,
  amount: Stellar::Amount.new(100_000_000)
}) 

Development

  • Copy spec/config.yml.sample to spec/config.yml
  • Replace anything in spec/config.yml especially if you will re-record specs
  • rspec spec

Contributing

  1. Sign the Contributor License Agreement
  2. Fork it ( https://github.com/stellar/ruby-stellar-lib/fork )
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request