PredictTxBuilders class

client.tx.* — each returns a ready-to-sign Transaction. Market-resolving builders are async.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cancelSupplyPlp(String owner, BigInt index) → Transaction

Cancel a still-pending supply request by queue index, refunding its escrowed USDC straight back into the requesting account. Command order is auth → cancel.

cancelWithdrawPlp(String owner, BigInt index) → Transaction

Cancel a still-pending withdraw request by queue index, refunding its escrowed PLP straight back into the requesting account. Command order is auth → cancel.

claimSettled(String owner, {required String underlying, required Object expiryMs, String? marketId, required BigInt orderId}) → Future<Transaction>

Claim a settled position in full. Takes only the order id — a settled claim closes the order in full.

createManager() → Transaction

Create the sender's canonical account wrapper and share it.

deposit(String owner, Object amountUsdc, {bool create = false}) → Transaction

Deposit amountUsdc (human units, num or decimal String) into the owner's account.

mint(String owner, MarketDescriptor m, MintOptions opts) → Future<Transaction>

Mint an exact payout quantity (see MintOptions).

mintAmount(String owner, MarketDescriptor m, MintAmountOptions opts) → Future<Transaction>

Mint by spending up to a premium budget (see MintAmountOptions).

mintCost(String owner, MarketDescriptor m, MintCostOptions opts) → Future<Transaction>

V2 all-in budget mint; use minQuantity to protect the fill against slippage.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

redeem(String owner, MarketDescriptor m, CloseOptions opts) → Future<Transaction>

Close a live position (see CloseOptions).

setBuilderCode(String owner, String builderCodeId) → Transaction

Set the account's sticky builder-code attribution to builderCodeId, an existing BuilderCode object borrowed as &BuilderCode. Command order is auth → set (auth is a hot potato consumed by this call). Lives in the PREDICT package's predict_account module, NOT the account package.

supplyPlp(String owner, Object amountUsdc, [PlpSupplyOptions options = const PlpSupplyOptions()]) → Transaction

Queue a supply request pulling amountUsdc from the account's existing custody balance. request_supply auto-settles USDC then account.withdraws the payment into queue escrow; the PLP fill is delivered at the next flush, not returned here. Command order is auth → request (auth is a hot potato consumed by this call). The minPlpOut slot is the per-request floor on PLP minted at flush — PlpSupplyOptions.minPlpOut when given, otherwise 0 (no floor). At the shipped attempt count of one, the first flush whose mark quotes less cancels and refunds the request; three is the configurable maximum, not the default.

toString() → Side

A string representation of this object.

inherited

unsetBuilderCode(String owner) → Transaction

Clear the account's sticky builder-code attribution. Command order is auth → unset.

withdraw(String owner, Object amountUsdc, {bool toCoinObject = false}) → Transaction

Withdraw amountUsdc from the account back to owner. By default the funds land in the owner's USDC address balance (the versionless accumulator) via 0x2::coin::send_funds — no coin-object churn, and they merge into the same balance deposit draws from, closing the loop. Pass toCoinObject: true to instead receive a discrete Coin<T> object (for wallets/explorers that only render coin objects, or to compose the coin further in your own PTB). Either way the underlying withdraw_funds returns the raw Coin<T> — the PTB-callable form that folds settle → authorize → load → withdraw; command order is auth → withdraw.

withdrawPlp(String owner, BigInt shares, [PlpWithdrawOptions options = const PlpWithdrawOptions()]) → Transaction

Queue a withdraw request pulling shares (raw PLP u64) from account custody into queue escrow — the Move parameter is named amount, but on request_withdraw it counts PLP SHARES, not USDC. Auto-settles flush-delivered PLP first; the USDC fill lands on the account at the next flush (no withdraw_settled entrypoint). Command order is auth → request. The minUsdcOut slot is the per-request floor on USDC paid at flush — PlpWithdrawOptions.minUsdcOut when given, otherwise 0 (no floor). At the shipped attempt count of one, the first flush whose mark quotes less cancels and refunds the request; three is the configurable maximum, not the default.

Operators

operator ==(Object other) → bool

The equality operator.

inherited