https://github.com/lafronzt/stellar-federation

A Go based Stellar Federation Server
https://github.com/lafronzt/stellar-federation

federation go golang lumen stellar stellar-federation stellar-network web3

Last synced: 6 months ago
JSON representation

A Go based Stellar Federation Server

• Host: GitHub
• URL: https://github.com/lafronzt/stellar-federation
• Owner: lafronzt
• License: mit
• Created: 2022-02-25T16:07:41.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-08-30T14:11:18.000Z (almost 3 years ago)
• Last Synced: 2024-11-18T18:24:41.364Z (over 1 year ago)
• Topics: federation, go, golang, lumen, stellar, stellar-federation, stellar-network, web3
• Language: Go
• Homepage:
• Size: 15.6 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Stellar Federation Server

One of the beautiful features of Stellar is the ability to create a federation server. This allows you to send payments to accounts on the network without having to know the public key of the account.

## Technical Details

### Architecture

- Built with Go.

- Containerized

- Federation server is a REST API that is exposed to the public.

- Uses the [Stellar Network Foundation](https://developers.stellar.org/docs/glossary/federation/) protocol.

### Features

- Dynamic Memo support

    > Add any memo to any transaction by sending the payment to `tyler+Thank_You*lafronz.com`. The text following `+` is the memo.

    > 

    > Learn more about Memos at [lumenauts.com](https://www.lumenauts.com/explainers/what-are-memos)

- Supports multiple federation domains per servers

- Supports ID to federation reverse lookups

## How to use

1. Create your `stellar.yaml` file

    > A sample file is show in [the repo](stellar.yaml).

2. Create your `stellar.toml` file

    > A sample file is show in [the repo](stellar.toml).

3. Upload your `stellar.toml` files so it can be found by the Stellar Network at `https://YOUR_DOMAIN/.well-known/stellar.toml`

4. Build your Federation Server

    > Replace the stellar.yaml file with your own.

    > 

    > Run `docker build -t docker.io//stellar-federation-server:latest .`

5. Deploy your Federation Server to your runtime location of your choosing.

    > Sample K8s deployment is show in [the repo](Deployment/k8s.yaml).

## More Information

More information about the federation server can be found in the [Stellar Network Foundation](https://developers.stellar.org/docs/glossary/federation/) documentation.