A PHP library for communicating with the Stellar Horizon API.

dev-main 2023-01-27 19:28 UTC

This package is auto-updated.

Last update: 2024-11-27 23:30:09 UTC


README

Bloom Stellar SDK

Tests

Bloom is an unofficial PHP SDK library for the Stellar Horizon API.

I was inspired to create this library after being introduced to Stellar Quest; a remarkable platform for discovering and exploring the building blocks of the Stellar network. I wanted to see if I could solve the exercises in PHP rather than Javascript or Golang. After many months this library is the result of that effort.

There are three guiding principals that have steered the decision making for this project:

  • Reduce the number of third party dependencies wherever possible.
  • Make objects immutable by default wherever possible.
  • Leverage the up and coming type system improvements in PHP 8.* and static analysis tools (like PHPStan) to pursue type safety as much as possible.

Preliminary documentation can be found in the documentation folder. Example usage can be found here.

This project would not have been possible without the tireless effort of developers and companies who have donated their work to the open source community. I am extremely grateful for the building blocks they have put in place. See here for a more specific list of acknowledgments.

Bloom is an independent project that is not affiliated with the Stellar Development Foundation.

Note: This library has not yet reached full functionality; it is not ready for use in production applications.

Installation

You can install the package via composer:

composer require stagerightlabs/bloom

Architecture

Please see ARCHITECTURE for a high level outline of the structure of this repository.

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

License

The Apache License 2. Please see License File for more information.