/atomicswap package

Overview

Package atomicswap implements a hash time-locked contract (HTLC) for atomic swaps between native coins (ugnot) or GRC20 tokens.

An atomic swap allows two parties to exchange assets in a trustless way, where either both transfers happen or neither does. The process works as follows:

Alice wants to swap with Bob. She generates a secret and creates a swap with Bob's address and the hash of the secret (hashlock).
Bob can claim the assets by providing the correct secret before the timelock expires. The secret proves Bob knows the preimage of the hashlock.

3. If Bob doesn't claim in time, Alice can refund the assets back to herself.

Example usage for native coins:

Example

1// Alice creates a swap with 1000ugnot for Bob
2secret := "mysecret"
3hashlock := hex.EncodeToString(sha256.Sum256([]byte(secret)))
4id, _ := atomicswap.NewCoinSwap(bobAddr, hashlock) // -send 1000ugnot
5
6// Bob claims the swap by providing the secret
7atomicswap.Claim(id, "mysecret")

Example usage for GRC20 tokens:

Example

1// Alice approves the swap contract to spend her tokens
2token.Approve(swapAddr, 1000)
3
4// Alice creates a swap with 1000 tokens for Bob
5id, _ := atomicswap.NewGRC20Swap(bobAddr, hashlock, "gno.land/r/demo/token.TKN")
6
7// Bob claims the swap by providing the secret
8atomicswap.Claim(id, "mysecret")

If Bob doesn't claim in time (default 1 week), Alice can refund:

Example

1atomicswap.Refund(id)

Function

NewCustomGRC20Swap


              func NewCustomGRC20Swap(cur realm, recipient address, hashlock string, timelock time.Time, token *grc20.Token) (int, *Swap)

NewCustomGRC20Swap creates a new atomic swap contract for grc20 tokens. It is not callable with `gnokey maketx call`, but can be imported by another contract or `gnokey maketx run`.

Command

# WARNING: This command is running in an INSECURE mode.
# It is strongly recommended to use a hardware device for signing
# and avoid trusting any computer connected to the internet,
# as your private keys could be exposed.

gnokey maketx call -pkgpath "gno.land/r/demo/defi/atomicswap" -func "NewCustomGRC20Swap" -args $'' -args $'' -args $'' -args $'' -gas-fee 1000000ugnot -gas-wanted 1_000_000_000 -send "" -chainid "dev" -remote "https://api.gno.berty.io:443" ADDRESSgnokey query -remote "https://api.gno.berty.io:443" auth/accounts/ADDRESS
gnokey maketx call -pkgpath "gno.land/r/demo/defi/atomicswap" -func "NewCustomGRC20Swap" -args $'' -args $'' -args $'' -args $'' -gas-fee 1000000ugnot -gas-wanted 1_000_000_000 -send "" -broadcast=false ADDRESS > call.tx
gnokey sign -tx-path call.tx -chainid "dev" -account-number ACCOUNTNUMBER -account-sequence SEQUENCENUMBER ADDRESS
gnokey broadcast -remote "https://api.gno.berty.io:443" call.tx

Overview

Function

Params

Command