Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libsv/go-dpp
The go-to Bitcoin Direct Payment Protocol Go library.
https://github.com/libsv/go-dpp
payment protocol
Last synced: about 8 hours ago
JSON representation
The go-to Bitcoin Direct Payment Protocol Go library.
- Host: GitHub
- URL: https://github.com/libsv/go-dpp
- Owner: libsv
- License: isc
- Created: 2021-02-25T13:07:36.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-14T10:53:55.000Z (5 months ago)
- Last Synced: 2024-06-19T11:29:17.139Z (5 months ago)
- Topics: payment, protocol
- Language: Go
- Homepage:
- Size: 15 MB
- Stars: 8
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# DPP - Direct Payment Protocol
[](https://github.com/libsv/go-dpp/releases)
[](https://github.com/libsv/go-dpp/actions)
[](https://goreportcard.com/report/github.com/libsv/go-dpp)
[](https://golang.org/)
[](https://github.com/sponsors/libsv)
[](https://gobitcoinsv.com/#sponsor)
DPP is a basic reference implementation of a Payment Protocol Server implementing the proposed BIP-270 payment flow.
This is written in go and integrates with a wallet running the Payment Protocol PayD 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:8445/swagger/index.html)
where the endpoints and their models are described in detail.
## Configuring DPP
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 | :8445 |
| SERVER_HOST | Host name under which this server is found | dpp |
| SERVER_SWAGGER_ENABLED | If set to true we will expose an endpoint hosting the Swagger docs | true |
| SERVER_SWAGGER_HOST | Sets the base url for swagger ui calls | localhost:8445 |
### 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 |
| ENV_BITCOIN_NETWORK | What bitcoin network we are connecting to (mainnet, testnet, stn, regtest) | regtest |
### Logging
| Key | Description | Default |
| --------- | --------------------------------------------------------------------- | ------- |
| LOG_LEVEL | Level of logging we want within the server (debug, error, warn, info) | info |
### PayD Wallet
| Key | Description | Default |
| ----------- | --------------------------------------------------------- | ------- |
| PAYD_HOST | Host for the wallet we are connecting to | payd |
| PAYD_PORT | Port the PayD wallet is listening on | :8443 |
| PAYD_SECURE | If true the DPP server will validate the wallet TLS certs | false |
| PAYD_NOOP | If true we will use a dummy data store in place of payd | true |
## Working with DPP
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 dpp in docker.
`make run-compose` - runs DPP in compose, a reference PayD wallet will be added to compose soon NOTE the above command will need ran first.
### Rebuild on code change
You can also add an optional `docker-compose.dev.yml` file (this is not committed) where you can safely overwrite values or add other services without impacting the main compose file.
If you add this file, you can run it with `make run-compose-dev`.
The file I use has a watcher which means it auto rebuilds the image on code change and ensures compose is always up to date, this full file is shown below:
```yaml
version: "3.7"
services:
dpp:
image: theflyingcodr/go-watcher:1.15.8
environment:
GO111MODULE: "on"
GOFLAGS: "-mod=vendor"
DB_DSN: "file:data/wallet.db?cache=shared&_foreign_keys=true;"
DB_SCHEMA_PATH: "data/sqlite/migrations"
command: watcher -run github.com/libsv/go-dpp/cmd/rest-server/ -watch github.com/libsv/go-dpp
working_dir: /go/src/github.com/libsv/go-dpp
volumes:
- ~/git/libsv/go-dpp:/go/src/github.com/libsv/go-dpp
```
## 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.