/stellar_base

Elixir library to read, write, hash, and sign XDR primitive constructs used in the Stellar network

Primary LanguageElixirMIT LicenseMIT

Elixir Stellar Base

stability-beta Build Badge Coverage Status Version Badge Downloads Badge License badge OpenSSF Best Practices OpenSSF Scorecard

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

Stellar Base vs Stellar SDK

stellar_base is a low-level library for creating Stellar primitive constructs. If you are looking for a complete Horizon integration we recommend you check the stellar_sdk library instead 🙌.

You should only use stellar_base if you are planning to build on top of it!

Documentation

API Reference

Installation

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

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

Development

  • Install an Elixir version above v1.10.
  • Compile dependencies: mix deps.get.
  • Run tests: mix test.

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