https://github.com/kommitters/stellar_base

Low-level elixir library to read, write, hash, and sign XDR primitive constructs used in the Stellar network
https://github.com/kommitters/stellar_base

blockchain crypto elixir elixir-lang hacktoberfest stellar stellar-network

Last synced: 11 months ago
JSON representation

Low-level elixir library to read, write, hash, and sign XDR primitive constructs used in the Stellar network

• Host: GitHub
• URL: https://github.com/kommitters/stellar_base
• Owner: kommitters
• License: mit
• Created: 2021-05-25T20:01:09.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-10T12:39:35.000Z (about 2 years ago)
• Last Synced: 2024-04-13T20:30:26.039Z (about 2 years ago)
• Topics: blockchain, crypto, elixir, elixir-lang, hacktoberfest, stellar, stellar-network
• Language: Elixir
• Homepage: https://hex.pm/packages/stellar_base
• Size: 1.14 MB
• Stars: 5
• Watchers: 4
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# Elixir Stellar Base

![stability-beta](https://img.shields.io/badge/stability-beta-33bbff.svg?style=for-the-badge)

![Build Badge](https://img.shields.io/github/actions/workflow/status/kommitters/stellar_base/ci.yml?branch=main&style=for-the-badge)

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

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

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

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

[![OpenSSF Best Practices](https://img.shields.io/cii/summary/6461?label=openssf%20best%20practices&style=for-the-badge)](https://bestpractices.coreinfrastructure.org/projects/6461)

[![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/kommitters/stellar_base?label=openssf%20scorecard&style=for-the-badge)](https://api.securityscorecards.dev/projects/github.com/kommitters/stellar_base)

**`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-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**][stellar-horizon] integration we recommend you check the [**`stellar_sdk`**][sdk] library instead 🙌.

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

### Documentation

[**API Reference**][api-reference]

## Installation

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

```elixir

def deps do

  [

    {:stellar_base, "~> 0.16.0"}

  ]

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][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_base/blob/main/LICENSE.md

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

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

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

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

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

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

[stellar-core]: https://github.com/stellar/stellar-core

[stellar-horizon]: https://developers.stellar.org/api/introduction/

[api-reference]: https://hexdocs.pm/stellar_base/api-reference.html#content