Sirius API

Introduction

Sirius is an RESTful API that allows developers to integrate the Stellar blockchain into your application, supporting the following features:

• Account creation
• Account balance retrieval
• Account transaction history retrieval
• Transaction submission
• Transaction status retrieval
• Transaction fee retrieval
• Address validation

Table of Contents

Getting Started

Prerequisites

• Go 1.20 or higher

Installation

1. Clone the repo

git clone https://github.com/vidalpaul/sirius.git

or (using GitHub CLI)

gh repo clone vidalpaul/sirius

2. Install Go dependencies

go mod download

3. Build the server

go build

4. Run the server

go run .

Usage

Account Creation

Request

POST /account

{
  "network": "testnet"
}

Response

{
  "address": "***"
}

Account Balance Retrieval

Request

GET /account/balance

{
  "network": "testnet",
  "address": "***"
}

Response

{
  "balance": "***"
}

Account Transaction History Retrieval

Request

GET /account/transactions

{
  "network": "testnet",
  "address": "***"
}

Response

Transaction Submission

Request

POST /account/transaction

{
  "network": "testnet",
  "address": "***",
  "destination": "***",
  "amount": "***",
  "memo": "***"
}

Response

{
  "hash": "***"
}

Transaction Status Retrieval

Request

GET /account/transaction

{
  "network": "testnet",
  "address": "***",
  "hash": "***"
}

Response

{
  "status": "***"
}

Transaction Fee Retrieval

Request

GET /account/transaction/fee

{
  "network": "testnet",
  "address": "***"
}

Response

{
  "fee": "***"
}

Address Validation

Request

GET /address/validate

{
  "network": "testnet",
  "address": "***"
}

Response

{
  "valid": true
}

Tests

To run tests, run the following command

go test

License

Distributed under the MIT License. See LICENSE for more information.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request