Skip to content

Argo-Navis-Dev/anchor-reference-server

Repository files navigation

anchor-reference-server

The PHP Stellar Anchor SDK makes it easier for PHP developers to implement Stellar Anchors.

Stellar clients make requests to the endpoints of Anchor Servers using sets of standards called SEPs (Stellar Ecosystem Proposals). The PHP Anchor SDK will help PHP developers to implement the Client - Anchor interaction by abstracting the Stellar-specific functionality defined in the SEP's so that developers can focus on business logic.

The SDK is composed of two components:

  • A Service Layer Library implementing the Stellar specific functionality described in the corresponding SEPs
  • An Anchor Reference Server implementation that uses the library.

This is the repo of the Anchor Reference Server. Pls. see architecture doc.

The implementation of the Service Layer Library can be found here.

Roadmap:

  • Implementation of SEP-01 Service (Stellar Info File) -> Done
  • Implementation of SEP-10 Service (Stellar Authentication) -> Done
  • Implementation of SEP-12 KYC API Service & SEP-09 Standard KYC Fields -> Done
  • Implementation of SEP-24 Hosted Deposit and Withdrawal - Interactive Flow Service -> Done
  • Implementation of SEP-38 Anchor RFQ Service -> Done
  • Implementation of SEP-06 Deposit and Withdrawal Service -> Done
  • Implementation of SEP-31 Cross-Border Payments Service -> Done
  • Implementation of SEP-08 Regulated Assets -> Done
  • Postman collection covering the SEP flows -> Done
  • Integrate transaction watcher and callback handlers -> Done
  • Localization, Logging, Extend administration interface -> Done

Run the server locally:

  1. Clone this repo from GitHub.

  2. Install the dependencies:

php composer install

  1. Create your .env file as shown in .env.example

  2. Create an empty database:

sqlite3 database/database.sqlite "SELECT 1;" - Creates an empty SQLite database under the database directory

  1. Run the db migration and seed the data:

php artisan migrate:refresh --seed

  1. Start the server:

php artisan serve - The server will run on http://localhost:8000

  1. Start vite:

npm run dev - Now the server accepts requests at: https://localhost:5173

  1. Run the StellarCustomerTest cases - The test uses SEP-01, SEP-10, SEP-09 and SEP-12 functionality.

Postman collection

An early version covering the basic SEP Requests can be found here.

About

The reference server shows an example of how to integrate the PHP Anchor SDK into a PHP Server implementation.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages