Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libsv/payd
Payd is a (work in progress!) basic wallet that operates fully SPV manner. Should be run along with a bitcoin blockheaders client.
https://github.com/libsv/payd
bitcoin bsv go golang liteclient mapi merchant spv
Last synced: about 1 month ago
JSON representation
Payd is a (work in progress!) basic wallet that operates fully SPV manner. Should be run along with a bitcoin blockheaders client.
- Host: GitHub
- URL: https://github.com/libsv/payd
- Owner: libsv
- License: other
- Created: 2021-01-23T14:56:41.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-03T10:19:17.000Z (about 2 years ago)
- Last Synced: 2024-09-29T04:05:09.723Z (about 2 months ago)
- Topics: bitcoin, bsv, go, golang, liteclient, mapi, merchant, spv
- Language: Go
- Homepage:
- Size: 26.9 MB
- Stars: 16
- Watchers: 6
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# payd
[](https://github.com/libsv/payd/releases)
[](https://github.com/libsv/payd/actions)
[](https://goreportcard.com/report/github.com/libsv/payd)
[](https://codecov.io/gh/libsv/payd)
[](https://golang.org/)
[](https://github.com/sponsors/libsv)
[](https://gobitcoinsv.com/#sponsor)
Payd is a basic dummy wallet (do not use this) for demonstrating the BIP 270 / Payment Protocol flow.
It has a random master key, created at startup and a single user support for now and no authentication. Seriously, don't use this wallet at the moment expect for demonstration purposes.
This wallet has an Invoice interface with CRUD operations for creating payment invoices and also implements the Wallet Payment Protocol Interface, used to integration with payment protocol servers.
This is written in go and integrates with servers running the Payment Protocol Interface.
## Exploring Endpoints
To explore the endpoints and functionality, run the server using `go run cmd/rest-server/main.go` and navigate to [Swagger](http://localhost:8443/swagger/index.html) or go to the GitHub Pages hosting the spec [here](https://libsv.github.io/payd/)
where the endpoints and their models are described in detail.
## Configuring PayD
The server has a series of environment variables that allow you to configure the behaviours and integrations of the server.
Values can also be passed at build time to provide information such as build information, region, version etc.
### Server
| Key | Description | Default |
|------------------------|--------------------------------------------------------------------|---------------|
| SERVER_PORT | Port which this server should use | :8443 |
| SERVER_HOST | Host name under which this server is found | payd:8443 |
| SERVER_SWAGGER_ENABLED | If set to true we will expose an endpoint hosting the Swagger docs | true |
| SERVER_SWAGGER_HOST | The host that swagger will point its api requests to | localhost:8443|
### Environment / Deployment Info
| Key | Description | Default |
|---------------------|----------------------------------------------------------------------------|------------------|
| ENV_ENVIRONMENT | What enviornment we are running in, for example 'production' | dev |
| ENV_REGION | Region we are running in, for example 'eu-west-1' | local |
| ENV_COMMIT | Commit hash for the current build | test |
| ENV_VERSION | Semver tag for the current build, for example v1.0.0 | v0.0.0 |
| ENV_BUILDDATE | Date the code was build | Current UTC time |
### Logging
| Key | Description | Default |
|-----------|-----------------------------------------------------------------------|---------|
| LOG_LEVEL | Level of logging we want within the server (debug, error, warn, info) | info |
### DB
| Key | Description | Default |
|-------------|----------------------------------------------------------|---------|
| DB_TYPE | Type of db you're connecting to (sqlite, postgres,mysql) sqlite only supported currently | sqlite |
| DB_DSN | Connection string for the db | file:data/wallet.db?_foreign_keys=true&pooled=true |
| DB_SCHEMA_PATH | Location of the data base migration scripts | data/sqlite/migrations |
| DB_MIGRATE | If true we will check the db version and apply missing migrations | true |
### Headers Client
If validating using SPV you will need to run a Headers Client, this will sync headers as they are mined and provide
block and merkle proof information.
| Key | Description | Default |
|-------------|----------------------------------------------------------|---------|
| HEADERSCLIENT_ADDRESS | Uri for the headers client you are using | http://headersv:8080 |
| HEADERSCLIENT_TIMEOUT | Timeout in seconds for headers client queries | 30 |
### Wallet
| Key | Description | Default |
|-------------|----------------------------------------------------------|---------|
| WALLET_NETWORK | Bitcoin network we're connected to (regtest, stn, testnet,regtest) | regtest |
| WALLET_SPVREQUIRED | If true we will require full SPV envelopes to be sent as part of payments | true |
| WALLET_PAYMENTEXPIRY | Duration in hours that invoices will be valid for | 24 |
## Working with PayD
There are a set of makefile commands listed under the [Makefile](Makefile) which give some useful shortcuts when working
with the repo.
Some of the more common commands are listed below:
`make pre-commit` - ensures dependencies are up to date and runs linter and unit tests.
`make build-image` - builds a local docker image, useful when testing PayD in docker.
`make run-compose` - runs PayD in compose using the latest available image.
`make run-compose-faucet` - runs a local payD instance that connects to the infra.bitcoinsv.io dpp proxy. Used to receive funds from faucet.bitcoinsv.io.
`make run-compose-local` - will run payd and use a local image built using the above `make build-image` command.
## Using the Faucet
There is a testnet 'faucet' setup at faucet.bitcoinsv.io that can be used to get funds from.
Because of the new invoice based payments system, this can send funds to any wallet that also supports invoice based payments.
To get funds, simply run `make run-compose-faucet`. This will run a local payd instance and connect it to the faucet infrastructure.
Next, send the following call to your local payd instance:
```curl
curl --location --request POST 'http://localhost:8443/api/v1/invoices' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"satoshis":1000
}'
```
This will create an invoice and also connect your payd to the faucet dpp server which orchestrates the payments.
You will get a response back like this:
```json
{
"createdAt": "2022-08-03T12:41:57.967516Z",
"deletedAt": null,
"description": null,
"expiresAt": "2022-08-04T12:41:57.967516Z",
"id": "DBVb00g",
"paymentReceivedAt": null,
"reference": null,
"refundTo": null,
"refundedAt": null,
"satoshis": 200,
"state": "pending",
"updatedAt": "2022-08-03T12:41:57Z"
}
```
Copy the "id" and then go to faucet.bitcoinsv.io, in the box for the URL enter `https://infra.bitcoinsv.io/dpp/api/v1/payment/DBVb00g` where the id at the end, is the id returned from the above call.
Hit the Pay To URL button and the funds requested will be sent to your local wallet.
For further information view the [Liteclient Documentation](https://docs.bitcoinsv.io/introduction/liteclient).
## Releases
You can view the latest releases on our [Github Releases](https://github.com/libsv/payd/releases) page.
We also publish docker images which can be found on [Docker Hub](https://hub.docker.com/repository/docker/libsv/payd).
## CI / CD
We use github actions to test and build the code.
If a new release is required, after your PR is approved and code added to master, simply add a new semver tag and a GitHub action will build and publish your code as well as create a GitHub release.