@parchment-trade/sdk 0.0.0-stage → 1.0.0

package/dist/packages/index.js

@@ -0,0 +1,5 @@
+export { EMERGENCY_CLOSE_DISABLED_MS, MARKET_STATUS_ACTIVE, MARKET_STATUS_REDUCE_ONLY, MARKET_STATUS_RETIRED, ORDER_PARAMS_V1_BCS, ORDER_TX_NOTE, PUBLIC_INTS, bindTradingReferrerTxBody, transferAccountTxBody, cancelOrderTxBody, claimPendingMintTxBody, claimQuestTxBody, claimTxBody, exitEarlyBoundedTxBody, exitEarlyTxBody, releaseUnlockedTxBody, closePreviewBody, closeRetiredTxBody, depositTxBody, gameTxBody, openCratesTxBody, installTreasuryTxBody, lpHarvestTxBody, openAccountTxBody, registerBuilderTxBody, setBuilderPayoutTxBody, createBuilderTxBody, setBuilderFeeTxBody, builderOwnerTxBody, transferBuilderTxBody, approveBuilderTxBody, revokeBuilderApprovalTxBody, BUILDER_FEE_HARD_BPS, MAX_BUILDER_CREATE_FEE, setBuilderCreateFeeTxBody, stakeTxBody, sweepSurplusTxBody, unstakeTxBody, withdrawTxBody, decodeOrderParams, closeRetiredAsDelegateTxBody, emergencyCloseAsDelegateTxBody, grantDelegateTxBody, grantCloseDelegateTxBody, grantSessionAndTriggerTxBody, revokeSessionAndTriggerTxBody, revokeDelegateTxBody, NEAR_LIQ_DISTANCE_FRACTION, TRIGGER_PROOF_TTL_MS, TRIGGER_PROOF_VERSION, newTriggerIntentId, signTriggerProof, stopAgainstLiquidation, triggerBindBody, triggerPrepareBody, triggerProofMessage, triggerRequestBody, emergencyCloseDisabled, emergencyCloseTxBody, expireOrderTxBody, hasPendingOrderSlot, isEmergencyAfterDisabled, openPreviewBody, orderParamsFromJson, orderRefTxBody, requestCloseAsDelegateTxBody, requestCloseTxBody, requestOpenAsDelegateTxBody, requestOpenTxBody, assertDelegateLiveThroughFill, DELEGATE_FILL_MARGIN_MS, ORDER_ABORT_MESSAGES, ORDER_ABORT_NAMES, ORACLE_RESERVED_ABORT_CODES, ORDER_RESERVED_ABORT_CODES, TRADE_RESERVED_ABORT_CODES, MIN_CANCEL_DELAY_MS, ORDER_FINALIZED_EVENT_BCS, ORDER_OUTCOMES, ORDER_REFUND_SESSION_MESSAGE, ORDER_REQUESTED_EVENT_BCS, PARCHMENT_CANDLES_BATCH_MAX_MARKETS, PARCHMENT_SPONSORED_ACTIONS, PARCHMENT_TRADE_MODULES, ParchmentAccount, ParchmentMarket, TX_ACTIONS, TRADE_ABORT_MESSAGES, TRADE_ABORT_NAMES, FEE_MINT_ABORT_MESSAGES, FEE_MINT_ABORT_NAMES, MARKET_ABORT_MESSAGES, MARKET_ABORT_NAMES, ACCESS_ABORT_NAMES, ACCOUNT_ABORT_NAMES, CONFIG_ABORT_NAMES, BUILDER_ABORT_NAMES, REFERRAL_ABORT_NAMES, STAKING_ABORT_NAMES, DECLARED_NOT_RAISED_ABORT_CODES, EXCHANGE_ABORT_NAMES, HOLDER_BOOK_ABORT_NAMES, ACCOUNT_TRANSFER_ABORT_NAMES, ABORT_MODULE_PATHS, ABORT_NAME_MAPS, AUTHORITY_ABORT_NAMES, FEES_ABORT_NAMES, GAME_ABORT_MESSAGES, GAME_ABORT_NAMES, KEEPER_ABORT_NAMES, EVENT_GUARD_ABORT_NAMES, LIQ_BOOK_ABORT_NAMES, LP_ABORT_NAMES, ORACLE_ABORT_NAMES, ORACLE_ADAPTER_ABORT_NAMES, POSITION_ABORT_NAMES, TIMELOCK_ABORT_NAMES, LOCKED_MINT_ABORT_NAMES, MINT_CAP_ABORT_NAMES, UNCOVERED_MODULES, LOCKED_LEDGER_STATUSES, RETAINED_FEE_CURVE_DEFAULTS, RETAINED_FEE_CURVE_MAX_COV_BPS, addSetRetainedFeeCurveCall, lpRetainedFeeCurve, retainedFeeCurve, retainedStakerShareBps, abortMessage, abortName, boundFromSlippage, decodeAbortCode, decodeOrderFinalizedEvent, finalizedOrdersFromTx, orderOutcome, decodeOrderRequestedEvent, isParchmentTradeModule, marketIsActive, marketIsDelisted, marketIsRetired, marketMinHoldMs, marketNextSessionOpenMs, marketSessionEndsAtMs, liquidationPaused, requestsPausedMessage, orderAbortMessage, orderAbortName, effectiveCancelAfterMs, orderExpiresAfterMs, parchmentBaseTypePackageId, parchmentCallPackageId, parchmentCoreTypePackageId, parchmentGameTypePackageId, parchmentMintTypePackageId, parchmentTradeTypePackageId, requireSplitPackageIds, requestedOrderIdFromTx, requestedOrdersFromTx, SPONSOR_IN_FLIGHT_LIMIT, SPONSOR_NOT_DELEGATE, isSessionKeyRevoked, shouldPayOwnGas, sponsorBody, SESSION_KEY_EXPIRY_MARGIN_MS, SESSION_KEY_TTL_MS, MAX_SPONSOR_PROOF_LIFETIME_MS, SPONSOR_PROOF_LIFETIME_MS, assertSessionTradeKind, createSessionKey, isSponsoredCopyOf, liveSessionDelegate, sessionKeyExpiryMs, sessionKeyFromSecret, sessionKeySecret, signSessionSponsoredTx, signSponsorProof, sponsorProofMessage, tradeAbortMessage, FORCE_CLOSE_SESSION_MAX_IDS, BatchCloseError, CLOSE_BATCH_BUDGET, SPONSOR_BATCH_BUDGET, SUI_TX_LIMITS, batchCloseTx, closeBatchTopUps, closeBatchUsage, fitCloseBatch, legIsRequest, planCloseBatches, splitCloseBatches, txIntentViolation, untrustedConfigPackages, UNCHECKED_TX, GAME_REGISTRY_MAXIMA, gameEventLimitsFromDefinitions, playerProgressionEvents, addArmSessionCloseAdminCall, addArmSessionCloseCall, addSessionRefundCall, addForceCloseSessionCall, addMintPendingForCalls, buildMintPendingForTx, addOneSignatureOnboardingCalls, deriveAccountId, MONITORING_MAX_DAYS, monitoringPath, monitoringView, statsActivityPath, statsActivityView, STAKING_HISTORY_WINDOWS, stakingHistoryPath, stakingHistoryView, parseLivePrice, parseTrade, } from "./parchment/index.js";
+export { EVENT_CLOSE_ARMED_EVENT_BCS, EVENT_GUARD_MAX_WINDOW_MS, EVENT_LEVERAGE_CAP_UPDATED_EVENT_BCS, EVENT_PAUSE_UPDATED_EVENT_BCS, EVENT_REASON, addArmEventCloseCall, addClearEventLeverageCapCall, addClearEventPauseCall, addEventGuardAdminClearCall, addSetEventLeverageCapCall, addSetEventPauseCall, decodeEventCloseArmedEvent, decodeEventLeverageCapUpdatedEvent, decodeEventPauseUpdatedEvent, eventGuardEventType, } from "./parchment/index.js";
+export { TRIGGER_LEVELS_COMMITTED_BCS, TRIGGER_LEVELS_SET_EVENT_BCS, decodeTriggerLevelsCommitted, decodeTriggerLevelsSetEvent } from "./parchment/index.js";
+export { addRequestOpenWithTriggersCall, addRequestOpenWithTriggersAsDelegateCall, addSetTriggerLevelsCall, addSetTriggerLevelsAsDelegateCall } from "./parchment/index.js";
+export { LOCKED_WEIGHT_SYNCED_EVENT_BCS, LOCKED_YIELD_CLAIMED_EVENT_BCS, LOCKED_YIELD_FORFEITED_EVENT_BCS, LOCKED_WEIGHT_BPS_UPDATED_EVENT_BCS, decodeLockedWeightSyncedEvent, decodeLockedYieldClaimedEvent, decodeLockedYieldForfeitedEvent, decodeLockedWeightBpsUpdatedEvent, addSyncLockedCall, addSyncLockedCalls, addForfeitLockedYieldCall, } from "./parchment/index.js";

