Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sCrypt-Inc/cat-contracts
A collection of CATful Bitcoin smart contracts written in sCrypt.
https://github.com/sCrypt-Inc/cat-contracts
Last synced: 2 months ago
JSON representation
A collection of CATful Bitcoin smart contracts written in sCrypt.
- Host: GitHub
- URL: https://github.com/sCrypt-Inc/cat-contracts
- Owner: sCrypt-Inc
- Created: 2024-06-26T11:29:36.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-09-09T12:14:47.000Z (4 months ago)
- Last Synced: 2024-09-09T19:43:06.758Z (4 months ago)
- Language: TypeScript
- Size: 210 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-op-cat - CATful contract collection
- awesome-op-cat - CATful contract collection
README
# sCrypt CAT Smart Contracts
A collection of CATful smart contracts for BTC written in sCrypt.
## Configure Private Key
First, we need to create a .env file with our private key, which should contain some signet funds:
```
PRIVATE_KEY="cTE..."
```
You may obtain signet funds via these faucets:
- https://signetfaucet.com/
- https://alt.signetfaucet.com
- https://x.com/babylon_chain/status/1790787732643643575
## Build
```sh
npm run build
```
## Testing Locally
```sh
npm run test
```
## Testing on Signet
To run the tests on the signet network, we need to run a local bitcoin inquisition node.
### Step 1: Install Bitcoin Core Inquisition
Download the Bitcoin Core Inquisition from [GitHub](https://github.com/bitcoin-inquisition/bitcoin/releases).
### Step 2: Connect to a CAT-ready Relay Node
The Bitcoin client will automatically find nearby relay nodes for broadcasting transactions. However, these nodes may not support the new OP_CAT version and could refuse to broadcast it due to default policies against OP_SUCCESSXX. Thus, we need to configure our node to relay transactions to an inquisition node.
Add the following to the node configuration:
```
signet=1
daemon=1
[signet]
addnode=inquisition.taprootwizards.com
```
### Step 3: Broadcast transactions
Once we have our node up and running, we can start broadcasting our transactions. The tests by default output the serialized transactions which run the smart contract.
For example if we'd like to test the counter smart contract on signet, we'd first run the local test individually:
```sh
npx scrypt-cli@latest compile -i "src/contracts/counter.ts" && \
NETWORK=testnet npx mocha --no-config --require ts-node/register tests/counter.test.ts
```
```
Test SmartContract `Counter`
...
txFee (serialized):
....
tx0 (serialized):
...
tx1 (serialized):
...
tx2 (serialized):
...
```
We can now broadcast the serialized transactions one by one using `bitcoin-cli`, which is bundled with your node software:
```sh
./bin/bitcoin-cli --conf= sendrawtransaction 020000000001022...
```
If everything succeeds, the command should output a TXID.
Note, that the TX may not be immediately visible on block explorers such as [Mempool](https://mempool.space/signet), since they only accept the transaction once it's mined into a block by an inquisition node.