stellar_base-rails

When building Rails apps, we’d always implement /.well-known/stellar and other bits and pieces of the required endpoints in the Stellar Protocol. This gem solves receiving and responding to requests from some parts of the Stellar Protocol

Usage

Mounting

Adding modules to your routes:

mount StellarBase::Engine => "/stellar"

# Optionally, you can mount /.well-known/stellar
mount_stellar_base_well_known

rails stellar_base:install:migrations
rails db:migrate

Configuration

Create an initializer in your rails application:

# config/initializers/stellar_base-rails.rb

StellarBase.configure do |c|
  c.modules = i(bridge_callbacks)
  c.horizon_url = "https://horizon.stellar.org"

  c.on_bridge_callback = "StellarBridgeReceive::SaveTxn"
  c.check_bridge_callbacks_authenticity = true
  c.check_bridge_callbacks_mac_payload = false
  c.bridge_callbacks_mac_key = "test"
end

c.modules

You can supply what endpoints you want to activate with the gem

  • Value(s): array of symbols. See the modules documentation for more details.
  • Default: %i(bridge_callbacks)

c.distribution_account

This is the same distribution account that is setup in bridge. Currently, it is used in the /withdraw endpoint -- to tell the user to send the assets there.

  • Value: Stellar account address

c.horizon_url

  • Value(s): String, url to horizon
  • Default: https://horizon.stellar.org
  • This is where the engine will check bridge callbacks if c.check_bridge_callbacks_authenticity is turned on

c.stellar_toml

  • Value(s): Hash, follow Stellar's documentation for stellar.toml
  • Example: c.stellar_toml = { TRANSFER_SERVER: ..., FEDERATION_SERVER: ..., AUTH_SERVER: ..., }
  • Default: c.stellar_toml = { TRANSFER_SERVER: ..., }

Installation

Add this line to your application's Gemfile:

gem 'stellar_base-rails'

And then execute:

$ bundle

Development

cp spec/config.yml{.sample,}

Edit the spec/config.yml file.

cd spec/dummy
rails db:migrate
rails db:migrate RAILS_ENV=test

Now you can run rspec spec

License

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