@trinaryex/sdk 3.8.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/DESIGN.md +253 -71
  2. package/README.md +218 -16
  3. package/dist/ReadOnlyClient.d.ts +42 -8
  4. package/dist/TriexClient.d.ts +73 -8
  5. package/dist/armature/OrgClient.d.ts +372 -0
  6. package/dist/armature/OrgClientGroups.d.ts +186 -0
  7. package/dist/armature/OrgsApi.d.ts +69 -0
  8. package/dist/armature/actions.d.ts +75 -0
  9. package/dist/armature/create.d.ts +27 -0
  10. package/dist/armature/currency.d.ts +64 -0
  11. package/dist/armature/executors.d.ts +44 -0
  12. package/dist/armature/governance.d.ts +194 -0
  13. package/dist/armature/harness.d.ts +96 -0
  14. package/dist/armature/lifecycle.d.ts +84 -0
  15. package/dist/armature/plan.d.ts +39 -0
  16. package/dist/armature/proposals.d.ts +51 -0
  17. package/dist/armature/queries.d.ts +16 -0
  18. package/dist/armature/schemas.d.ts +559 -0
  19. package/dist/armature/trading.d.ts +114 -0
  20. package/dist/armature/transactions.d.ts +160 -0
  21. package/dist/armature/treasury.d.ts +41 -0
  22. package/dist/armature/tree.d.ts +13 -0
  23. package/dist/armature/types.d.ts +59 -0
  24. package/dist/armature/upgrade.d.ts +27 -0
  25. package/dist/armature/vault.d.ts +94 -0
  26. package/dist/coins/CoinsApi.d.ts +53 -0
  27. package/dist/coins/funding.d.ts +6 -0
  28. package/dist/coins/money.d.ts +36 -0
  29. package/dist/coins/onchain.d.ts +162 -0
  30. package/dist/coins/schemas.d.ts +456 -0
  31. package/dist/coins/transactions.d.ts +82 -0
  32. package/dist/coins/types.d.ts +115 -0
  33. package/dist/errors.d.ts +11 -1
  34. package/dist/funding.d.ts +2 -2
  35. package/dist/http.d.ts +3 -0
  36. package/dist/index.d.ts +63 -8
  37. package/dist/index.js +10587 -959
  38. package/dist/money.d.ts +15 -0
  39. package/dist/moveAbort.d.ts +28 -0
  40. package/dist/moveAbortCatalog.generated.d.ts +9 -0
  41. package/dist/onchain.d.ts +55 -3
  42. package/dist/paging.d.ts +9 -3
  43. package/dist/queries.d.ts +35 -7
  44. package/dist/schemas.d.ts +1911 -50
  45. package/dist/transactions.d.ts +63 -1
  46. package/dist/types.d.ts +116 -7
  47. package/package.json +3 -1
package/dist/index.d.ts CHANGED
@@ -1,19 +1,74 @@
1
1
  export { TriexClient } from './TriexClient';
2
- export type { AccountApi, BalancesApi, MarketApi, OrdersApi, SpatialApi, } from './TriexClient';
2
+ export type { AccountApi, BalancesApi, CharactersApi, MarketApi, OrdersApi, RoutingApi, SpatialApi, WorldApi, } from './TriexClient';
3
3
  export { ReadOnlyClient } from './ReadOnlyClient';
4
- export { TriexError, TriexClientError, explainMoveAbort } from './errors';
4
+ export { OrgsApi } from './armature/OrgsApi';
5
+ export { OrgHandle } from './armature/OrgClient';
6
+ export type { OrgHandleDeps, RunOutcome } from './armature/OrgClient';
7
+ export { OrgQueries, MAX_BATCH_IDS } from './armature/queries';
8
+ export { TriexError, TriexClientError, explainMoveAbort, explainMoveAbortDetailed, parseMoveAbort, unpackAbortCode, } from './errors';
9
+ export type { MoveAbortExplanation, AbortCodeBits } from './errors';
10
+ export { MOVE_ABORT_CATALOG } from './moveAbortCatalog.generated';
11
+ export type { MoveAbortEntry, MoveAbortName, } from './moveAbortCatalog.generated';
5
12
  export { DEFAULT_INDEXER_URL, CLOCK_ID, STILLNESS_PACKAGE_IDS, NETWORK_PRESETS, resolvePackageIds, } from './config';
