v2 state

MarketJSON

MarketJSON returns one market with its quote history.

MarketsJSON

MarketsJSON returns every market in creation order as one JSON array.

PositionJSON

PositionJSON returns one open position; an empty one if the owner holds nothing there or has claimed.

PositionsJSON

PositionsJSON returns the owner's open positions in market creation order. Claimed positions are gone; their record is in the Claimed events.

RealmJSON

RealmJSON returns the roles, settings, limits and totals.

historyJSON

jsonString

scale

maxInt64

MaxFeePpm

MinPricePpm

MaxPricePpm

DisputeWindow

AbandonAfter

minQuoteTTL

maxQuoteTTL

maxMinSpread

maxHistory

StateOpen

Market states. A market moves between open and paused, from either to proposed, and from proposed to final. A cancelled proposal returns it to paused; abandonment takes an open or paused market to final (Void).

StatePaused

Market states. A market moves between open and paused, from either to proposed, and from proposed to final. A cancelled proposal returns it to paused; abandonment takes an open or paused market to final (Void).

StateProposed

Market states. A market moves between open and paused, from either to proposed, and from proposed to final. A cancelled proposal returns it to paused; abandonment takes an open or paused market to final (Void).

StateFinal

Market states. A market moves between open and paused, from either to proposed, and from proposed to final. A cancelled proposal returns it to paused; abandonment takes an open or paused market to final (Void).

Market

All amounts are integer ugnot. One million micro-shares is one share; a winning micro-share pays one ugnot (one whole share pays one GNOT).

QuotePoint

QuotePoint records one published quote, in block-time order.

Position

Position is an open holding. It is deleted when its holder claims, so the storage it used is released; the Claimed event keeps the record.

marketRecord

Limits

Limits bound new purchases. They never affect claims.

administrator

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

pendingAdministrator

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

quoter

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

pendingQuoter

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

guardian

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

pendingGuardian

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

lister

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

pendingLister

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

listingOracle

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

listingTreasury

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

listingFeePpm

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

realmPaused

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

quoteTTL

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

minSpreadPpm

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

maxExposure

// micro-shares owed if every open market ends on its larger side

openExposure

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

defaultLimits

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

records

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

marketIDs

OriginCaller is used only at package initialization, to capture the deployer as the first holder of every role. Entry points use the live caller.

totalHeldUgnot

// every market's escrow plus fees still held

Administrator

Quoter

Guardian

Lister

ProposeRole

ProposeRole starts a two-step handover of "admin", "quoter", "guardian" or "lister". The proposed address accepts from its own direct call, so a mistyped address cannot take a role.

AcceptRole

AcceptRole completes a handover started by ProposeRole.

RevokeRole

RevokeRole empties the quoter, guardian or lister role at once, for a lost or stolen key. The administrator role can only be handed over.

SetSettings

SetSettings changes the quote lifetime, the minimum spread and the realm-wide exposure cap. They apply to new quotes and purchases only.

SetLimits

SetLimits changes one market's purchase limits, or with id "" the limits new markets start with.

SetListingTerms

SetListingTerms fixes the oracle, treasury and fee rate every market listed by the lister must carry. A lister key can then only add markets on these terms; it can never choose who settles them or where their surplus goes.

CreateMarket

CreateMarket freezes every field used to match an external result, the fee rate, the oracle and the treasury. Nothing but the quote and the limits can change later. The administrator chooses the terms; the lister must use the listing terms.

SetQuote

SetQuote publishes both prices while trading is open or paused. The quoter may sign it with a session key. expectedVersion refuses a quote made from a stale view. The same prices again only renew the quote's time, so the keeper can keep an unchanged quote from expiring without a new version.

Pause

Pause stops new purchases in one market, or with id "" in every market. The quoter (also with a session key), the guardian and the administrator can pause; only the administrator resumes. Claims are never paused.

Resume

Resume reopens one paused market, or with id "" lifts the realm-wide pause.

Fund

