Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stove-labs/zk-htlc
https://github.com/stove-labs/zk-htlc
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/stove-labs/zk-htlc
- Owner: stove-labs
- License: apache-2.0
- Created: 2022-09-17T09:01:55.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2022-11-23T18:30:29.000Z (about 2 years ago)
- Last Synced: 2023-03-02T20:06:12.922Z (almost 2 years ago)
- Language: TypeScript
- Size: 344 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZK HTLC | Zero Knowledge Hash Time Locked Contract
> ⚠️ This repository is a work in progress, it has not been audited or tested thoroughly. Use at your own risk.
ZK HTLC is an experimental implementation of the HTLC protocol built with SnarkyJS. Allowing users to trustlessly and atomicaly swap assets/tokens.
It supports both the native MINA token, and (previously experimental) protocol built-in custom tokens. More about HTLC can be found [here](https://en.bitcoin.it/wiki/Hash_Time_Locked_Contracts).
## 🎲 Features
- Supports native MINA token
- Supports custom protocol built-in tokens
- Currently only supports Poseidon as the hashing function
## 🛫 HTLC Roundtrip
> 💡 Both `HTLCPoseidonNative` and `HTLCPoseidonExperimentalToken` can be used interchangably, depending on the tokens/assets being exchanged.
**🔒 Initial setup**
1. Alice wants to atomically swap 10 MINA for 10 TOKEN with Bob
2. Alice deploys an instance of `HTLCPoseidonNative`
3. Alice calls `HTLCPoseidonNative.lock(...)`, specifying Bob as the recipient and providing 10 MINA to the contract as the amount being locked. At this point Alice also chooses/generates a secret, and provides a hash of the secret (`hashlock`) to the contract.
4. Bob deploys an instance of `HTLCPoseidonExperimentalToken`, with the respective `tokenId` representing the token being handled in this case.
5. Bob calls `HTLCPoseidonExperimentalToken.lock()`, specifying Alice as the recipient and providing 10 TOKEN to the contract as the amount being locked. Bob also provides the same hashlock as Alice did to hers instance.
**🔓 Unlocking locked assets/tokens**
1. Alice calls Bob's `HTLCPoseidonExperimentalToken.unlock()`, providing the secret used to generate the hashlock used to deploy both of their contracts. This reveals the secret to Bob automatically and transfers the funds (10 TOKEN) from the contract to Alice. The secret is stored on-chain within the contract.
2. Bob calls Alice's `HTLCPoseidonNative.unlock()`, using the secret he obtained from Alice. This transfers the funds (10 MINA) from the contract to Bob.
3. Done!
**📆 Edge cases**
For a case when one of the participants fails to unlock the locked tokens in a given timelock period, the creator of each contract can refund their locked tokens using the `.refund()` method.
## Credits
Special thanks to [Gregor](https://github.com/mitschabaude), [Jack](https://github.com/jackryanservia) and [O1 Labs](https://github.com/o1-labs) for their work on SnarkyJS.
## License
[Apache-2.0](LICENSE)