6
- export { toBase, fromBase, computeItemQuote, computeBidQuoteDeposit, estimateMarketBuyCost, marketBuyRoundingBuffer, TRIEX_PRICE_SCALING, MULTICOIN_PRICE_SCALING, FEE_RATE_SCALING, GTC_EXPIRE, } from './money';
13
+ export { toBase, fromBase, computeItemQuote, computeQuoteFee, computeBidQuoteDeposit, computeAskProceeds, estimateMarketBuyCost, estimateMarketSellProceeds, marketBuyRoundingBuffer, TRIEX_PRICE_SCALING, MULTICOIN_PRICE_SCALING, FEE_RATE_SCALING, GTC_EXPIRE, } from './money';
7
14
  export { IndexerClient } from './queries';
8
15
  export * as transactions from './transactions';
9
- export { getWalletCurrencyBalance, getBalanceManagerCurrencyBalance, getBalanceManagerItemBalance, getRegistryMulticoinCollectionId, findOwnedItemReceipts, fetchCharacterInfo, fetchSsuOwnerInfo, fetchInventorySlotQuantity, toSsuObjectId, getObjectRef, } from './onchain';
10
- export { prepareWalletCoinInput, sourceItemsIntoBalanceManager, } from './funding';
16
+ export { getWalletCurrencyBalance, getTradingAccountCurrencyBalance, getTradingAccountItemBalance, getPoolTradingFees, getTradingAccountAllowList, findOwnedTradingAccountCaps, tradingAccountCapType, findOwnedItemReceipts, fetchCharacterInfo, fetchSsuOwnerInfo, fetchInventorySlotQuantity, toSsuObjectId, getObjectRef, } from './onchain';
17
+ export { prepareWalletCoinInput, sourceItemsIntoTradingAccount, } from './funding';
11
18
  export { normalizeExecuteResult, executeAndNormalize, findCreatedObject, } from './execute';
12
19
  export type { NormalizedExecution, CreatedObject } from './execute';
13
20
  export { aggregateLevels, bestBid, bestAsk, midPrice, spread, depth, vwap, } from './book';
14
21
  export type { BookLevel } from './book';
15
- export { iterateDiscovery, iterateFills, iterateTrades } from './paging';
22
+ export { iterateDiscovery, iterateFills, iterateHubLocations, iterateItemLocations, iterateOpenOrders, iterateOrgDirectory, iterateRecentTrades, iterateTrades, } from './paging';
16
23
  export type { IterateOptions } from './paging';
17
24
  export { untilIndexed } from './wait';
