otc state

AddToken

AddToken whitelists a token by its grc20reg key, enabled (W2).

SetTokenEnabled

SetTokenEnabled switches new offers on a token on or off. Open offers on a disabled token can still be filled and cancelled (W2).

SetFeeBps

SetFeeBps sets the default fee for NEW offers (F4, F5).

SetGnomicFee

SetGnomicFee turns the reduced GNOMIC fee on or off and sets it (F6).

SetFeeRecipient

SetFeeRecipient changes where fees go.

SetPaused

SetPaused blocks or allows new offers and fills. It never blocks Cancel (A2, R10).

TransferAdmin

TransferAdmin hands the admin role to another address.

requireAdmin

requireFee

adminAddress

feeRecipientAddress

gnomicTokenKey

defaultFeeBps

gnomicFeeEnabled

gnomicFeeBps

bpsDenominator

feeOf

feeOf is bps of amount, rounded down (F1). Split so that a large amount cannot overflow on the multiplication: bps is at most feeCapBps, so both terms stay far below int64 max.

feeFor

feeFor picks the fee a new offer on tokenKey is created with (F4, F6).

addSat

addSat adds two non-negative totals without wrapping (S5). The totals are statistics, not money: one that stops at the ceiling is better than one that turns negative.

maxInt64

ugnot

feeCapBps

Fixed limits. They are not configuration: config.gno is regenerated by scripts/render.sh at deploy, and a security cap must be the one the tests ran against.

defaultPageSize

Fixed limits. They are not configuration: config.gno is regenerated by scripts/render.sh at deploy, and a security cap must be the one the tests ran against.

maxPageSize

Fixed limits. They are not configuration: config.gno is regenerated by scripts/render.sh at deploy, and a security cap must be the one the tests ran against.

maxTokens

Fixed limits. They are not configuration: config.gno is regenerated by scripts/render.sh at deploy, and a security cap must be the one the tests ran against.

EventOfferCreated

Events. Every one carries the offer id and the addresses involved.

EventOfferFilled

Events. Every one carries the offer id and the addresses involved.

EventOfferCancelled

Events. Every one carries the offer id and the addresses involved.

EventAdminChanged

Events. Every one carries the offer id and the addresses involved.

EventFeeChanged

Events. Every one carries the offer id and the addresses involved.

EventFeeRecipientChanged

Events. Every one carries the offer id and the addresses involved.

EventTokenChanged

Events. Every one carries the offer id and the addresses involved.

EventPaused

Events. Every one carries the offer id and the addresses involved.

admin

feeRecipient

realmAddr

webPath

// "/r/\<namespace>/otc", for gnoweb links

feeBps

gnomicKey

gnomicFeeOn

gnomicFee

paused

tokens

offers

openPublic

byMaker

lastID

totalFees

// ugnot sent to the fee recipient (F7)

totalVolume

// sum of GnotAmt over filled offers (F7)

filledCount

init.50

CreateSellToken

CreateSellToken escrows tokenAmt of the token and asks gnotAmt ugnot for it. The maker must first Approve this realm's address for exactly tokenAmt in the token's realm; only that amount is pulled (S4). Returns the offer id.

CreateSellGnot

CreateSellGnot escrows the ugnot sent with the call and asks tokenAmt of the token for it. Only a direct user call may attach coins (S1). Returns the offer id.

newOffer

index

Fill

Fill takes an open offer in full (R8). - SellToken: attach exactly GnotAmt ugnot; direct user call only (S1). - SellGnot: attach nothing (S2) and first Approve this realm for exactly TokenAmt; the tokens go straight from the taker to the maker. The fee comes off the GNOT side and goes to the fee recipient in the same call (F2, F3).

Cancel

Cancel returns the escrow to the maker. Only the maker can call it (R11), at any time, including after expiry and while paused (R10).

closeOffer

expired

expired is true once block time reaches ExpiresAt (R9). An expired offer stays Open until its maker cancels it (R10, R11).

mustOffer

requireTokenEnabled

requireUser

requireUser insists on a direct user call (S1). The coin envelope belongs to the whole message, so a realm in the middle could spend it elsewhere and leave OriginSend describing a payment this realm never received — the "phantom payment" of atomicswap.NewCustomCoinSwap. \`maketx run\` is refused for the same reason.

sentUgnot

sentUgnot returns the ugnot attached to the call, and refuses any envelope that is not exactly one positive ugnot coin.

requireNoCoins

requireNoCoins refuses any coin on a call that is not meant to receive one (S2): this realm has no way to send stray coins back.

pay

padID

padID makes ids sort as numbers in the trees.

emitCreated

RealmAddress

GetOffer

GetOffer returns one offer as JSON, public or private.

ListOpen

ListOpen returns open public offers, newest first (S9).

ListByMaker

ListByMaker returns every offer of one maker, private and closed ones included, newest first.

GetConfig

GetConfig returns the parameters and the whitelist as JSON.

GetStats

GetStats returns the running totals as JSON (F7).

Render

Render serves "" (stats and the first page), "page/N" and "offer/ID".

renderHome

renderOffer

listJSON

offerJSON

tokenInfo

jstr

jstr quotes a string for JSON.

num

num64

units

units formats base units with dec decimals, trailing zeros dropped.

bps

short

link

link is an absolute gnoweb link to one of this realm's Render paths. gnoweb rejects a bare ":path" destination and prints it as plain text.

expiry

expiry is the Expires cell: the date, marked once it has passed.

when

Side

Side says which half of the offer the maker escrowed.

SellToken

// maker escrows the token, taker pays GNOT

SellGnot

// maker escrows GNOT, taker pays the token

Status

Status is Open until the offer is filled or cancelled. Both are terminal (R12).

Open

Filled

Cancelled

Offer

Offer is one escrowed trade: exactly one GRC20 side and one GNOT side (R1).

ErrPaused

Errors are short and stable so that tests and the frontend can match them.

ErrNotUser

Errors are short and stable so that tests and the frontend can match them.

ErrNoCoins

Errors are short and stable so that tests and the frontend can match them.

ErrBadPayment

Errors are short and stable so that tests and the frontend can match them.

ErrBadAmount

Errors are short and stable so that tests and the frontend can match them.

ErrBadExpiry

Errors are short and stable so that tests and the frontend can match them.

ErrBadAddress

Errors are short and stable so that tests and the frontend can match them.

ErrTakerIsMaker

Errors are short and stable so that tests and the frontend can match them.

ErrTokenNotListed

Errors are short and stable so that tests and the frontend can match them.

ErrTokenDisabled

Errors are short and stable so that tests and the frontend can match them.

ErrTokenUnknown

Errors are short and stable so that tests and the frontend can match them.

ErrTokenExists

Errors are short and stable so that tests and the frontend can match them.

ErrTooManyTokens

Errors are short and stable so that tests and the frontend can match them.

ErrNoOffer

Errors are short and stable so that tests and the frontend can match them.

ErrNotOpen

Errors are short and stable so that tests and the frontend can match them.

ErrNotMaker

Errors are short and stable so that tests and the frontend can match them.

ErrNotTaker

Errors are short and stable so that tests and the frontend can match them.

ErrOwnOffer

Errors are short and stable so that tests and the frontend can match them.

ErrExpired

Errors are short and stable so that tests and the frontend can match them.

ErrNotAdmin

Errors are short and stable so that tests and the frontend can match them.

ErrFeeAboveCap

Errors are short and stable so that tests and the frontend can match them.

ErrFeeToRealm

Errors are short and stable so that tests and the frontend can match them.