https://github.com/topnotch1998/bitcoin-staking-cltv
Non Custodial Staking on Bitcoin Network. Use RedeemScript for Lock BTC. CLTV(lock timestamp) enables us make non-custodial staking on bitcoin network
https://github.com/topnotch1998/bitcoin-staking-cltv
bitcoin bitcoinjs-lib cltv non-custodial redeem-script staking typescript
Last synced: about 1 month ago
JSON representation
Non Custodial Staking on Bitcoin Network. Use RedeemScript for Lock BTC. CLTV(lock timestamp) enables us make non-custodial staking on bitcoin network
- Host: GitHub
- URL: https://github.com/topnotch1998/bitcoin-staking-cltv
- Owner: topnotch1998
- Created: 2025-04-24T08:10:23.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2025-04-24T08:12:07.000Z (about 1 month ago)
- Last Synced: 2025-04-27T14:12:11.552Z (about 1 month ago)
- Topics: bitcoin, bitcoinjs-lib, cltv, non-custodial, redeem-script, staking, typescript
- Language: TypeScript
- Homepage:
- Size: 61.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Readme
This repository contains TypeScript/JavaScript samples to compose the `stake` and `redeem` transactions on Bitcoin network. The targeted readers should have knowledge on Bitcoin transaction formats and are familiar with TS/JS programming languages.
Quick link to technical design (draft version): https://famous-exoplanet-701.notion.site/BTC-Staking-Transaction-Design-v2-bfa311f7f19e45688a944fb9c1e32c59.
For those who want a more user friendly interface, please test it out on https://stake.dev.btcs.network.
## Test Environment
Please test the function on Core Devnet which links to BTC Testnet.
Core Devnet faucet https://scan.dev.btcs.network/faucet.
Notes:
- It is recommended to lock BTC for more than 8 hours in Devnet, because only staking transaction longer than 6 hours (lock timestamp - BTC tx confirmation time with 4 blocks) are counted as as feasible.
## How to
### Program by yourself
If you want to write your own scripts to enable BTC staking on Core, please take the [sample](sample.ts) as a reference.
### Run the script directly
If you want to use the tool directly, please run `npm install` and scripts below. For more information about the parameters, please check the [index](index.ts) file.
`stake BTC`
``` shell
node dist/index.js stake --account tb1qzdvhlak7y8kz0v5hu2tw7qae3969jzrt7rj7n5 --privatekey ${private key} --amount 1000000 --bitcoinnetwork 2 --corenetwork 2 --locktime 1712847585 --rewardaddress 0x2a5F963BaC7bf136f6a0ff98356b52F0B49Af71A --validatoraddress 0x3aE030Dc3717C66f63D6e8f1d1508a5C941ff46D
```
If successful, you will see the console returns transaction id, the locked P2SH/P2WSH script address and the redeem script, which will be used on the following redeem transaction. Please save them properly.
Example
``` shell
txId: 7b531ab17b93114bb5b74e6b14e5ff99f447f139544099f166a98517b423a7c9
address: 2N7LJiG1ZGk97jUuhDcsRquPjgxFjT273fi
redeemScript: 04e1fa1766b17576a91413597ff6de21ec27b297e296ef03b9897459086b88ac
```
`redeem BTC`
```shell
node dist/index.js redeem --account 2N7LJiG1ZGk97jUuhDcsRquPjgxFjT273fi --redeemscript 04e1fa1766b17576a91413597ff6de21ec27b297e296ef03b9897459086b88ac --privatekey ${private key} --destaddress tb1qzdvhlak7y8kz0v5hu2tw7qae3969jzrt7rj7n5
```
`claim CORE rewards`
Please visit https://stake.dev.btcs.network, connect to the site using the reward address (0x2a5F963BaC7bf136f6a0ff98356b52F0B49Af71A in the sample) and you can see the BTC staking transaction and claim rewards once system distributes in each round. # bitcoin-staking-CLTV