18
- export type { TriexNetwork, PackageIds, TriexClientConfig, ReadOnlyClientConfig, TransactionExecutor, ObjectChange, TxResult, OrderSide, TradingAccount, CurrencyBalances, AssetBalance, InventoryBalances, TradeHubDetail, HubVaultInfo, HubLocation, HubLocationPage, HubLocationFilters, LocationPageParams, NearbyHub, NearbyHubsParams, NearbyHubsBySystemParams, HubEnriched, AssemblyOwner, AssemblyEnriched, BalanceManagerOwner, SolarSystemName, Coordinates, SolarSystem, SolarSystemSuggestion, NearbySystem, NearbySystems, NearbySystemsParams, BatchSystems, BatchSystemsParams, CoordinateSearch, CoordinateSearchParams, AutocompleteSystems, SpatialStats, HubItem, HubItemsPage, ItemRecipe, ItemRecipeComponent, ItemSearchPage, ItemSearchResult, 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';
19
- export type { OwnedItemReceipt, CharacterInfo, SsuOwnerInfo, ObjectRef, } from './onchain';
25
+ export { DISPLAY_PRICE_TIERS, JUMP_TYPES, ORDER_STATUSES, ORDER_TYPES, ROUTE_OPTIMIZATIONS, } from './schemas';
26
+ export type { TriexNetwork, PackageIds, TriexClientConfig, ReadOnlyClientConfig, TransactionExecutor, ObjectChange, TxResult, OrderSide, TradingAccount, CurrencyBalances, AssetBalance, InventoryBalances, TradeHubDetail, HubVaultInfo, HubLocation, HubLocationPage, HubLocationFilters, LocationPageParams, NearbyHub, NearbyHubsParams, NearbyHubsBySystemParams, HubEnriched, AssemblyOwner, AssemblyEnriched, TradingAccountOwner, SolarSystemName, Coordinates, SolarSystem, SolarSystemSuggestion, NearbySystem, NearbySystems, NearbySystemsParams, BatchSystems, BatchSystemsParams, CoordinateSearch, CoordinateSearchParams, AutocompleteSystems, SpatialStats, HubItem, HubItemsPage, ItemRecipe, ItemRecipeComponent, ItemSearchPage, ItemSearchResult, 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, CancelOrdersParams, PoolSelector, TradingFeesParams, MintCapParams, MintCapResult, RevokeCapParams, TradingAccountCaps, CreatePoolParams, CreatePoolResult, ClaimOperatorShareParams, OrderDetail, OrderDetailFill, OrderParty, OrderCharacter, OrderHub, OrderCurrency, OrderLookupParams, FillDetail, RecentTrade, RecentTradesPage, RecentTradesParams, DisplayPrice, DisplayPriceParams, DisplayPricesParams, HubEconomics, PoolFees, PlatformStats, StatsQuoteVolume, StatsTopItem, StatsTopOrg, Character, CharacterLookup, Tribe, WorldItem, ItemInfo, Recipe, RecipeMaterial, Route, RouteComparison, RouteOptimization, RouteParams, RouteShipParams, RoutingStats, Waypoint, } from './types';
27
+ export type { OwnedItemReceipt, CharacterInfo, SsuOwnerInfo, ObjectRef, OwnedTradingAccountCap, FeeTier, AccountFeeRates, TradingFees, } from './onchain';
28
+ export type { TradingAccountCapKind, SwapWithTradingAccountArgs, } from './transactions';
29
+ export { POOL_CREATION_FEE } from './transactions';
30
+ export { execContextFor, findNodeAcross, flattenOrg, nodeById, resolveSeat, roleForDepth, rootNode, seatsFor, tradingNode, } from './armature/tree';
31
+ export type { AccessibleKeyspace, HubDaoVault, KeyspaceMatchVia, KeyspaceRole, Org, OrgActor, OrgDirectoryEntry, OrgDirectoryPage, OrgDirectoryParams, OrgMetadata, OrgNode, OrgSearchParams, OrgSearchResult, OrgSeat, OuExecContext, OuParent, ProposalCompositeStep, ProposalStatus, ProposalSummary, VaultAclEntry, VaultPrincipal, VaultRole, } from './armature/types';
32
+ export { BYPASS_FORBIDDEN_PERMISSIONS, configFromBcs, cooldownEndsAt, fetchDaoGovernance, fetchFreezeState, fetchIsBoardMember, fetchOuState, fetchProposalConfig, fetchTypeSlots, governanceFromSlots, hasPermissions, HIGH_IMPACT_PERMISSIONS, normalizeMoveType, packageAliases, parseFreezeState, parseOuState, parseTypeSlot, permissionFloor, PERMISSIONS, remapPackages, singleVoteExecutable, slotForType, } from './armature/governance';
33
+ export type { DaoGovernance, FreezeState, OuState, ProposalConfig, TypeSlot, } from './armature/governance';
34
+ export { canComposite, capabilitiesFor, COMPOSITE_TYPE_KEY, evaluatePaths, MAX_COMPOSITE_STEPS, selectStrategy, } from './armature/harness';
35
+ export type { BlockCode, BlockedPlan, CompositeEligibility, CompositeIneligibility, ExecutionPlan, OuCapabilities, OuControlAdapter, OuOwnAdapter, OuProposalAction, PathCandidate, PathTier, ResolvedPlan, Strategy, StrategyDecision, } from './armature/harness';
36
+ export { appendPlanActions, buildBatchPlanTx, buildCompositeSubmitTx, buildExecuteCompositeTx, buildExecutePassedTx, buildPlanTx, extractCreatedProposalId, resolveExecutionPlan, } from './armature/plan';
37
+ export type { CompositeStep, PlanOptions } from './armature/plan';
38
+ export * as armatureTransactions from './armature/transactions';
39
+ export type { ProposalConfigInput } from './armature/transactions';
40
+ export { addMemberAction, addMembersAction, COMPOSITE_TYPE_CONFIG, DEFAULT_SLOT_TYPES, disableBypassTypeAction, disableProposalTypeAction, enableBypassTypeAction, enableCompositeAction, enableProposalTypeAction, enableSendCoinAction, enableSendCoinToOuAction, enableTradingActions, genericTypeKey, GOVERNANCE_TYPE_CONFIG, removeMemberAction, removeMembersAction, sendCoinToOuTypeKey, sendCoinTypeKey, setBoardAction, subOuControlType, tradingTypeEntries, TRADING_TYPE_CONFIG, TREASURY_TYPE_CONFIG, updateMetadataAction, updateProposalConfigAction, WHOLE_BOARD_TYPE_CONFIG, } from './armature/actions';
41
+ export type { ArmaturePkgs, ProposalConfigPatch, TradingTypeEntry, } from './armature/actions';
42
+ export { compositeStepExecutor, defaultSlotType, executorForPayload, passedProposalAction, splitMoveType, } from './armature/executors';
43
+ export type { PassedExecutionContext, PassedExecutor, } from './armature/executors';
44
+ export { appendTransferAssets, createSubOuAction, HIERARCHY_TYPE_CONFIG, pauseSubOuAction, reclaimCapFromSubOuAction, spawnOuAction, spinOutSubOuAction, transferAssetsAction, transferCapToSubOuAction, transferFreezeAdminAction, unfreezeProposalTypeAction, unpauseSubOuAction, updateFreezeConfigAction, updateFreezeExemptTypesAction, } from './armature/lifecycle';
45
+ export type { SpinOutConfigs } from './armature/lifecycle';
46
+ export { adoptCurrencyAction, burnCoinAction, configureMintAllowanceAction, currencyTypeEntries, mintAllowanceAction, mintAllowanceBypassTx, mintCoinAction, returnCurrencyCapAction, treasuryCapType, } from './armature/currency';
47
+ export type { CurrencyTypeEntry } from './armature/currency';
48
+ export { appendUpgradeExecution, proposeUpgradeAction, UPGRADE_POLICY, } from './armature/upgrade';
49
+ export type { UpgradeBuild } from './armature/upgrade';
50
+ export { createTribeTx, tradingTypeInits } from './armature/create';
51
+ export type { CreateTribeParams, TypeInitInput } from './armature/create';
52
+ export { capTypeOf, fetchCapabilityVault, fetchEncryptedEntries, fetchFrameStepPayload, fetchProposal, isDeletable, isExecutable, parseCapabilityVault, parseLiveProposal, parseProposalConfigJson, payloadTypeOf, } from './armature/proposals';
53
+ export type { CapabilityVaultContents, EncryptedEntry, LiveProposal, } from './armature/proposals';
54
+ export { OrgsWriteApi } from './armature/OrgsApi';
55
+ export type { CreatedOrg, CreatedOu, CreateOrgParams, OrgsWriteDeps, } from './armature/OrgsApi';
56
+ export type { ExecuteOptions, RunOptions } from './armature/OrgClient';
57
+ export { claimTreasuryCoinsTx, depositToTreasuryTx, fetchTreasuryCoinBalance, fetchTreasuryCoinBalances, sendCoinAction, sendCoinToOuAction, sendSmallPaymentAction, toTypeNameKey, } from './armature/treasury';
58
+ export type { TreasuryCoinBalance } from './armature/treasury';
59
+ export { appendClaimSettled, appendClaimSettledCoin, cancelOrderAction, cancelOrderCoinAction, coinPairProposalTypes, createMulticoinPoolAction, createMulticoinPoolProposalType, depositCoinToBookAction, depositFromOuVaultToBookAction, extractCreatedTradingCustody, fetchTradingCustody, placeLimitOrderAction, placeLimitOrderCoinAction, placeMarketOrderAction, setupTradingAccountAction, sweepCoinToTreasuryAction, sweepMulticoinToOuVaultAction, tradingProposalTypes, withEnabledTypeKey, } from './armature/trading';
60
+ export type { OrderFlags, TradingContext, TradingCustodyInfo, TradingProposalType, } from './armature/trading';
61
+ export type { OrgCoinLimitOrderParams, OrgLimitOrderParams, OrgTradingAccountCreated, } from './armature/OrgClient';
62
+ export { deinitializeOuVaultTx, depositReceiptTx, fetchOuVaultInfo, fetchVaultBalance, grantEditOuTx, grantTx, initializeOuVaultTx, principalVec, resolveOuVaultId, revokeTx, roleVec, sourceWalletReceipts, toStorageUnitId, updateRegistryKeyTx, VaultKeyBcs, withdrawReceiptTx, } from './armature/vault';
63
+ export type { OuVaultInfo } from './armature/vault';
64
+ export type { OrgSweepSkip } from './armature/OrgClient';
65
+ export { CoinsApi, CoinsReadApi, DEFAULT_SWAP_SLIPPAGE_BPS, } from './coins/CoinsApi';
66
+ export type { CoinsReadDeps } from './coins/CoinsApi';
67
+ export { COIN_MAX_FILLS, COIN_MAX_PRICE, COIN_MIN_PRICE, COIN_POOL_CREATION_FEE, COIN_PRICE_SCALING, coinMinOrderQuantity, coinPriceDecimals, coinPriceToRaw, coinQuoteFee, coinQuoteForBase, coinSellNet, computeCoinBidDeposit, conservativeBidFeeRate, estimateCoinMarketOrder, formatCoinPrice, } from './coins/money';
68
+ export type { CoinFeeRates, CoinMakerOrder, CoinMarketEstimate, } from './coins/money';
69
+ export * as coinTransactions from './coins/transactions';
70
+ export type { CoinPoolTypes } from './coins/transactions';
71
+ export { COIN_ORDER_STATUS, CoinBalancesBcs, CoinFeeScheduleBcs, CoinOrderBcs, CoinOrderPageBcs, CoinPoolAccountBcs, dryRunCoinQuantityOut, fetchCoinAccountOrders, fetchCoinBookSide, fetchCoinPoolAccount, fetchCoinPoolTypes, fetchCoinTradeParams, getTradingAccountCoinBalance, resolveCoinPoolId, simulateReturnValues, } from './coins/onchain';
72
+ export type { CoinBookOrder, CoinBookSide, CoinPoolAccount, CoinPoolBalances, CoinTradeParams, } from './coins/onchain';
73
+ export { depositCoinDeficit, isSuiCoinType, prepareCoinInput, } from './coins/funding';
74
+ export type { CoinAccountParams, CoinBalances, CoinBalancesParams, CoinCancelOrderParams, CoinCancelOrdersParams, CoinClaimSettledParams, CoinDepositParams, CoinInfo, CoinLimitOrderParams, CoinMarket, CoinMarketEstimateParams, CoinMarketOrderParams, CoinMintPolicy, CoinModifyOrderParams, CoinOrderbook, CoinOrderbookParams, CoinPool, CoinPoolSelector, CoinSwapParams, CoinSwapQuote, CoinSwapQuoteParams, CoinSwapResult, CoinTradeParamsParams, CoinTreasuryHolding, CoinWithdrawParams, CreateCoinPoolParams, CreateCoinPoolResult, } from './coins/types';