sdk/README.md
# Stellar SDK for Ruby: Horizon Integration and Higher Level Abstractions
[![stellar-sdk](https://badge.fury.io/rb/stellar-sdk.svg)](https://badge.fury.io/rb/stellar-sdk)
[![CI](https://github.com/astroband/ruby-stellar-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/astroband/ruby-stellar-sdk/actions/workflows/ci.yml)
[![Maintainability](https://api.codeclimate.com/v1/badges/dadfcd9396aba493cb93/maintainability)](https://codeclimate.com/github/astroband/ruby-stellar-sdk/maintainability)
This library helps you to integrate your application into the [Stellar network](http://stellar.org).
## Installation
Add this lines to your application's Gemfile:
```ruby
gem 'stellar-sdk'
```
And then execute:
$ bundle
Also requires libsodium. Installable via `brew install libsodium` on OS X.
## Usage
See [examples](examples).
A simple payment from the root account to some random accounts
```ruby
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](https://www.github.com/astroband/ruby-stellar-base)):
```ruby
Stellar.default_network = Stellar::Networks::PUBLIC
```
## Development
- Install and activate [rvm](https://rvm.io/rvm/install)
- 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`