faucet

Faucet

Faucet is an application that provides free 5 evry coin per day to user for testnet

Getting started

This repository already provided you easy steps for starting the project. You can start the project through make commands

Developing

Build With

• Golang
• Gin gonic
• Stellar-go
• CLI
• Zap Logger

Prerequisites

• Knowledge of Stellar here

Setting up Dev

For installation dependecy in the project

$ make deps

Building

For building binary file

$ make build

Versioning

We use a SemVer for versioning. Please see the release.

Configuration

For the configuration details, please build the project binary first and then run the following command.

$ ./$(BIN_DIR)/warp --help

API Reference

/api/v1/accounts/:accountID/credits

accountID = stellar public account This api provides a 5 evry coin for funding to user's account Method : Post

• Request

Header
  - Authorization = token of reCATPCHAv2
Body
  {
     "code":"",
     "issuer":""
  }

• Response

{
	"data": {
		txHash : ""
	}
}

/api/v1/stellar/minions/fund

This api funds evry coin to minions Method : Get

• Response

{
    "message":"successfully fund to minion accounts"
}

Database

Using redis ( https://redis.io/ ) Schemas

Tests

For test

$ make test

or want to see test coverage

$ make test-coverage

Style guide

We use the following command to maintain the formatting and linting.

$ go import -w .
$ golint ./...
$ golangci-lint run

License

Faucet api is licensed under the Open Software License ("OSL") v. 3.0, also included in our repository in the LICENSE file.