@atomicport/bitcoin
TypeScript icon, indicating that this package has built-in type declarations

0.0.1 • Public • Published
logo

Go to top

@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.


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.


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.


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


Unlocking by Proof

With a secret lock, locked assets are withdrawn through a secret proof transaction.

withDraw.ts


For more detailed examples, please check the sample collection below examples


More Documents

Package Sidebar

Install

npm i @atomicport/bitcoin

Weekly Downloads

0

Version

0.0.1

License

MIT

Unpacked Size

36.5 kB

Total Files

19

Last publish

Collaborators

  • ymuichiro