UNPKG

@atomicport/bitcoin

Version:

Support Cross-Chain-Swap with HTLC on any blockchains

github.com/ymuichiro/atomic-port

ymuichiro/atomic-port

70 lines (42 loc) • 2.14 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/47295014/218366041-d07fdf06-1b72-4c6d-8fa2-89dc8266553d.png"> <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/47295014/218366194-eee5969d-3c4c-4445-9303-5368c66aac9a.png"> <img alt="logo" src="https://user-images.githubusercontent.com/47295014/218366194-eee5969d-3c4c-4445-9303-5368c66aac9a.png"> </picture> </div> [Go to top](#../../README.md) # @atomic-port/bitcoin This package is for HTLC transactions between the any blockchains. HTLC allows direct transactions between different chains. Usage and examples are shown below. <br> ## Test is now open to the public. Transactions on each chain in this library are currently available only on the testnet. If you wish to use it in a production environment, please change the network and other parameters. <br> ## Introduction Install the necessary libraries **npm** ``` npm install --save @mempool/mempool.js bip65 bitcoinjs-lib@6 ecpair tiny-secp256k1 varuint-bitcoin @atomic-port/bitcoin ``` **yarn** ``` yarn add @mempool/mempool.js bip65 bitcoinjs-lib@6 ecpair tiny-secp256k1 varuint-bitcoin @atomic-port/bitcoin ``` HTLC issues a secret and key in advance and uses this to issue a secret lock. When both parties agree to the transaction, the secret and key are exchanged separately, and the key is used to receive a token. This is how the cross-chain swap is performed. <br> ## Issue a secret lock You can publish using this package with the following operations. The output hashPair contains a secret and a proof. The secret is shared in advance, and the proof is issued at a mutually agreed timing. [lock.ts](../../examples/bitcoin/src/lock.ts) <br> ## Unlocking by Proof With a secret lock, locked assets are withdrawn through a secret proof transaction. [withDraw.ts](../../examples/bitcoin/src/withDraw.ts) <br> For more detailed examples, please check the sample collection below [examples](examples/README.md) <br> ## More Documents - [about bitcoin](https://bitcoin.org/)