Elixir Stellar Base

Build Badge Coverage Status Version Badge Downloads Badge License badge

⚠️ Warning! This library is under active development. Do not use it in production environments.

stellar_base is an Elixir library that provides a complete set of functions to read, write, hash, and sign XDR primitive constructs used in stellar-core.

This library is aimed at developers building Elixir applications on top of the Stellar network. Transactions constructed by this library may be submitted to any Horizon instance for processing onto the ledger, using any Stellar SDK client. The recommended client for Elixir programmers is stellar_sdk.

stellar_base vs stellar_sdk

  • stellar_sdk is a client library for interfacing with Horizon server REST endpoints to retrieve ledger information and submit transactions built with stellar_base.
  • stellar_base enables the construction, signing, and encoding of Stellar transactions.
  • Use the stellar_base library if you are planning to build on top of it.

Installation

Available in Hex, add stellar_base to your list of dependencies in mix.exs:

def deps do
  [
    {:stellar_base, "~> 0.1.0"}
  ]
end

Development

Code of conduct

We welcome everyone to contribute. Make sure you have read the CODE_OF_CONDUCT before.

Contributing

For information on how to contribute, please refer to our CONTRIBUTING guide.

Changelog

Features and bug fixes are listed in the CHANGELOG file.

License

This library is licensed under an MIT license. See LICENSE for details.

Acknowledgements

Made with 💙 by kommitters Open Source