Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libsv/go-spvchannels
The go-to SPV Channels client Go library.
https://github.com/libsv/go-spvchannels
Last synced: about 2 months ago
JSON representation
The go-to SPV Channels client Go library.
- Host: GitHub
- URL: https://github.com/libsv/go-spvchannels
- Owner: libsv
- License: isc
- Created: 2021-07-16T11:03:50.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-14T10:29:03.000Z (7 months ago)
- Last Synced: 2024-06-19T18:10:55.845Z (7 months ago)
- Language: Go
- Homepage:
- Size: 271 KB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-spvchannels
[](https://github.com/libsv/go-spvchannels/releases)
[](https://github.com/libsv/go-bt/actions/workflows/run-tests.yml)
[](https://github.com/libsv/go-bt/actions/workflows/run-tests.yml)
[](https://goreportcard.com/report/github.com/libsv/go-spvchannels)
[](https://codecov.io/gh/libsv/go-spvchannels)
[](https://golang.org/)
[](https://github.com/sponsors/libsv)
[](https://gobitcoinsv.com/#sponsor)
[![Mergify Status][mergify-status]][mergify]
[mergify]: https://mergify.io
[mergify-status]: https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/libsv/go-spvchannels&style=flat
Go SPV Channels is a [golang](https://golang.org/) implementation of the [SPV Channels Server](https://github.com/bitcoin-sv/spvchannels-reference).
The library implement all rest api endpoints served in [SPV Channels Server](https://github.com/bitcoin-sv/spvchannels-reference) and the websocket client to listen new message notifications in real time.
## Table of Contents
- [Installation](#installation)
- [Run tests](#run-tests)
- [Setup Local SPV Channels server](#setup-local-spv-channels-server)
- [License](#license)
## Installation
```
go get github.com/libsv/go-spvchannels
```
## Run tests
Run unit test
```
go clean -testcache && go test -v ./...
```
To run integration tests, make sure you have `docker-compose up -d` on your local machine, then run
```
go clean -testcache && go test -race -v -tags=integration ./...
```
## Setup Local SPV Channels server
#### Creating SSL key for secure connection
Following the tutorial in the [SPV Channels Server](https://github.com/bitcoin-sv/spvchannels-reference), we first create the certificate using `openssl`:
```
terminal $> openssl req -x509 -out localhost.crt -keyout localhost.key -newkey rsa:2048 -nodes -sha256 -subj '/CN=localhost' -extensions EXT -config <( printf "[dn]\nCN=localhost\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:localhost\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")
terminal $> openssl pkcs12 -export -out devkey.pfx -inkey localhost.key -in localhost.crt # use devkey as password
```
That will create the `devkey.pfx` with password `devkey`. We then write a `docker-compose.yml` file following the tutorial.
#### Launch local [SPV Channels Server](https://github.com/bitcoin-sv/spvchannels-reference) :
```
docker-compose up -d
```
#### Create an account
We then need to create a SPV Channels account on the server
```
docker exec spvchannels ./SPVChannels.API.Rest -createaccount spvchannels_dev dev dev
```
#### Usage with swagger
The [SPV Channels Server](https://github.com/bitcoin-sv/spvchannels-reference) run by `docker-compose.yml` listen on `localhost:5010`. We can start playing with the endpoints using swagger, i.e in browser, open `https://localhost:5010/swagger/index.html`
From this page, there are a link `/swagger/v1/swagger.json` to export swagger file
#### Usage with Postman
Interacting with browser might have some difficulty related to adding certificate to the system. It might be easier to use Postman to interact as Postman has a easy possibility to disable SSL certificate check to ease development propose.
From Postman, import the file `devconfig/postman.json` and set the environment config as follow
| VARIABLE | INITIAL VALUE |
| ----------- | -------------- |
| URL_PORT | localhost:5010 |
| ACCOUNT | 1 |
| USERNAME | dev |
| PASSWORD | dev |
These environment variable are used as _template_ to populate values in the `postman.json` file. There are a few more environment variable to define (look into the json file) that will depend to the endpoint and value created during the experience:
| VARIABLE | INITIAL VALUE |
| ------------ | --------------- |
| CHANNEL_ID | .. to define .. |
| TOKEN_ID | .. to define .. |
| TOKEN_VALUE | .. to define .. |
| MSG_SEQUENCE | .. to define .. |
| NOTIFY_TOKEN | .. to define .. |
## License
