@trinaryex/sdk 4.0.0 → 5.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.
- package/DESIGN.md +4 -4
- package/README.md +3 -1
- package/dist/ReadOnlyClient.d.ts +3 -3
- package/dist/TriexClient.d.ts +3 -3
- package/dist/index.d.ts +2 -2
- package/dist/index.js +165 -132
- package/dist/queries.d.ts +3 -3
- package/dist/schemas.d.ts +363 -17
- package/dist/types.d.ts +5 -3
- package/package.json +1 -1
package/DESIGN.md
CHANGED
|
@@ -115,7 +115,7 @@ throws on live data.
|
|
|
115
115
|
| Platform aggregates | `GET /v1/stats` | `market.stats` | 50 |
|
|
116
116
|
| Characters | `GET /v1/characters/{id}`, `/address/{a}`, `/name/{n}`, `/batch` | `characters.get` / `byAddress` / `byName` / `batch` | 20 / 20 / 20 / 50 |
|
|
117
117
|
| Tribes | `GET /v1/world/tribes/{tribe_id}` | `characters.tribe` | 20 |
|
|
118
|
-
| World items & recipes (CDN, static) | `GET /v1/world/items`, `/{asset_id}`, `/v1/world/recipes`, `/{
|
|
118
|
+
| World items & recipes (CDN, static) | `GET /v1/world/items`, `/{asset_id}`, `/v1/world/recipes`, `/{item_id}` | `world.items` / `item` / `recipes` / `recipesFor` | 20 each |
|
|
119
119
|
| Routing (location-api) | `GET /v1/routing/route`, `/compare`, `/stats` | `routing.route` / `compare` / `stats` | 100 / 300 / 20 |
|
|
120
120
|
|
|
121
121
|
Notes that change how results are read:
|
|
@@ -345,8 +345,8 @@ client.characters.tribe(tribeId): Promise<Tribe>
|
|
|
345
345
|
// world reference data (static — cache it)
|
|
346
346
|
client.world.items(): Promise<WorldItem[]>
|
|
347
347
|
client.world.item(assetId): Promise<ItemInfo>
|
|
348
|
-
client.world.recipes(): Promise<
|
|
349
|
-
client.world.recipesFor(
|
|
348
|
+
client.world.recipes(): Promise<Blueprint[]> // includes `reverse` — skip when costing
|
|
349
|
+
client.world.recipesFor(assetId): Promise<ItemBlueprints> // { producedBy, usedIn }; both [] when untouched
|
|
350
350
|
|
|
351
351
|
// orders (#10, #11) — each auto-ensures BM + deposits any deficit in one PTB
|
|
352
352
|
client.orders.limit({ storageUnitId, assetId, side, price, quantity, expireAt? }): Promise<TxResult> // #10
|
|
@@ -747,7 +747,7 @@ GET /v1/world/items 20 CU world.items
|
|
|
747
747
|
GET /v1/world/items/{asset_id} 20 CU world.item
|
|
748
748
|
GET /v1/world/items/search 50 CU market.searchItems
|
|
749
749
|
GET /v1/world/recipes 20 CU world.recipes (CDN)
|
|
750
|
-
GET /v1/world/recipes/{
|
|
750
|
+
GET /v1/world/recipes/{item_id} 20 CU world.recipesFor (CDN)
|
|
751
751
|
# Star map & routing (location-api)
|
|
752
752
|
GET /v1/spatial/systems/{solar_system} 20 CU spatial.system
|
|
753
753
|
GET /v1/spatial/systems 50 CU spatial.systems
|
package/README.md
CHANGED
|
@@ -258,7 +258,9 @@ const [who] = await client.characters.batch({ addresses: [wallet] })
|
|
|
258
258
|
|
|
259
259
|
// Static reference data — fetch once, cache.
|
|
260
260
|
const items = await client.world.items() // assetId strings
|
|
261
|
-
const
|
|
261
|
+
const { producedBy, usedIn } = await client.world.recipesFor('77753')
|
|
262
|
+
// producedBy: the blueprints that make it (inputs, outputs, kind, facilities)
|
|
263
|
+
// usedIn: the blueprints that consume it — both [] if no blueprint touches it
|
|
262
264
|
|
|
263
265
|
// Routes take system NAMES — see the note below.
|
|
264
266
|
const route = await client.routing.route({
|
package/dist/ReadOnlyClient.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { OrgsApi } from './armature/OrgsApi';
|
|
2
2
|
import { CoinsReadApi } from './coins/CoinsApi';
|
|
3
3
|
import { IndexerClient } from './queries';
|
|
4
|
-
import { AssemblyEnriched, AssemblyOwner, AutocompleteSystems, TradingAccountOwner, BatchSystems, BatchSystemsParams, CoordinateSearch, CoordinateSearchParams, BalancesAtHubParams, DiscoveryFilters, DiscoveryResult, FillsPage, FillsParams, HistoryPageParams, HubEnriched, HubItemOrderbook, HubItemsPage, HubLocationFilters, HubLocationPage, ItemSearchPage, InventoryBalances, LocationPageParams, NearbyHub, NearbyHubsParams, NearbyHubsBySystemParams, NearbySystems, NearbySystemsParams, OpenOrdersPage, PackageIds, PoolMetadata, ReadOnlyClientConfig, SolarSystem, SolarSystemName, SpatialStats, Sweepable, TradeHubDetail, TradesPage, TradesParams, Character, CharacterLookup, DisplayPrice, DisplayPriceParams, DisplayPricesParams, FillDetail, HubEconomics, ItemInfo, OrderDetail, OrderLookupParams, PlatformStats, PoolFees, RecentTradesPage, RecentTradesParams,
|
|
4
|
+
import { AssemblyEnriched, AssemblyOwner, AutocompleteSystems, TradingAccountOwner, BatchSystems, BatchSystemsParams, CoordinateSearch, CoordinateSearchParams, BalancesAtHubParams, DiscoveryFilters, DiscoveryResult, FillsPage, FillsParams, HistoryPageParams, HubEnriched, HubItemOrderbook, HubItemsPage, HubLocationFilters, HubLocationPage, ItemSearchPage, InventoryBalances, LocationPageParams, NearbyHub, NearbyHubsParams, NearbyHubsBySystemParams, NearbySystems, NearbySystemsParams, OpenOrdersPage, PackageIds, PoolMetadata, ReadOnlyClientConfig, SolarSystem, SolarSystemName, SpatialStats, Sweepable, TradeHubDetail, TradesPage, TradesParams, Character, CharacterLookup, DisplayPrice, DisplayPriceParams, DisplayPricesParams, FillDetail, HubEconomics, ItemInfo, ItemBlueprints, Blueprint, OrderDetail, OrderLookupParams, PlatformStats, PoolFees, RecentTradesPage, RecentTradesParams, Route, RouteComparison, RouteParams, RouteShipParams, RoutingStats, Tribe, WorldItem } from './types';
|
|
5
5
|
export declare class ReadOnlyClient {
|
|
6
6
|
readonly ids: PackageIds;
|
|
7
7
|
readonly indexer: IndexerClient;
|
|
@@ -82,8 +82,8 @@ export declare class ReadOnlyClient {
|
|
|
82
82
|
tribe(tribeId: number): Promise<Tribe>;
|
|
83
83
|
worldItems(): Promise<WorldItem[]>;
|
|
84
84
|
worldItem(assetId: string): Promise<ItemInfo>;
|
|
85
|
-
recipes(): Promise<
|
|
86
|
-
recipesFor(
|
|
85
|
+
recipes(): Promise<Blueprint[]>;
|
|
86
|
+
recipesFor(assetId: string): Promise<ItemBlueprints>;
|
|
87
87
|
route(params: RouteParams): Promise<Route>;
|
|
88
88
|
compareRoutes(params: RouteShipParams): Promise<RouteComparison>;
|
|
89
89
|
routingStats(): Promise<RoutingStats>;
|
package/dist/TriexClient.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ import { OrgsWriteApi } from './armature/OrgsApi';
|
|
|
5
5
|
import { CoinsApi } from './coins/CoinsApi';
|
|
6
6
|
import { TradingFees } from './onchain';
|
|
7
7
|
import { IndexerClient } from './queries';
|
|
8
|
-
import { AssemblyEnriched, AssemblyOwner, AutocompleteSystems, TradingAccountOwner, BatchSystems, BatchSystemsParams, CoordinateSearch, CoordinateSearchParams, BalancesAtHubParams, CancelAllOrdersParams, CancelOrderParams, CancelOrdersParams, ClaimOperatorShareParams, ClaimSettledParams, CreatePoolParams, CreatePoolResult, MintCapParams, MintCapResult, PoolSelector, RevokeCapParams, TradingAccountCaps, TradingFeesParams, CurrencyBalances, DepositCurrencyParams, DepositItemsParams, DiscoveryFilters, DiscoveryResult, EnsureAccountResult, FillsPage, FillsParams, HistoryPageParams, HubEnriched, HubItemOrderbook, HubItemsPage, HubLocationFilters, HubLocationPage, ItemSearchPage, InventoryBalances, LimitOrderParams, LocationPageParams, MarketOrderParams, ModifyOrderParams, NearbyHub, NearbyHubsParams, NearbyHubsBySystemParams, NearbySystems, NearbySystemsParams, OpenOrdersPage, PackageIds, PoolMetadata, SolarSystem, SolarSystemName, SpatialStats, Sweepable, TradeHubDetail, TradesPage, TradesParams, TradingAccount, TransactionExecutor, TriexClientConfig, TxResult, WithdrawCurrencyParams, WithdrawItemsParams, Character, CharacterLookup, DisplayPrice, DisplayPriceParams, DisplayPricesParams, FillDetail, HubEconomics, ItemInfo, OrderDetail, OrderLookupParams, PlatformStats, PoolFees, RecentTradesPage, RecentTradesParams,
|
|
8
|
+
import { AssemblyEnriched, AssemblyOwner, AutocompleteSystems, TradingAccountOwner, BatchSystems, BatchSystemsParams, CoordinateSearch, CoordinateSearchParams, BalancesAtHubParams, CancelAllOrdersParams, CancelOrderParams, CancelOrdersParams, ClaimOperatorShareParams, ClaimSettledParams, CreatePoolParams, CreatePoolResult, MintCapParams, MintCapResult, PoolSelector, RevokeCapParams, TradingAccountCaps, TradingFeesParams, CurrencyBalances, DepositCurrencyParams, DepositItemsParams, DiscoveryFilters, DiscoveryResult, EnsureAccountResult, FillsPage, FillsParams, HistoryPageParams, HubEnriched, HubItemOrderbook, HubItemsPage, HubLocationFilters, HubLocationPage, ItemSearchPage, InventoryBalances, LimitOrderParams, LocationPageParams, MarketOrderParams, ModifyOrderParams, NearbyHub, NearbyHubsParams, NearbyHubsBySystemParams, NearbySystems, NearbySystemsParams, OpenOrdersPage, PackageIds, PoolMetadata, SolarSystem, SolarSystemName, SpatialStats, Sweepable, TradeHubDetail, TradesPage, TradesParams, TradingAccount, TransactionExecutor, TriexClientConfig, TxResult, WithdrawCurrencyParams, WithdrawItemsParams, Character, CharacterLookup, DisplayPrice, DisplayPriceParams, DisplayPricesParams, FillDetail, HubEconomics, ItemInfo, ItemBlueprints, Blueprint, OrderDetail, OrderLookupParams, PlatformStats, PoolFees, RecentTradesPage, RecentTradesParams, Route, RouteComparison, RouteParams, RouteShipParams, RoutingStats, Tribe, WorldItem } from './types';
|
|
9
9
|
export declare class TriexClient {
|
|
10
10
|
readonly suiClient: ClientWithCoreApi;
|
|
11
11
|
readonly ids: PackageIds;
|
|
@@ -155,8 +155,8 @@ declare class WorldApi {
|
|
|
155
155
|
constructor(c: TriexClient);
|
|
156
156
|
items(): Promise<WorldItem[]>;
|
|
157
157
|
item(assetId: string): Promise<ItemInfo>;
|
|
158
|
-
recipes(): Promise<
|
|
159
|
-
recipesFor(
|
|
158
|
+
recipes(): Promise<Blueprint[]>;
|
|
159
|
+
recipesFor(assetId: string): Promise<ItemBlueprints>;
|
|
160
160
|
}
|
|
161
161
|
declare class OrdersApi {
|
|
162
162
|
private readonly c;
|
package/dist/index.d.ts
CHANGED
|
@@ -22,8 +22,8 @@ export type { BookLevel } from './book';
|
|
|
22
22
|
export { iterateDiscovery, iterateFills, iterateHubLocations, iterateItemLocations, iterateOpenOrders, iterateOrgDirectory, iterateRecentTrades, iterateTrades, } from './paging';
|
|
23
23
|
export type { IterateOptions } from './paging';
|
|
24
24
|
export { untilIndexed } from './wait';
|
|
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,
|
|
25
|
+
export { BLUEPRINT_KINDS, 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, Blueprint, BlueprintItem, BlueprintFacility, ItemBlueprints, Route, RouteComparison, RouteOptimization, RouteParams, RouteShipParams, RoutingStats, Waypoint, } from './types';
|
|
27
27
|
export type { OwnedItemReceipt, CharacterInfo, SsuOwnerInfo, ObjectRef, OwnedTradingAccountCap, FeeTier, AccountFeeRates, TradingFees, } from './onchain';
|
|
28
28
|
export type { TradingAccountCapKind, SwapWithTradingAccountArgs, } from './transactions';
|
|
29
29
|
export { POOL_CREATION_FEE } from './transactions';
|