package/dist/packages/parchment/abortCodes.d.ts

@@ -0,0 +1,196 @@
+/**
+ * Abort codes left reserved by removed guards: the TWAP price guard (oracle 3,
+ * order 18, trade 30) and the signed bid/ask band (trade 26
+ * `EPriceOutsideSignedBand`, oracle 18 `EBadSignedRange`), and order 23 `ENeedsStoragePrice` (retired:
+ * every `order::expire` takes an expiry price now). Never raised; each number stays taken so
+ * no other code shifts. They have no name or copy here, so they fall through to the caller's generic
+ * unknown-abort message.
+ */
+export declare const TRADE_RESERVED_ABORT_CODES: readonly number[];
+export declare const ORDER_RESERVED_ABORT_CODES: readonly number[];
+export declare const ORACLE_RESERVED_ABORT_CODES: readonly number[];
+/**
+ * Declared, not raised (lead 6:08 AM): constants A keeps in the Move source with their numbers reserved,
+ * but no code path aborts with them today: `trade` 0 `EBadVersion`, 10 `ELpInsolvent`, 16 `ENotAuthorized`,
+ * `order` 1 `ENotAuthorized` and `oracle` 0 `EBadVersion`. Their names stay in `TRADE_ABORT_NAMES`,
+ * `ORDER_ABORT_NAMES` and `ORACLE_ABORT_NAMES` (same as the service's `abort_name` for trade/order). Doc only.
+ */
+export declare const DECLARED_NOT_RAISED_ABORT_CODES: Readonly<Record<string, readonly number[]>>;
+/**
+ * Friendly messages for Move abort codes the SDK documents.
+ * Keys are on-chain abort codes within the named module.
+ */
+export declare const TRADE_ABORT_MESSAGES: Readonly<Record<number, string>>;
+/**
+ * `trade` module abort code -> Move constant name, from the `#[error(code = N)]` declarations in
+ * `parchment_trade::trade` (`trade.move`); 30 is reserved and unnamed. Same module/code pairs as the
+ * service's `abort_name`.
+ */
+export declare const TRADE_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * Look up a friendly trade abort message, or undefined when unknown. Accepts a raw clever-error
+ * abort code (every `trade` abort on chain is one) or the decoded N.
+ */
+export declare function tradeAbortMessage(code: number | bigint | string): string | undefined;
+/**
+ * `order` module abort code -> Move constant name, from the `#[error(code = N)]` declarations in
+ * `parchment_trade::order` (`order.move`). On chain the abort code is a clever-error bitset;
+ * `decodeAbortCode` extracts N from it.
+ */
+export declare const ORDER_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * Friendly messages for `order` module aborts, keyed by constant name. On chain, `order.move`
+ * aborts carry numeric `#[error(code = N)]` codes 0-12, 14-17, 19-22 and 24-31 (not names; 13 is unused, 18 and 23 are reserved); `ORDER_ABORT_NAMES` maps
+ * them to these keys. The service's `abort_name` is already a name. `orderAbortMessage`
+ * accepts either form.
+ */
+export declare const ORDER_ABORT_MESSAGES: Readonly<Record<string, string>>;
+/**
+ * The `#[error(code = N)]` value of a Move abort code. A clever-error bitset (top nibble
+ * `0b1100`) carries N in bits 48..55; a plain abort code is returned unchanged. Returns
+ * undefined for a bitset without an error code, or input that is not a non-negative u64.
+ */
+export declare function decodeAbortCode(raw: number | bigint | string): number | undefined;
+/** The `order` constant name for a raw or decoded abort code, or undefined when unknown. */
+export declare function orderAbortName(code: number | bigint | string): string | undefined;
+/**
+ * Look up a friendly order abort message, or undefined when unknown. Accepts the constant name
+ * (`"ECancelTooEarly"`, as in the service's `abort_name`) or the on-chain abort code: a number,
+ * bigint or decimal string, either plain (`8`) or the raw clever-error u64.
+ */
+export declare function orderAbortMessage(nameOrCode: string | number | bigint): string | undefined;
+/**
+ * `market` and `fee_mint` abort code -> Move constant name, from the `#[error(code = N)]`
+ * declarations in `parchment::market` (0-10) and `parchment_trade::fee_mint` (0-2). Every declared code
+ * (the drift test checks them against the contract source); message copy only for 8 / 2.
+ */
+export declare const MARKET_ABORT_NAMES: Readonly<Record<number, string>>;
+export declare const FEE_MINT_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * `parchment::exchange` and `parchment::access` abort code -> Move constant name, from their explicit
+ * `#[error(code = N)]` declarations (exchange 0-9, 11-16 (14 is `EHarvestAuth`); access 0, the extension timelock 1-4, then 5-9).
+ * Admin/keeper-side, so names only (no message copy). Same module/code pairs as the service's `abort_name`.
+ */
+export declare const EXCHANGE_ABORT_NAMES: Readonly<Record<number, string>>;
+export declare const ACCESS_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * `parchment::builder_book` / `parchment::referral_book` abort code -> Move constant name (writer-level
+ * ceilings, behind the `builder` / `referral` checks, so normal flows raise those codes instead). Names only.
+ */
+export declare const BUILDER_BOOK_ABORT_NAMES: Readonly<Record<number, string>>;
+export declare const REFERRAL_BOOK_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * `parchment::account` abort code -> Move constant name (`account.move` 0-7). Cap/delegate mismatches
+ * raise 2 / 6. Names only, no message copy, like the service's `abort_name` (which only logs them).
+ */
+export declare const ACCOUNT_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * `parchment_base::holder_book` abort code -> Move constant name. One account per wallet: the
+ * `account_transfer::transfer_account` recipient (or the sender itself) already holds an account.
+ */
+export declare const HOLDER_BOOK_ABORT_NAMES: Readonly<Record<number, string>>;
+/** `parchment_trade::account_transfer` abort code -> Move constant name. */
+export declare const ACCOUNT_TRANSFER_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * `parchment_trade::game_book` abort code -> Move constant name. 0: admin `game_book::attach` on an
+ * Exchange that already has the game book (once per Exchange; the split moved game_book out of `parchment`).
+ * 1-3: writer-level ceilings behind the `game` checks (normal flows raise `game` codes instead).
+ */
+export declare const GAME_BOOK_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * `parchment::config` abort code -> Move constant name (`config.move` 0-28, 100 and 101). Names only,
+ * no message copy. 7 (the builder share ceiling) is unassigned: builder codes no longer take a share.
+ * 9 (`EBadExecFeeRecipient`) is `set_exec_fee_recipient(@0x0)`. 10-26 are the
+ * selective-pause categories raised by `assert_unpaused` (24 was `EOrderCancelsPaused`; that category
+ * was removed, cancel/expire are never paused, so 24 is unassigned). 27 (`EBadBuilderFee`): a builder
+ * fee limit or max above 100 bps. 28 (`EBadBuilderCreateFee`): a creation price above $100. 101 (`EGuardianCannotUnpause`): only the admin can unpause.
+ */
+export declare const CONFIG_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * `parchment_trade::referral`, `parchment_trade::builder` and `parchment_token::staking` abort code ->
+ * Move constant name, from their `#[error(code = N)]` declarations (referral 0-5, builder 0, 2, 4-6,
+ * 8-14, staking 0-13). Names only, no message copy. The `@0x0` rejections: referral 5
+ * and staking 13 (`bind_referrer(.., @0x0)`), builder 5 (payout `@0x0`) and 6 (owner `@0x0`). Builder
+ * codes are on-top only, so the share, payout-uniqueness and enable-gate codes (1, 3, 7) are gone.
+ */
+export declare const REFERRAL_ABORT_NAMES: Readonly<Record<number, string>>;
+export declare const BUILDER_ABORT_NAMES: Readonly<Record<number, string>>;
+export declare const STAKING_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * `parchment_trade::oracle` abort code -> Move constant name (`oracle.move` 0-2, 4-6, 8-17, 19-20). 3 and 18 are
+ * reserved (removed TWAP guard and signed range check, see `ORACLE_RESERVED_ABORT_CODES`) and 7 was never
+ * declared: all stay unnamed. 19 `ETimestampWindow` rejects a regular-session window quote on a one-step path.
+ * 0 is declared, not raised. 13 `EGapTooShort` / 14 `ESessionArmed` / 16 `ENotKeeper` gate the keeper
+ * `arm_session_close` (which arms from a signed-closed Lazer session even while storage is fresh); 15 (`EOracleKilled`) is the kill switch and 17 (`EMarketClosesPaused`) the per-market
+ * close pause, both raised by the fullpause oracle guards. Names only, no message copy.
+ */
+export declare const ORACLE_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * `parchment_game::game` and the `parchment_trade::game` facade share these codes (`game.move`).
+ * The short key `game` is the impl. `abortName("parchment_trade::game", n)` uses `game_facade`.
+ * 13 (`EBadBatch`) is an `open_crates` count of 0. 6 (`ECooldown`) is retired (no crate cooldown) and
+ * kept for completeness. Names only except
+ * `GAME_ABORT_MESSAGES`.
+ */
+export declare const GAME_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * Smaller modules, names only (no message copy), from their `#[error(code = N)]` declarations:
+ * `parchment_trade::keeper` (0), `parchment_trade::fees` (0-1), `parchment::timelock` (0, 2, 4-7; 1, 3 and 8 removed),
+ * `parchment::position` (0-4), `parchment::liq_book` (0-1), `parchment::lp` (0), `parchment::authority` (0)
+ * and `parchment_oracle::adapter` (1-10; code 0 is retired, not used).
+ */
+export declare const KEEPER_ABORT_NAMES: Readonly<Record<number, string>>;
+/** `parchment_trade::event_guard` (0-9): keeper event pause, event leverage cap and event close. */
+export declare const EVENT_GUARD_ABORT_NAMES: Readonly<Record<number, string>>;
+export declare const FEES_ABORT_NAMES: Readonly<Record<number, string>>;
+export declare const TIMELOCK_ABORT_NAMES: Readonly<Record<number, string>>;
+export declare const POSITION_ABORT_NAMES: Readonly<Record<number, string>>;
+export declare const LIQ_BOOK_ABORT_NAMES: Readonly<Record<number, string>>;
+export declare const LP_ABORT_NAMES: Readonly<Record<number, string>>;
+/** `parchment::authority` only; the vendored `oracle_aggregator::authority` is in `UNCOVERED_MODULES`. */
+export declare const AUTHORITY_ABORT_NAMES: Readonly<Record<number, string>>;
+export declare const ORACLE_ADAPTER_ABORT_NAMES: Readonly<Record<number, string>>;
+/**
+ * `parchment_mint::locked_mint` and `parchment_mint::mint_cap` abort code -> Move constant name. These
+ * modules abort with plain `const EName: u64 = N` codes (no `#[error]`). The trade facades delegate
+ * and do not raise them. locked_mint 3 (was `EBadTarget`, from the removed `admin_redirect`) has
+ * no constant; 4 (`ETooManyBuckets`) is reserved, no longer raised. Names only, no message copy.
+ */
+export declare const LOCKED_MINT_ABORT_NAMES: Readonly<Record<number, string>>;
+export declare const MINT_CAP_ABORT_NAMES: Readonly<Record<number, string>>;
+/** Friendly messages for `market` aborts, keyed by constant name. */
+export declare const MARKET_ABORT_MESSAGES: Readonly<Record<string, string>>;
+/** Friendly messages for `game` aborts a player can hit with a bad input, keyed by constant name. */
+export declare const GAME_ABORT_MESSAGES: Readonly<Record<string, string>>;
+/** Friendly messages for `fee_mint` aborts, keyed by constant name. */
+export declare const FEE_MINT_ABORT_MESSAGES: Readonly<Record<string, string>>;
+/**
+ * Every `abortName` module key -> its code -> constant name map. Keys are Move module names; each one
+ * means exactly the module in `ABORT_MODULE_PATHS` (e.g. `config` is `parchment::config`, not the vendored
+ * `oracle_aggregator::config`).
+ */
+export declare const ABORT_NAME_MAPS: Readonly<Record<string, Readonly<Record<number, string>>>>;
+/**
+ * `ABORT_NAME_MAPS` key -> the full Move module path it covers. `abortName` also accepts these paths,
+ * which is how a short-name collision (`config`, `authority`) is told apart.
+ */
+export declare const ABORT_MODULE_PATHS: Readonly<Record<string, string>>;
+/**
+ * Contract modules with `#[error(code = N)]` that `abortName` deliberately does not name (full path ->
+ * reason). The vendored `pyth_lazer` modules use code-less `#[error]` constants and are not listed.
+ */
+export declare const UNCOVERED_MODULES: Readonly<Record<string, string>>;
+/**
+ * The Move constant name for an abort in `module`, from a raw clever-error code or the decoded N.
+ * `module` is an `ABORT_NAME_MAPS` key (`trade`, `order`, `oracle`, `game`, `game_book`, `keeper`, `event_guard`, `fees`, `market`,
+ * `fee_mint`, `exchange`, `access`, `account`, `config`, `timelock`, `position`, `liq_book`, `lp`,
+ * `authority`, `adapter`, `referral`, `builder`, `builder_book`, `referral_book`, `staking`, `locked_mint`, `mint_cap`, `game_facade`) or its full path from `ABORT_MODULE_PATHS`
+ * (`parchment::config`); undefined for other modules (see `UNCOVERED_MODULES`), reserved and unknown codes.
+ */
+export declare function abortName(module: string, code: number | bigint | string): string | undefined;
+/**
+ * A friendly message for an abort in `module` (`trade`, `order`, `market`, `fee_mint` or `game`), from the
+ * constant name (the service's `abort_name`) or the raw/decoded code; undefined when unknown and for
+ * every other (names-only) `ABORT_NAME_MAPS` module and for codes in `market` / `fee_mint` / `game` without copy.
+ */
+export declare function abortMessage(module: string, nameOrCode: string | number | bigint): string | undefined;