Fund adds reserve capital to one market. It backs that market's sales and returns to the market's treasury only after the market is final.

Buy

Buy creates a position after exact payment of cost plus fee, within the limits, and only while the market's escrow covers its larger side. expectedPricePpm is the price of the chosen outcome that the buyer reviewed. A buyer may sign with a session key: the position is always the account's.

ProposeOutcome

ProposeOutcome records the oracle's Yes, No or Void with the market's entire source binding and an evidence hash. Trading stops at once. After the dispute window anyone can make it final; within it the guardian can cancel. A Polymarket 50-50 result is proposed as Void.

CancelProposal

CancelProposal lets the guardian reject a proposed outcome within the dispute window. The market returns to paused; the oracle can propose again.

Finalize

Finalize makes a proposed outcome final once the dispute window has passed. Anyone can call it.

VoidAbandoned

VoidAbandoned voids a market that is still unsettled AbandonAfter trading ended. Anyone can call it; every holder then takes back what they paid.

settle

Claim

Claim settles the caller's position in a final market and deletes it. On Yes or No each winning micro-share pays one ugnot; on Void the holder gets back the cost and the fee they paid. A losing position closes with zero.

WithdrawSurplus

WithdrawSurplus sends what a final market no longer owes anyone to its fixed treasury: the escrow above unclaimed payouts or refunds, and on Yes or No the fees. Anyone can call it; the destination was fixed at listing.

Surplus

Surplus returns what WithdrawSurplus would send now: collateral and fees. It is zero for a market that is not final.

owedCollateral

owedCollateral is what the escrow must still pay holders for an outcome.

owedFees

owedFees is what the fees must still return to holders: all of them on Void.

GetMarket

GetPosition

IsPaused

QuoteTTL

Quote

Quote returns the exact cost and fee for buying microShares of an outcome at the current price. A buyer sends cost + fee.

Fee

Fee is the service fee in ugnot for microShares at pricePpm and rate feePpm: θ × shares × price × (1 − price) GNOT, rounded up to the ugnot. It is computed exactly as ceil(microShares × feePpm × price × (10^6 − price) / 10^18).

ListMarkets

QuoteHistory

QuoteHistory returns a detached copy of the published quotes.

BindingHash

Hash UTF-8 length-framed text, shared exactly with the backend source binding.

caller

assertUser

assertOwnKey

assertOwnKey also refuses a session key: listing, settings, roles, resuming and resolution need the account's own signature. Session keys may only quote, pause, buy and claim.

assertNoSend

singleSend

assertBankCoverage

mustMarket

checkQuote

checkQuote keeps each side inside the band and the pair at or above one GNOT plus the minimum spread, so buying both sides can never be a sure gain.

outcomePrice

quoteCost

checkedAdd

maximum

require

isHash

isSlug

isSlug keeps market IDs safe in paths and links: lowercase letters, digits and single hyphens.

isTopic

isTopic allows an empty topic or up to 24 letters and spaces, such as "Politics".

isLabel

isLabel allows an outcome name of 1 to 48 bytes of printable UTF-8 without surrounding spaces or markup characters, such as "Yes" or "Los Angeles Dodgers".

isTokenID

decimal

appURL

appURL is the exchange interface; the realm page links to it for trading.

pagePath

pagePath is this realm's gnoweb path, captured at deployment so links between its pages work on any chain and namespace.

historyRows

Render

Render draws the realm's public page on gnoweb: the market list at the root and one page per market at ":\<id>". It is informational; the app reads JSON.

renderIndex

renderMarket

status

outcomeName

outcomeName is the outcome as the market names it: Yes and No are the first and second token, shown by their names fixed at listing.

priceText

priceText formats millionths like the app: at least two decimals, no trailing zeros beyond them (420000 is "0.42", 425000 is "0.425").

dayText

timeText

countText

escapeText

escapeText keeps question and rules text literal in Markdown, tables included.

escapeCode

escapeCode keeps an untrusted path inside one inline code span.