Search Apps Documentation Source Content File Folder Download Copy Actions Download State String Boolean Number Struct Map Slice Pointer Function Closure Reference Nil Package Type Interface Unknown

pool package

Function

Collect

func Collect( cur realm, token0Path string, token1Path string, fee uint32, recipient address, tickLower int32, tickUpper int32, amount0Requested string, amount1Requested string, ) (string, string)

Collect pays tokens owed to a position out to recipient in full. No withdrawal fee is charged on this path; see CollectSwapFee for the fee-bearing path.

Parameters:

  • cur: Current realm context; callers use cross(cur) when crossing into this realm.
  • token0Path: Path of the first token in the pool pair.
  • token1Path: Path of the second token in the pool pair.
  • fee: Fee tier identifying the pool.
  • recipient: Non-zero address receiving the owed token amounts.
  • tickLower: Lower inclusive tick boundary of the position range.
  • tickUpper: Upper exclusive tick boundary of the position range.
  • amount0Requested: Decimal token0 amount requested from the position's accrued principal.
  • amount1Requested: Decimal token1 amount requested from the position's accrued principal.

Returns:

  • amount0: Token0 principal transferred to recipient, as a decimal string.
  • amount1: Token1 principal transferred to recipient, as a decimal string.

Halt check: reverts while the Withdraw halt scope is active.

Params

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/gnoswap/pool" -func "Collect" -args $'' -args $'' -args $'' -args $'' -args $'' -args $'' -args $'' -args $'' -gas-fee 1000000ugnot -gas-wanted 1_000_000_000 -send "" -chainid "gnoland-1" -remote "http://127.0.0.1:26657" ADDRESSgnokey query -remote "http://127.0.0.1:26657" auth/accounts/ADDRESS
gnokey maketx call -pkgpath "gno.land/r/gnoswap/pool" -func "Collect" -args $'' -args $'' -args $'' -args $'' -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 "gnoland-1" -account-number ACCOUNTNUMBER -account-sequence SEQUENCENUMBER ADDRESS
gnokey broadcast -remote "http://127.0.0.1:26657" call.tx