@trinaryex/sdk 2.0.0 → 3.1.0

package/DESIGN.md

@@ -10,8 +10,9 @@ swagger. Remaining: npm publish (CI release workflow ready; needs NPM_TOKEN + pu
 first module, with room to grow into a higher-level, full-featured client.
 **Audience:** players and bots trading on Trinary Exchange via an API key.
 **Target (MVP):** **testnet only**, the **`stillness`** tenant; **only the most-recent (v1)
-`triexbook` contracts** are supported. Item↔currency (CRED) markets via `multicoin_pool`
-("pools"); coin-pools are out of scope for now.
+[CLOB contracts](https://github.com/loash-industries/trinary-exchange)** are supported.
+Item↔currency (CRED) markets via `multicoin_pool` ("pools"); coin-pools are out of scope
+for now.
 **Models after:** [`@trinaryex/keyspace`](https://www.npmjs.com/package/@trinaryex/keyspace)
 (client + `executor` pattern, `queries`/`transactions` split, zod validation, vite build,
 semantic-release).
@@ -20,11 +21,11 @@ semantic-release).
 
 ## 1. What this SDK is (and isn't)
 
-Trinary Exchange is a Sui-based, DeepBook-style market for an EVE-Frontier game economy.
+Trinary Exchange is a Sui-based order-book market for an EVE-Frontier game economy.
 Players trade **items** (multicoin balances, priced in the **CRED** trade currency) and
 **currency** at **trade hubs** (Smart Storage Units / SSUs) through on-chain order books
-(the `triexbook` DeepBook fork), settling through a per-player **balance manager** (the
-on-chain trading account).
+(the [Trinary Exchange CLOB Move contracts](https://github.com/loash-industries/trinary-exchange)),
+settling through a per-player **balance manager** (the on-chain trading account).
 
 The SDK gives a player/bot one object to:
 
@@ -110,7 +111,7 @@ on the free/standard tier).
                     │     (fetch + x-api-key + zod validate)       │      (Postgres read models)
                     │                                              │
                     │   transactions.ts ──build PTB──► executor()  │───► player's wallet / keypair
-                    │     (pure @mysten/sui Transaction builders)  │      └─► Sui network (triexbook)
+                    │     (pure @mysten/sui Transaction builders)  │      └─► Sui network (CLOB contracts)
                     └────────────────────────────────────────────┘
 ```
 
@@ -139,7 +140,7 @@ executor: (tx) => signAndExecuteTransaction({ transaction: tx })
 
 Executor results are **normalized** (`execute.ts`): both the v2 core-client
 `TransactionResult` and the legacy `{ digest, objectChanges }` shape work, and on-chain
-aborts are rethrown as typed `TransactionFailed` errors with the triexbook abort code
+aborts are rethrown as typed `TransactionFailed` errors with the CLOB abort code
 translated (§11 of TRIEX_SYSTEM_DESIGN). Include `effects` + `objectTypes` (v2) or
 `objectChanges` (legacy) so created objects — e.g. a freshly-created `BalanceManager` —
 are captured for read-your-writes.
@@ -216,7 +217,7 @@ const client = new TriexClient({
   network: 'testnet',                            // selects package-id bundle
   executor: (tx) => signAndExecuteTransaction({ transaction: tx, options: { showObjectChanges: true } }),
   // packageIds optional — resolved from `network` defaults, overridable:
-  // packageIds: { triexbook, multicoin, warehouseReceipts, credCoinType, clock: '0x6', ... }
+  // packageIds: { triex, multicoin, warehouseReceipts, credCoinType, clock: '0x6', ... }
 })
 ```
 
@@ -279,18 +280,18 @@ pure functions `(args) => Transaction`; the facade fills object IDs from indexer
 
 | Builder | Move target | Notes |
 |---|---|---|
-| `newBalanceManager` | `${triexbook}::balance_manager::new()` | returns BM; `transferObjects([bm], self)` when freshly created |
-| `depositCoin` | `${triexbook}::balance_manager::deposit<T>(bm, coin)` | coin prepared via list/merge/split of wallet coins |
-| `depositMulticoinObject` | `${triexbook}::balance_manager::deposit_multicoin(bm, object)` | deposit an owned multicoin `Balance` object (wallet receipts) into BM |
-| `withdrawAllCoin` | `${triexbook}::balance_manager::withdraw_all<T>(bm)` → `transferObjects` | #13 |
-| `withdrawAllMulticoin` | `${triexbook}::balance_manager::withdraw_all_multicoin(bm, collectionId, assetId)` | #12 step 1 |
+| `newBalanceManager` | `${triex}::balance_manager::new()` | returns BM; `transferObjects([bm], self)` when freshly created |
+| `depositCoin` | `${triex}::balance_manager::deposit<T>(bm, coin)` | coin prepared via list/merge/split of wallet coins |
+| `depositMulticoinObject` | `${triex}::balance_manager::deposit_multicoin(bm, object)` | deposit an owned multicoin `Balance` object (wallet receipts) into BM |
+| `withdrawAllCoin` | `${triex}::balance_manager::withdraw_all<T>(bm)` → `transferObjects` | #13 |
+| `withdrawAllMulticoin` | `${triex}::balance_manager::withdraw_all_multicoin(bm, collectionId, assetId)` | #12 step 1 |
 | `redeemReceipt` | `${warehouseReceipts}::receipt::redeem_receipt(balance, ssu, character, vaultConfig, collection, isOwner)` | #12 step 2 (BM item → hangar) |
-| `ownerProof` | `${triexbook}::balance_manager::generate_proof_as_owner(bm)` | required before placing/withdrawing |
-| `placeLimitOrderItem` | `${triexbook}::multicoin_pool::place_limit_order<Quote>(pool, bm, proof, orderType, selfMatch, price, qty, isBid, expireTs, clock)` | items (multicoin) |
-| `placeMarketOrderItem` | `${triexbook}::multicoin_pool::place_market_order<Quote>(pool, bm, proof, selfMatch, qty, isBid, clock)` | items (multicoin) |
-| `cancelOrderItem` | `${triexbook}::multicoin_pool::cancel_order<Quote>(pool, bm, proof, orderId u64, clock)` | implemented (+ `cancel_all_orders`, `modify_order`) |
-| `withdrawCoin` | `${triexbook}::balance_manager::withdraw<T>(bm, amount)` | partial currency withdraw |
-| `withdrawSettledAmounts` | `${triexbook}::multicoin_pool::withdraw_settled_amounts<Quote>(pool, bm, proof)` | claim post-fill proceeds into the BM |
+| `ownerProof` | `${triex}::balance_manager::generate_proof_as_owner(bm)` | required before placing/withdrawing |
+| `placeLimitOrderItem` | `${triex}::multicoin_pool::place_limit_order<Quote>(pool, bm, proof, orderType, selfMatch, price, qty, isBid, expireTs, clock)` | items (multicoin) |
+| `placeMarketOrderItem` | `${triex}::multicoin_pool::place_market_order<Quote>(pool, bm, proof, selfMatch, qty, isBid, clock)` | items (multicoin) |
+| `cancelOrderItem` | `${triex}::multicoin_pool::cancel_order<Quote>(pool, bm, proof, orderId u64, clock)` | implemented (+ `cancel_all_orders`, `modify_order`) |
+| `withdrawCoin` | `${triex}::balance_manager::withdraw<T>(bm, amount)` | partial currency withdraw |
+| `withdrawSettledAmounts` | `${triex}::multicoin_pool::withdraw_settled_amounts<Quote>(pool, bm, proof)` | claim post-fill proceeds into the BM |
 
 > `<Quote>` is the CRED coin type (`credCoinType`). Item markets are `multicoin_pool`; the
 > item is identified by `collectionId` + `assetId` (u64), not a Move type parameter.
@@ -351,8 +352,8 @@ back into the SSU/hangar (needs `ssu`, `character`, `vaultConfig`, `collection`,
 
 ## 7. Money math (`money.ts`)
 
-- **Coin (currency-pair) pools:** `quote = base * price / TRIEXBOOK_PRICE_SCALING`
-  where `TRIEXBOOK_PRICE_SCALING = 1_000_000_000` (1e9).
+- **Coin (currency-pair) pools:** `quote = base * price / TRIEX_PRICE_SCALING`
+  where `TRIEX_PRICE_SCALING = 1_000_000_000` (1e9).
 - **Multicoin (item) pools:** scaling factor `1` → `quote = price * quantity` (confirmed
   against the production app, which passes the unscaled price straight to
   `place_limit_order`; TRIEX_SYSTEM_DESIGN §7's blanket "all prices ×1e9" describes coin

package/README.md

@@ -5,9 +5,10 @@
 
 The official TypeScript trading SDK for
 [**Trinary Exchange**](https://trinary.exchange/), the player-built
-**EVE Frontier marketplace** — a Sui-based, DeepBook-style order-book market
-for trading items and currency across EVE Frontier trade hubs. Players and
-bots read live **EVE Frontier market data** through the
+**EVE Frontier marketplace** — a Sui-based order-book market for trading
+items and currency across EVE Frontier trade hubs, built on the
+[Trinary Exchange CLOB Move contracts](https://github.com/loash-industries/trinary-exchange).
+Players and bots read live **EVE Frontier market data** through the
 [Trinary Exchange API](https://docs.trinary.exchange/) and trade by signing
 on-chain transactions with their own wallet or keypair.
 
@@ -251,6 +252,8 @@ node --env-file=.env scripts/integration.mjs  # write paths on testnet (uses gas
 - [API documentation](https://docs.trinary.exchange/) — REST reference,
   guides, and [API keys](https://docs.trinary.exchange/docs/api-keys) for the
   Trinary Exchange trading API
+- [Trinary Exchange CLOB contracts](https://github.com/loash-industries/trinary-exchange)
+  — the Sui Move order-book contracts this SDK talks to
 - [`@trinaryex/sdk` on npm](https://www.npmjs.com/package/@trinaryex/sdk)
 - [Design notes](./DESIGN.md) — architecture, scope, and verification history
 

package/dist/ReadOnlyClient.d.ts

@@ -1,5 +1,5 @@
 import { IndexerClient } from './queries';
-import { BalancesAtHubParams, DiscoveryFilters, DiscoveryResult, FillsPage, FillsParams, HistoryPageParams, HubItemsPage, InventoryBalances, OpenOrdersPage, Orderbook, PackageIds, PoolMetadata, ReadOnlyClientConfig, Sweepable, TradeHubDetail, TradesPage, TradesParams } from './types';
+import { BalancesAtHubParams, DiscoveryFilters, DiscoveryResult, FillsPage, FillsParams, HistoryPageParams, HubItemOrderbook, HubItemsPage, InventoryBalances, OpenOrdersPage, PackageIds, PoolMetadata, ReadOnlyClientConfig, Sweepable, TradeHubDetail, TradesPage, TradesParams } from './types';
 export declare class ReadOnlyClient {
     readonly ids: PackageIds;
     readonly indexer: IndexerClient;
@@ -14,7 +14,7 @@ export declare class ReadOnlyClient {
     orderbook(params: {
         storageUnitId: string;
         assetId: string;
-    }): Promise<Orderbook>;
+    }): Promise<HubItemOrderbook>;
     poolMetadata(poolId: string): Promise<PoolMetadata>;
     balancesAtHub(params: BalancesAtHubParams & {
         balanceManagerId?: string;

package/dist/TriexClient.d.ts

@@ -1,7 +1,7 @@
 import { Transaction, TransactionObjectArgument } from '@mysten/sui/transactions';
 import { ClientWithCoreApi } from '@mysten/sui/client';
 import { IndexerClient } from './queries';
-import { BalancesAtHubParams, CancelAllOrdersParams, CancelOrderParams, ClaimSettledParams, CurrencyBalances, DepositCurrencyParams, DepositItemsParams, DiscoveryFilters, DiscoveryResult, EnsureAccountResult, FillsPage, FillsParams, HistoryPageParams, HubItemsPage, InventoryBalances, LimitOrderParams, MarketOrderParams, ModifyOrderParams, OpenOrdersPage, Orderbook, PackageIds, PoolMetadata, Sweepable, TradeHubDetail, TradesPage, TradesParams, TradingAccount, TransactionExecutor, TriexClientConfig, TxResult, WithdrawCurrencyParams, WithdrawItemsParams } from './types';
+import { BalancesAtHubParams, CancelAllOrdersParams, CancelOrderParams, ClaimSettledParams, CurrencyBalances, DepositCurrencyParams, DepositItemsParams, DiscoveryFilters, DiscoveryResult, EnsureAccountResult, FillsPage, FillsParams, HistoryPageParams, HubItemOrderbook, HubItemsPage, InventoryBalances, LimitOrderParams, MarketOrderParams, ModifyOrderParams, OpenOrdersPage, PackageIds, PoolMetadata, Sweepable, TradeHubDetail, TradesPage, TradesParams, TradingAccount, TransactionExecutor, TriexClientConfig, TxResult, WithdrawCurrencyParams, WithdrawItemsParams } from './types';
 export declare class TriexClient {
     readonly suiClient: ClientWithCoreApi;
     readonly ids: PackageIds;
@@ -59,7 +59,7 @@ declare class MarketApi {
     orderbook(params: {
         storageUnitId: string;
         assetId: string;
-    }): Promise<Orderbook>;
+    }): Promise<HubItemOrderbook>;
     poolMetadata(poolId: string): Promise<PoolMetadata>;
 }
 declare class OrdersApi {

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export type { AccountApi, BalancesApi, MarketApi, OrdersApi, } from './TriexClie
 export { ReadOnlyClient } from './ReadOnlyClient';
 export { TriexError, TriexClientError, explainMoveAbort } from './errors';
 export { DEFAULT_INDEXER_URL, CLOCK_ID, STILLNESS_PACKAGE_IDS, NETWORK_PRESETS, resolvePackageIds, } from './config';
-export { toBase, fromBase, computeItemQuote, computeBidQuoteDeposit, estimateMarketBuyCost, marketBuyRoundingBuffer, TRIEXBOOK_PRICE_SCALING, MULTICOIN_PRICE_SCALING, FEE_RATE_SCALING, GTC_EXPIRE, } from './money';
+export { toBase, fromBase, computeItemQuote, computeBidQuoteDeposit, estimateMarketBuyCost, marketBuyRoundingBuffer, TRIEX_PRICE_SCALING, MULTICOIN_PRICE_SCALING, FEE_RATE_SCALING, GTC_EXPIRE, } from './money';
 export { IndexerClient } from './queries';
 export * as transactions from './transactions';
 export { getWalletCurrencyBalance, getBalanceManagerCurrencyBalance, getBalanceManagerItemBalance, getRegistryMulticoinCollectionId, findOwnedItemReceipts, fetchCharacterInfo, fetchSsuOwnerInfo, fetchInventorySlotQuantity, toSsuObjectId, getObjectRef, } from './onchain';
@@ -15,5 +15,5 @@ export type { BookLevel } from './book';
 export { iterateDiscovery, iterateFills, iterateTrades } from './paging';
 export type { IterateOptions } from './paging';
 export { untilIndexed } from './wait';
-export type { TriexNetwork, PackageIds, TriexClientConfig, ReadOnlyClientConfig, TransactionExecutor, ObjectChange, TxResult, OrderSide, TradingAccount, CurrencyBalances, AssetBalance, InventoryBalances, TradeHubDetail, HubVaultInfo, HubLocation, HubItem, HubItemsPage, CollectionHub, Orderbook, OrderbookOrder, PoolMetadata, DiscoveryOrder, DiscoveryResult, DiscoveryFilters, OpenOrder, OpenOrdersPage, Fill, FillsPage, Trade, TradesPage, BalancesAtHubParams, HistoryPageParams, FillsParams, TradesParams, Sweepable, SweepablePool, SweepableItem, EnsureAccountResult, DepositCurrencyParams, DepositItemsParams, WithdrawCurrencyParams, WithdrawItemsParams, LimitOrderParams, MarketOrderParams, CancelOrderParams, CancelAllOrdersParams, ModifyOrderParams, ClaimSettledParams, } from './types';
+export type { TriexNetwork, PackageIds, TriexClientConfig, ReadOnlyClientConfig, TransactionExecutor, ObjectChange, TxResult, OrderSide, TradingAccount, CurrencyBalances, AssetBalance, InventoryBalances, TradeHubDetail, HubVaultInfo, HubLocation, HubItem, HubItemsPage, CollectionHub, Orderbook, HubItemOrderbook, HubItemMarket, OrderbookOrder, PoolMetadata, DiscoveryOrder, DiscoveryResult, DiscoveryFilters, OpenOrder, OpenOrdersPage, Fill, FillsPage, Trade, TradesPage, BalancesAtHubParams, HistoryPageParams, FillsParams, TradesParams, Sweepable, SweepablePool, SweepableItem, EnsureAccountResult, DepositCurrencyParams, DepositItemsParams, WithdrawCurrencyParams, WithdrawItemsParams, LimitOrderParams, MarketOrderParams, CancelOrderParams, CancelAllOrdersParams, ModifyOrderParams, ClaimSettledParams, } from './types';
 export type { OwnedItemReceipt, CharacterInfo, SsuOwnerInfo, ObjectRef, } from './onchain';