StellarClient

Ruby wrapper for Stellar's different APIs including:

Installation

Add this line to your application's Gemfile:

gem 'stellar_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install stellar_client

Usage

Configure in an initializer:

StellarClient.configure do |c|
  c.host = "https://domain.that.has.the.stellar.toml"
  c.bridge_host = "https://bridge.com" # if you will be making calls to bridge
end

See spec/acceptance for detailed examples and what is supported.

Development

Copy spec/config.yml.sample to spec/config.yml
Replace destination with the account the tests will be sending to
Copy spec/fixtures/bridge/bridge.cfg.sample to spec/fixtures/bridge/bridge.cfg
Replace authorizing_seed with the seed of the account you're sending from
Replace receiving_account_id with the account id you're sending from
Replace base_seed with what you placed in authorizing_seed
docker-compose up pg
docker-compose run bridge createdb -h pg -U postgres bridge
docker-compose up bridge
Then start the application that we'll run some tests against:

cd spec/stellar_app
bundle
yarn install
rails db:create
rails stellar_base:install:migrations
rails db:migrate
rails s

Make your changes
rspec spec

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/bloom-solutions/stellar_client-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.