Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SPV Channels CE | Next.js | Bitcoin SV | Hardhat-Ethers
Readme version 1.1.1.
This repository contains SPV Channels CE, which is an implementation of the BRFC specification for SPV channels.
In addition to a server-side implementation, it also contains the JavaScript client libraries for interacting with the server. See Client libraries readme for more details about the client-side libraries.
SPV Channels provides a mechanism via which counterparties can communicate in a secure manner even in circumstances where one of the parties is temporarily offline.
Swagger UI
The REST API can be reviewed in Swagger UI.
Deploying SPV Channels CE API Server as docker containers on Linux
Pre Requirements:
A SSL server certificate is required for installation. Obtain the certificate from your IT support team. There are are also services that issue free SSL certificates such as
letsencrypt.org
. The certificate must be issued for the host with a fully qualified domain name. To use the server-side certificate, you need to export it (including the corresponding private key) in PFX file format (*.pfx).API Clients must trust the Certification Authority (CA) that issued the server-side SSL certificate.
Initial setup
The distribution is shared and run using Docker.
Open the terminal.
Create a directory where the spv-channels docker images, config and database will be stored (e.g. spv-channels) and navigate to it:
Download the distribution of SPV Channels Server into the directory created in the previous step and extract the contents.
Check that the following files are present:
docker-compose.yml
.env
Create a
config
folder and copy the SSL server certificate file (<certificate_file_name>.pfx) into it. This server certificate is required to setup TLS (SSL).Before running the SPV Channels API Server containers (spv-channels-db and spv-channels), replace some values in the
.env
file.Running an application
After the
.env
is set up, launch the spv-channels-db and spv-channels containers using the command:The docker images as specified by the
docker-compose.yml
file, are automatically pulled from Docker Hub.Verify that all the SPV Channels Server containers are running using:
The list should include
bitcoinsv/spvchannels-db
andbitcoinsv/spvchannels
.If everything is running you can continue to section Account manager to create an account.
Setting up an account
To be able to call SPV Channels Server API, an account must be added into the database using the following command:
Parameter description:
Setting up mobile push notifications
To enable mobile push notifications from SPV Channels, a Firebase service account key is required. Copy the *.json file containing the Firebase service account key into the config folder and set FIREBASECREDENTIALSFILENAME in the
.env
file.REST interface
The reference implementation exposes different REST APIs:
This interfaces can be accessed on
https://<servername>:<port>/api/v1
. A Swagger page with the interface description can be accessed athttps://<servername>:<port>/swagger/index.html
Settings
<bool>
(`True<number>
5010
.<text>
<text>
<text>
New message arrived
.<number>
65536
.<number>
1024
.<number>
64
.<number>
1048576
.<number>
60
seconds.<number>
600
seconds.<text>
Terminating application
Open the terminal and navigate to spv-channels folder:
To shutdown SPV Channels Server containers use the following command:
This is a Next.js project bootstrapped with
create-next-app
.Getting Started
First, run the development server:
npm run dev # or yarn dev
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying
pages/index.js
. The page auto-updates as you edit the file.API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in
pages/api/hello.js
.The
pages/api
directory is mapped to/api/*
. Files in this directory are treated as API routes instead of React pages.Learn More
To learn more about Next.js, take a look at the following resources:
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
Deploy on Vercel
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.
....
Bitcoin SV
What is Bitcoin SV?
Bitcoin SV (Satoshi Vision) is the original Bitcoin. It restores the original Bitcoin
protocol, will keep it stable, and allow it to massively scale. Bitcoin SV will maintain the vision set out by Satoshi
Nakamoto’s white paper in 2008. This Github repository provides open-source software to enable use of Bitcoin SV.
License
Bitcoin SV is released under the terms of the Open BSV license. See LICENSE for more information.
Security
Security is core to our values, and we value the input of security researchers acting in good faith to help us maintain
high standards of security and privacy for our users and the Bitcoin SV blockchain.
To encourage ethical and responsible research into security vulnerabilities, the Bitcoin SV team, with support from
Coingeek Mining, has instituted a Responsible Disclosure Policy.
Development Process
This Github repository contains the source code of releases.
At this early stage in Bitcoin SV's development, we are not accepting contributions to the project. We expect this to
change in the future.
Contacting the Bitcoin SV Team
If you want to report a non-confidential issue with Bitcoin SV, please use the
GitHub issue system.
If you want to report a security vulnerability, please review the Responsible Disclosure Policy and send
e-mail to security@bitcoinsv.io.
For any other questions or issues, please send e-mail to support@bitcoinsv.io.