Packages

stellar_sdk

0.1.0
0.23.0 0.22.0 0.21.2 0.21.1 0.21.0 0.20.0 0.19.0 0.18.1 0.18.0 0.17.1 0.17.0 0.16.1 0.16.0 0.15.1 0.15.0 0.14.0 0.13.1 0.13.0 0.12.0 0.11.8 0.11.7 0.11.6 0.11.5 0.11.4 0.11.3 0.11.2 0.11.1 0.11.0 0.10.2 0.10.1 0.10.0 0.9.3 0.9.2 0.9.1 0.9.0 0.8.1 0.8.0 0.7.1 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

Elixir SDK for the Stellar network.

HexDocs

Current section

Files

Jump to
Readme
45 Versions
2 Dependencies
Dependants
Files
Activity
stellar_sdk README.md
Raw

README.md 

# Elixir Stellar SDK

![Build Badge](https://img.shields.io/github/workflow/status/kommitters/stellar_sdk/StellarSDK%20CI/main?style=for-the-badge)

[![Coverage Status](https://img.shields.io/coveralls/github/kommitters/stellar_sdk?style=for-the-badge)](https://coveralls.io/github/kommitters/stellar_sdk)

[![Version Badge](https://img.shields.io/hexpm/v/stellar_sdk?style=for-the-badge)](https://hexdocs.pm/stellar_sdk)

![Downloads Badge](https://img.shields.io/hexpm/dt/stellar_sdk?style=for-the-badge)

[![License badge](https://img.shields.io/hexpm/l/stellar_sdk.svg?style=for-the-badge)](https://github.com/kommitters/stellar_sdk/blob/main/LICENSE.md)



### ⚠️ Warning! This library is under active development. DO NOT use it in production environments.



`stellar_sdk` is an **Elixir library** that provides a client for interfacing with **Horizon** server REST endpoints to retrieve ledger information, and to submit transactions. `stelar_sdk` uses the [stellar_base][base] library to enable the construction, signing and encoding of Stellar primitive XDR constructs.



This library is aimed at developers building Elixir applications that interact with the [Stellar network][stellar].



## Installation

[Available in Hex][hex], add `stellar_sdk` to your list of dependencies in `mix.exs`:



```elixir

def deps do

  [

    {:stellar_sdk, "~> 0.1.0"}

  ]

end

```



## Development

* Install any Elixir version above 1.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][coc] before.



## Contributing

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



## Changelog

Features and bug fixes are listed in the [CHANGELOG][changelog] file.



## License

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



## Acknowledgements

Made with 💙 by [kommitters Open Source](https://kommit.co)



[license]: https://github.com/kommitters/stellar_sdk/blob/main/LICENSE.md

[coc]: https://github.com/kommitters/stellar_sdk/blob/main/CODE_OF_CONDUCT.md

[changelog]: https://github.com/kommitters/stellar_sdk/blob/main/CHANGELOG.md

[contributing]: https://github.com/kommitters/stellar_sdk/blob/main/CONTRIBUTING.md

[base]: https://github.com/kommitters/stellar_base

[sdk]: https://github.com/kommitters/stellar_sdk

[hex]: https://hex.pm/packages/stellar_sdk

[stellar]: https://www.stellar.org/