Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sCrypt-Inc/boilerplate
sCrypt project boilerplate
https://github.com/sCrypt-Inc/boilerplate
Last synced: about 2 months ago
JSON representation
sCrypt project boilerplate
- Host: GitHub
- URL: https://github.com/sCrypt-Inc/boilerplate
- Owner: sCrypt-Inc
- Created: 2020-02-13T21:02:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-19T13:38:59.000Z (5 months ago)
- Last Synced: 2024-08-02T14:05:31.903Z (5 months ago)
- Language: TypeScript
- Size: 4.83 MB
- Stars: 318
- Watchers: 18
- Forks: 84
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-scrypt - sCrypt Project Boilerplate - Official boilerplate with 80 contract examples and growing. (Code Samples / Community)
README
[](https://github.com/sCrypt-Inc/boilerplate/actions/workflows/ci.yml)
[](https://app.travis-ci.com/sCrypt-Inc/boilerplate)
A collection of smart contract examples along with tests, implemented using [sCrypt](https://scrypt.io), a Typescript framework to write smart contracts on Bitcoin.
Install all dependencies first.
```sh
npm install
```
## Local Tests
In order to run smart contract tests locally, just simply run:
```sh
npm t
```
This will run every test defined under `tests/`.
To run tests only for a specific smart contract, i.e. the `Counter` smart contract, you can run the following:
```sh
npx scrypt-cli@latest compile -i "src/contracts/counter.ts" && \
NETWORK="local" npx mocha --no-config --require ts-node/register tests/counter.test.ts
```
You can also manually adjust paths under `tsconfig-scryptTS.json` (contract to compile) and `.mocharc.json` (test files to run) and simply run `npm t`.
To understand how the tests work, please read the [sCrypt docs](https://scrypt.io/docs/how-to-test-a-contract).
## Test on the Bitcoin Testnet
This repository also contains tests for the testnet. They will deploy and call contracts on chain, so you first need to have some testnet coins.
First, generate a private key along with an address:
```
npm run genprivkey
```
This will store a private key in a file named `.env`. Additionally, it will output its address to the console, which you can then fund from a [faucet](https://scrypt.io/faucet).
Once the address is funded, you can either run
```sh
npm run testnet
```
to run all defined testnet tests, or:
```sh
npm run build && npx mocha 'dist/tests/testnet/.js'
```
to run a specific contract test.
## Debug Smart Contract Code
In order to debug smart contract code in [Visual Studio Code](https://code.visualstudio.com), you need to configure `launch.json` (located under `.vscode/`). This repository already has an example configuration for the `Demo` smart contract.
See the [docs](https://scrypt.io/docs/how-to-debug-a-contract/#use-visual-studio-code-debugger) for more information on how to use the debugger.
## Project Structure
- `src/contracts` - This is where all the smart contract code is. Each file is for a separate smart contract example, e.g. the `P2PKH` smart contract is defined inside `src/contracts/p2pkh.ts`.
- `tests/` - This is the directory which contains smart contract tests. They can be executed locally or on testnet, depending on the `NETWORK` environment variable. Each smart contract has its separate test file.
## Legacy boilerplate
The old boilerplate code which was using the now deprecated legacy sCrypt was deprecated in favour of our new Typescript-based implementation.
You can still find the old code under the [`legacy` branch](https://github.com/sCrypt-Inc/boilerplate/tree/legacy).