Skip to content

JakeUrban/ruby-stellar-sdk

 
 

Repository files navigation

Ruby Stellar

Build Status Code Climate

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)
}) 

Be sure to set the network when submitting to the public network (more information in stellar-base):

Stellar.default_network = Stellar::Networks::PUBLIC

Development

  • Install and activate rvm
  • Ensure your bundler version is up-to-date: gem install bundler
  • Run bundle install
  • Copy spec/config.yml.sample to spec/config.yml
  • Replace anything in spec/config.yml especially if you will re-record specs
  • bundle exec rspec spec

Contributing

  1. Sign the Contributor License Agreement
  2. Fork it ( https://github.com/bloom-solutions/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

About

Community maintained Ruby SDK for Stellar

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%