@mysten/deepbook-v3 2.0.0 → 2.1.3

package/dist/deployments/index.d.mts

@@ -0,0 +1,31 @@
+import { DeploymentInfo, DeploymentUnits } from "./types.mjs";
+import { TESTNET_DEPLOYMENT, TESTNET_UNITS } from "./testnet.mjs";
+import { SuiClientTypes } from "@mysten/sui/client";
+
+//#region src/deployments/index.d.ts
+/** Networks this package carries ids for. Predict and sessions are testnet-only so far. */
+type DeployedNetwork = 'testnet';
+/**
+ * Accepts the same wide network type the Sui client exposes, so `getUnits(client.network)`
+ * composes. Narrowing to `DeployedNetwork` would reject that, and listing
+ * `'testnet' | 'mainnet'` would be worse still: it admits exactly one value that always
+ * throws while rejecting `'devnet'` at compile time.
+ */
+type NetworkArg = SuiClientTypes.Network;
+/**
+ * @description Which deployment the ids on `network` came from — its name and the
+ * deepbookv3 commit they were generated at. Useful when a bug report needs to say which
+ * on-chain deployment an SDK build was pinned to.
+ * @throws if the network has no deployment recorded, rather than returning placeholder ids.
+ */
+declare function getDeployment(network: NetworkArg): DeploymentInfo;
+/**
+ * @description Scale constants for `network` — lot size, fixed-point scale, and coin
+ * decimals. Deployment-wide, so any subpath formatting a custody balance can read them
+ * rather than hardcoding 6.
+ * @throws if the network has no recorded deployment.
+ */
+declare function getUnits(network: NetworkArg): DeploymentUnits;
+//#endregion
+export { DeployedNetwork, NetworkArg, getDeployment, getUnits };
+//# sourceMappingURL=index.d.mts.map

package/dist/deployments/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/deployments/index.ts"],"mappings":";;;;;;KAkCY,eAAA;AAwBZ;;;;;;AAAA,KAhBY,UAAA,GAAa,cAAA,CAAe,OAAA;;;AA2BxC;;;;iBAXgB,aAAA,CAAc,OAAA,EAAS,UAAA,GAAa,cAAA;;;;;;;iBAWpC,QAAA,CAAS,OAAA,EAAS,UAAA,GAAa,eAAA"}

package/dist/deployments/index.mjs

@@ -0,0 +1,30 @@
+import { TESTNET_ACCOUNT, TESTNET_DEPLOYMENT, TESTNET_PREDICT, TESTNET_SESSIONS, TESTNET_UNITS } from "./testnet.mjs";
+
+//#region src/deployments/index.ts
+function unrecorded(network, override) {
+	return /* @__PURE__ */ new Error(`@mysten/deepbook-v3: no deployment recorded for network '${network}'. Predict, sessions and the account primitive are testnet-only today. For your own deployment, ${override}`);
+}
+/**
+* @description Which deployment the ids on `network` came from — its name and the
+* deepbookv3 commit they were generated at. Useful when a bug report needs to say which
+* on-chain deployment an SDK build was pinned to.
+* @throws if the network has no deployment recorded, rather than returning placeholder ids.
+*/
+function getDeployment(network) {
+	if (network === "testnet") return TESTNET_DEPLOYMENT;
+	throw unrecorded(network, "read the deployment name and commit from your own deploy manifest.");
+}
+/**
+* @description Scale constants for `network` — lot size, fixed-point scale, and coin
+* decimals. Deployment-wide, so any subpath formatting a custody balance can read them
+* rather than hardcoding 6.
+* @throws if the network has no recorded deployment.
+*/
+function getUnits(network) {
+	if (network === "testnet") return TESTNET_UNITS;
+	throw unrecorded(network, "read these scale constants from your own deploy manifest.");
+}
+
+//#endregion
+export { getDeployment, getUnits };
+//# sourceMappingURL=index.mjs.map

package/dist/deployments/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../src/deployments/index.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\n/**\n * Canonical per-network deployment ids.\n *\n * Every subpath reads its slice of this one record rather than carrying its own copy, so a\n * redeploy is a single regeneration (`pnpm sync-deployment`) and the subpaths cannot end up\n * addressing different deployments. The records themselves are generated from the deploy\n * tooling's manifest — see `scripts/sync-deployment.ts`.\n */\n\nimport type { SuiClientTypes } from '@mysten/sui/client';\n\nimport {\n\tTESTNET_ACCOUNT,\n\tTESTNET_DEPLOYMENT,\n\tTESTNET_PREDICT,\n\tTESTNET_SESSIONS,\n\tTESTNET_UNITS,\n} from './testnet.js';\nimport type { DeploymentInfo, DeploymentUnits } from './types.js';\n\nexport type {\n\tAccountIds,\n\tDeploymentInfo,\n\tDeploymentUnits,\n\tPredictIds,\n\tSessionsIds,\n} from './types.js';\n\nexport { TESTNET_ACCOUNT, TESTNET_DEPLOYMENT, TESTNET_PREDICT, TESTNET_SESSIONS, TESTNET_UNITS };\n\n/** Networks this package carries ids for. Predict and sessions are testnet-only so far. */\nexport type DeployedNetwork = 'testnet';\n\n/**\n * Accepts the same wide network type the Sui client exposes, so `getUnits(client.network)`\n * composes. Narrowing to `DeployedNetwork` would reject that, and listing\n * `'testnet' | 'mainnet'` would be worse still: it admits exactly one value that always\n * throws while rejecting `'devnet'` at compile time.\n */\nexport type NetworkArg = SuiClientTypes.Network;\n\nfunction unrecorded(network: string, override: string): Error {\n\treturn new Error(\n\t\t`@mysten/deepbook-v3: no deployment recorded for network '${network}'. ` +\n\t\t\t'Predict, sessions and the account primitive are testnet-only today. ' +\n\t\t\t`For your own deployment, ${override}`,\n\t);\n}\n\n/**\n * @description Which deployment the ids on `network` came from — its name and the\n * deepbookv3 commit they were generated at. Useful when a bug report needs to say which\n * on-chain deployment an SDK build was pinned to.\n * @throws if the network has no deployment recorded, rather than returning placeholder ids.\n */\nexport function getDeployment(network: NetworkArg): DeploymentInfo {\n\tif (network === 'testnet') return TESTNET_DEPLOYMENT;\n\tthrow unrecorded(network, 'read the deployment name and commit from your own deploy manifest.');\n}\n\n/**\n * @description Scale constants for `network` — lot size, fixed-point scale, and coin\n * decimals. Deployment-wide, so any subpath formatting a custody balance can read them\n * rather than hardcoding 6.\n * @throws if the network has no recorded deployment.\n */\nexport function getUnits(network: NetworkArg): DeploymentUnits {\n\tif (network === 'testnet') return TESTNET_UNITS;\n\tthrow unrecorded(network, 'read these scale constants from your own deploy manifest.');\n}\n"],"mappings":";;;AA4CA,SAAS,WAAW,SAAiB,UAAyB;AAC7D,wBAAO,IAAI,MACV,4DAA4D,QAAQ,kGAEvC,WAC7B;;;;;;;;AASF,SAAgB,cAAc,SAAqC;AAClE,KAAI,YAAY,UAAW,QAAO;AAClC,OAAM,WAAW,SAAS,qEAAqE;;;;;;;;AAShG,SAAgB,SAAS,SAAsC;AAC9D,KAAI,YAAY,UAAW,QAAO;AAClC,OAAM,WAAW,SAAS,4DAA4D"}

package/dist/deployments/testnet.d.mts

@@ -0,0 +1,14 @@
+import { DeploymentInfo, DeploymentUnits } from "./types.mjs";
+
+//#region src/deployments/testnet.d.ts
+/** Which on-chain deployment the ids below came from. */
+declare const TESTNET_DEPLOYMENT: DeploymentInfo;
+/**
+ * Scale constants the deployment owns rather than the SDK. Deployment-wide:
+ * `quoteCoinDecimals` and `fixedPointScale` apply to any subpath formatting a custody
+ * balance, not just Predict.
+ */
+declare const TESTNET_UNITS: DeploymentUnits;
+//#endregion
+export { TESTNET_DEPLOYMENT, TESTNET_UNITS };
+//# sourceMappingURL=testnet.d.mts.map

package/dist/deployments/testnet.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testnet.d.mts","names":[],"sources":["../../src/deployments/testnet.ts"],"mappings":";;;;cA2Ba,kBAAA,EAAoB,cAAA;;;;;;cAqCpB,aAAA,EAAe,eAAA"}

package/dist/deployments/testnet.mjs

@@ -0,0 +1,73 @@
+//#region src/deployments/testnet.ts
+/** Which on-chain deployment the ids below came from. */
+const TESTNET_DEPLOYMENT = Object.freeze({
+	deployment: "predict-testnet-8-21",
+	network: "testnet",
+	chainId: "4c78adac",
+	sourceCommit: "1f79fe87ab2f6b9df40cfdc2e647c93f45e6d737"
+});
+/** Ids for the shared `account` primitive — the `/account` subpath's slice. */
+const TESTNET_ACCOUNT = Object.freeze({
+	accountPackageId: "0xa94ec89b6cbb3e2609c7ca65bd77885b7513f852922ebdf8e766851fb6f85259",
+	accountRegistry: "0x5682c73d657de1546374e632369a25c82744c8a20e9b4f47e6558e3d4bde88d3"
+});
+/**
+* Ids for time-limited sessions — the `/sessions` subpath's slice.
+*
+* `deepbookRegistry` is only needed by the DeepBook **spot** session wrappers; the Predict
+* wrappers never take it. It is carried here so a spot caller does not have to reach into
+* the package root for one id.
+*/
+const TESTNET_SESSIONS = Object.freeze({
+	sessionsPackageId: "0xb74170443d6d2d37cbe95c7e530dd4a1605ef714ff4f9e88e27a7ac1455451db",
+	sessionsConfig: "0xdfb8e23246678649cfdd6f3f6610057d5cadd6a8911a21dbe8e34788abbfab93",
+	accountPackageId: "0xa94ec89b6cbb3e2609c7ca65bd77885b7513f852922ebdf8e766851fb6f85259",
+	accountRegistry: "0x5682c73d657de1546374e632369a25c82744c8a20e9b4f47e6558e3d4bde88d3",
+	deepbookRegistry: "0x7c256edbda983a2cd6f946655f4bf3f00a41043993781f8674a7046e8c0e11d1",
+	deepbookCoreAccountPackageId: "0xcc9cf1029127e7bda6da4c2ab90164d7bef751783ff13c21c2bb804cec69ebec",
+	protocolConfig: "0x7ef1ac99c2f0a77e7aa2602b5ea7bff68750cff0d80f09bdf827bfb345128f33"
+});
+/**
+* Scale constants the deployment owns rather than the SDK. Deployment-wide:
+* `quoteCoinDecimals` and `fixedPointScale` apply to any subpath formatting a custody
+* balance, not just Predict.
+*/
+const TESTNET_UNITS = Object.freeze({
+	positionLotSize: 1e4,
+	fixedPointScale: 1e9,
+	quoteCoinDecimals: 6,
+	positionQuantityDecimals: 6
+});
+/** Ids for DeepBook Predict — the `/predict` subpath's slice. */
+const TESTNET_PREDICT = Object.freeze({
+	network: "testnet",
+	packages: Object.freeze({
+		predict: "0x421041754244cf0e985fb9c9f5e1f49428caf3df4cde3a7b266d8e18ea63597b",
+		account: "0xa94ec89b6cbb3e2609c7ca65bd77885b7513f852922ebdf8e766851fb6f85259",
+		propbook: "0xd8b402609b1728f60cf20bfaaec5255701df54350ec13e93aac39463b00bf97b"
+	}),
+	objects: Object.freeze({
+		registry: "0x3d486bd50bb5bb5450ddbcb4f74776b6135f416c09024a6674ac266e77e1870a",
+		protocolConfig: "0x7ef1ac99c2f0a77e7aa2602b5ea7bff68750cff0d80f09bdf827bfb345128f33",
+		poolVault: "0x2a31f592d8fd3d0781e2233770d02d67797890ac82c3d18796d7eb0997896602",
+		oracleRegistry: "0x715f5ae4aac0078f4d0c6bf9ea2815614e799e909a90b577aeb8de9ad8bab142",
+		accountRegistry: "0x5682c73d657de1546374e632369a25c82744c8a20e9b4f47e6558e3d4bde88d3"
+	}),
+	quoteCoinType: "0xe95040085976bfd54a1a07225cd46c8a2b4e8e2b6732f140a0fc49850ba73e1a::dusdc::DUSDC",
+	coinTypes: Object.freeze({
+		plp: "0x421041754244cf0e985fb9c9f5e1f49428caf3df4cde3a7b266d8e18ea63597b::plp::PLP",
+		deep: "0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8::deep::DEEP"
+	}),
+	units: TESTNET_UNITS,
+	underlyings: Object.freeze({ BTC: Object.freeze({
+		symbol: "BTC",
+		propbookUnderlyingId: 1,
+		pythFeed: "0xea8fd4624002516b28b495051c838b2c9a34a4f22ae281d328e1bec47f54cd24",
+		blockScholesValueStore: "0x9b64cc860ac09e6dcd675fc579c1048792ddce51cc018f2ca16aeb4a1a5684a3",
+		blockScholesSviStore: "0xd5bc586e99c8d595e0ba5e0a2ef2295e652db8934ffbeda630d60e207bedab8f"
+	}) })
+});
+
+//#endregion
+export { TESTNET_ACCOUNT, TESTNET_DEPLOYMENT, TESTNET_PREDICT, TESTNET_SESSIONS, TESTNET_UNITS };
+//# sourceMappingURL=testnet.mjs.map

package/dist/deployments/testnet.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"testnet.mjs","names":[],"sources":["../../src/deployments/testnet.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\n// GENERATED by `pnpm sync-deployment` from the deploy tooling's own manifest\n// (`packages/predict/deployment/deployment.testnet.json`). Do not hand-edit:\n// the next regeneration overwrites it, and a hand-patched id is exactly the drift this\n// file exists to prevent. To move to a new deployment, check the sibling deepbookv3\n// checkout out to the new anchor and re-run the script.\n//\n// Deployment: predict-testnet-8-21\n// sourceCommit: 1f79fe87ab2f6b9df40cfdc2e647c93f45e6d737\n//\n// Runtime-dependency-free — every subpath reads a slice of this, so a value import here\n// would pull that module into all of their graphs. The type import below is erased.\n//\n// Frozen: these are shared module singletons, so an accessor handing one to a caller who\n// mutates it would change what every other caller sees.\n\nimport type {\n\tAccountIds,\n\tDeploymentInfo,\n\tDeploymentUnits,\n\tPredictIds,\n\tSessionsIds,\n} from './types.js';\n\n/** Which on-chain deployment the ids below came from. */\nexport const TESTNET_DEPLOYMENT: DeploymentInfo = Object.freeze({\n\tdeployment: 'predict-testnet-8-21',\n\tnetwork: 'testnet',\n\tchainId: '4c78adac',\n\tsourceCommit: '1f79fe87ab2f6b9df40cfdc2e647c93f45e6d737',\n});\n\n/** Ids for the shared `account` primitive — the `/account` subpath's slice. */\nexport const TESTNET_ACCOUNT: AccountIds = Object.freeze({\n\taccountPackageId: '0xa94ec89b6cbb3e2609c7ca65bd77885b7513f852922ebdf8e766851fb6f85259',\n\taccountRegistry: '0x5682c73d657de1546374e632369a25c82744c8a20e9b4f47e6558e3d4bde88d3',\n});\n\n/**\n * Ids for time-limited sessions — the `/sessions` subpath's slice.\n *\n * `deepbookRegistry` is only needed by the DeepBook **spot** session wrappers; the Predict\n * wrappers never take it. It is carried here so a spot caller does not have to reach into\n * the package root for one id.\n */\nexport const TESTNET_SESSIONS: SessionsIds = Object.freeze({\n\tsessionsPackageId: '0xb74170443d6d2d37cbe95c7e530dd4a1605ef714ff4f9e88e27a7ac1455451db',\n\tsessionsConfig: '0xdfb8e23246678649cfdd6f3f6610057d5cadd6a8911a21dbe8e34788abbfab93',\n\taccountPackageId: '0xa94ec89b6cbb3e2609c7ca65bd77885b7513f852922ebdf8e766851fb6f85259',\n\taccountRegistry: '0x5682c73d657de1546374e632369a25c82744c8a20e9b4f47e6558e3d4bde88d3',\n\tdeepbookRegistry: '0x7c256edbda983a2cd6f946655f4bf3f00a41043993781f8674a7046e8c0e11d1',\n\tdeepbookCoreAccountPackageId:\n\t\t'0xcc9cf1029127e7bda6da4c2ab90164d7bef751783ff13c21c2bb804cec69ebec',\n\t/** Required by every Predict session wrapper — they all take `config: &ProtocolConfig`. */\n\tprotocolConfig: '0x7ef1ac99c2f0a77e7aa2602b5ea7bff68750cff0d80f09bdf827bfb345128f33',\n});\n\n/**\n * Scale constants the deployment owns rather than the SDK. Deployment-wide:\n * `quoteCoinDecimals` and `fixedPointScale` apply to any subpath formatting a custody\n * balance, not just Predict.\n */\nexport const TESTNET_UNITS: DeploymentUnits = Object.freeze({\n\tpositionLotSize: 10000,\n\tfixedPointScale: 1000000000,\n\tquoteCoinDecimals: 6,\n\tpositionQuantityDecimals: 6,\n});\n\n/** Ids for DeepBook Predict — the `/predict` subpath's slice. */\nexport const TESTNET_PREDICT: PredictIds = Object.freeze({\n\tnetwork: 'testnet',\n\tpackages: Object.freeze({\n\t\tpredict: '0x421041754244cf0e985fb9c9f5e1f49428caf3df4cde3a7b266d8e18ea63597b',\n\t\taccount: '0xa94ec89b6cbb3e2609c7ca65bd77885b7513f852922ebdf8e766851fb6f85259',\n\t\tpropbook: '0xd8b402609b1728f60cf20bfaaec5255701df54350ec13e93aac39463b00bf97b',\n\t}),\n\tobjects: Object.freeze({\n\t\tregistry: '0x3d486bd50bb5bb5450ddbcb4f74776b6135f416c09024a6674ac266e77e1870a',\n\t\tprotocolConfig: '0x7ef1ac99c2f0a77e7aa2602b5ea7bff68750cff0d80f09bdf827bfb345128f33',\n\t\tpoolVault: '0x2a31f592d8fd3d0781e2233770d02d67797890ac82c3d18796d7eb0997896602',\n\t\toracleRegistry: '0x715f5ae4aac0078f4d0c6bf9ea2815614e799e909a90b577aeb8de9ad8bab142',\n\t\taccountRegistry: '0x5682c73d657de1546374e632369a25c82744c8a20e9b4f47e6558e3d4bde88d3',\n\t}),\n\tquoteCoinType: '0xe95040085976bfd54a1a07225cd46c8a2b4e8e2b6732f140a0fc49850ba73e1a::dusdc::DUSDC',\n\t/**\n\t * `plp` is the LP share coin type. It is NOT derivable from `packages.predict`: a Move\n\t * type tag keeps the ORIGINAL package id across an upgrade, while `packages.predict`\n\t * moves to the latest. They agree only while predict is at v1.\n\t */\n\tcoinTypes: Object.freeze({\n\t\tplp: '0x421041754244cf0e985fb9c9f5e1f49428caf3df4cde3a7b266d8e18ea63597b::plp::PLP',\n\t\tdeep: '0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8::deep::DEEP',\n\t}),\n\tunits: TESTNET_UNITS,\n\tunderlyings: Object.freeze({\n\t\tBTC: Object.freeze({\n\t\t\tsymbol: 'BTC',\n\t\t\tpropbookUnderlyingId: 1,\n\t\t\tpythFeed: '0xea8fd4624002516b28b495051c838b2c9a34a4f22ae281d328e1bec47f54cd24',\n\t\t\tblockScholesValueStore: '0x9b64cc860ac09e6dcd675fc579c1048792ddce51cc018f2ca16aeb4a1a5684a3',\n\t\t\tblockScholesSviStore: '0xd5bc586e99c8d595e0ba5e0a2ef2295e652db8934ffbeda630d60e207bedab8f',\n\t\t}),\n\t}),\n});\n"],"mappings":";;AA2BA,MAAa,qBAAqC,OAAO,OAAO;CAC/D,YAAY;CACZ,SAAS;CACT,SAAS;CACT,cAAc;CACd,CAAC;;AAGF,MAAa,kBAA8B,OAAO,OAAO;CACxD,kBAAkB;CAClB,iBAAiB;CACjB,CAAC;;;;;;;;AASF,MAAa,mBAAgC,OAAO,OAAO;CAC1D,mBAAmB;CACnB,gBAAgB;CAChB,kBAAkB;CAClB,iBAAiB;CACjB,kBAAkB;CAClB,8BACC;CAED,gBAAgB;CAChB,CAAC;;;;;;AAOF,MAAa,gBAAiC,OAAO,OAAO;CAC3D,iBAAiB;CACjB,iBAAiB;CACjB,mBAAmB;CACnB,0BAA0B;CAC1B,CAAC;;AAGF,MAAa,kBAA8B,OAAO,OAAO;CACxD,SAAS;CACT,UAAU,OAAO,OAAO;EACvB,SAAS;EACT,SAAS;EACT,UAAU;EACV,CAAC;CACF,SAAS,OAAO,OAAO;EACtB,UAAU;EACV,gBAAgB;EAChB,WAAW;EACX,gBAAgB;EAChB,iBAAiB;EACjB,CAAC;CACF,eAAe;CAMf,WAAW,OAAO,OAAO;EACxB,KAAK;EACL,MAAM;EACN,CAAC;CACF,OAAO;CACP,aAAa,OAAO,OAAO,EAC1B,KAAK,OAAO,OAAO;EAClB,QAAQ;EACR,sBAAsB;EACtB,UAAU;EACV,wBAAwB;EACxB,sBAAsB;EACtB,CAAC,EACF,CAAC;CACF,CAAC"}

package/dist/deployments/types.d.mts

@@ -0,0 +1,36 @@
+//#region src/deployments/types.d.ts
+/**
+ * Shapes for the generated deployment records.
+ *
+ * The generated file annotates each record with one of these rather than using `as const`.
+ * That matters for consumers: `as const` would publish the literal ids in the `.d.mts`, so
+ * `getDeployment('testnet').network === 'mainnet'` would be a compile ERROR rather than
+ * `false`, spreading a record to override one field would fail, and every redeploy would
+ * silently change the published types.
+ */
+/** Which on-chain deployment a set of ids came from. */
+interface DeploymentInfo {
+  deployment: string;
+  network: string;
+  chainId: string;
+  /** The deepbookv3 commit the deployed Move sources were built from. */
+  sourceCommit: string;
+}
+/**
+ * Scale constants the deployment owns rather than the SDK.
+ *
+ * Only `positionLotSize` is currently read by the SDK (`PredictClient#assertLot`); the other
+ * three are shipped as the deployment's own record of its scales. `units.ts` still hardcodes
+ * the DUSDC and fixed-point decimals, so do not read this as "the SDK derives its scaling
+ * from here" — wiring that up is separate work.
+ */
+interface DeploymentUnits {
+  /** Predict-only: order quantity must be a whole number of these. */
+  positionLotSize: number;
+  fixedPointScale: number;
+  quoteCoinDecimals: number;
+  positionQuantityDecimals: number;
+}
+//#endregion
+export { DeploymentInfo, DeploymentUnits };
+//# sourceMappingURL=types.d.mts.map

package/dist/deployments/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","names":[],"sources":["../../src/deployments/types.ts"],"mappings":";;AAcA;;;;;;;;;UAAiB,cAAA;EAChB,UAAA;EACA,OAAA;EACA,OAAA;EAa+B;EAX/B,YAAA;AAAA;;;;;;;;;UAWgB,eAAA;;EAEhB,eAAA;EACA,eAAA;EACA,iBAAA;EACA,wBAAA;AAAA"}

package/dist/index.mjs

@@ -3,7 +3,6 @@ import { Balances } from "./contracts/deepbook/balances.mjs";
 import { Account } from "./contracts/deepbook/account.mjs";
 import { OrderDeepPrice } from "./contracts/deepbook/deep_price.mjs";
 import { Order } from "./contracts/deepbook/order.mjs";
-import "./types/bcs.mjs";
 import { BalanceManagerContract } from "./transactions/balanceManager.mjs";
 import { ConfigurationError, DeepBookError, ErrorMessages, ResourceNotFoundError, ValidationError } from "./utils/errors.mjs";
 import { DEEPBOOK_HERMES_PROXY, PYTH_UPGRADED_HERMES, mainnetCoins, mainnetMarginPools, mainnetPackageIds, mainnetPools, mainnetPythConfigs, testnetCoins, testnetMarginPools, testnetPackageIds, testnetPools, testnetPythConfigs } from "./utils/constants.mjs";

package/dist/predict/client.d.mts

@@ -0,0 +1,255 @@
+import { PredictConfig } from "./config/types.mjs";
+import { BalanceChangeReceipt, BuilderCodeReceipt, ClaimReceipt, CreateManagerReceipt, DecodableTransactionResult, MintReceipt, PlpCancelReceipt, PlpRequestReceipt, RedeemReceipt } from "./decode.mjs";
+import { OpenPosition } from "./reads/positions.mjs";
+import { BoardPricer } from "./pricing.mjs";
+import { PricerSnapshot } from "./reads/pricing.mjs";
+import { Side } from "./ticks.mjs";
+import { Transaction } from "@mysten/sui/transactions";
+import { ClientWithCoreApi, SuiClientRegistration } from "@mysten/sui/client";
+
+//#region src/predict/client.d.ts
+/**
+ * Testnet's `position_lot_size`, read from the deployment record. Validation uses the lot
+ * size of the config actually in play; this is the convenience constant for testnet callers.
+ */
+declare const POSITION_LOT_SIZE: bigint;
+/** A live/settled market addressed by its human coordinates: a binary position
+ * (single strike + side) or a two-strike range position. */
+type MarketDescriptor = {
+  underlying: string;
+  expiryMs: number | bigint;
+  /**
+   * Pin resolution to this exact `ExpiryMarket` object, skipping the
+   * underlying+expiry lookup — a caller that reviewed a specific market object
+   * mints against exactly that object, not whatever resolves at submit time.
+   */
+  marketId?: string;
+} & ({
+  side: Side;
+  /**
+   * Strike in USD, or "reference" to trade at the market's on-chain reference
+   * price (the Polymarket-style anchor: derived from the exact previous-window
+   * oracle observation, so consecutive windows chain settlement → next strike).
+   */
+  strike: number | 'reference';
+} | {
+  /** A range position: pays out when settlement lands inside `(lower, upper]`
+   * (left-open, right-closed — same convention as the on-chain range key). */
+  side: 'range'; /** Lower strike bound in USD — finite, on the tick grid. */
+  lower: number; /** Upper strike bound in USD — finite, on the tick grid, above `lower`. */
+  upper: number;
+});
+/** Options for the friendly `mint` (exact payout quantity). */
+interface MintOptions {
+  quantity: number;
+  maxCost?: number;
+  maxProbability?: number;
+}
+/** Options for `mintAmount` (spend up to a premium budget, floor the quantity received). */
+interface MintAmountOptions {
+  /** Premium budget in quote units — the max premium paid (chain also caps it at the account balance). */
+  spend: number;
+  minQuantity: number;
+  /** All-in cost ceiling in quote units (premium + fees). Omitted → uncapped. */
+  maxCost?: number;
+}
+/** Options for `redeem`: which order and how much to close. `claimSettled` takes only
+ * `orderId` — a settled claim closes the order in full. */
+interface CloseOptions {
+  orderId: bigint;
+  quantity: number;
+}
+/** One tradeable market as returned by read.markets(). */
+interface ActiveMarket {
+  id: string;
+  expiryMs: bigint;
+  /** Strike granularity in USD (e.g. 0.01). */
+  tickSize: number;
+  /**
+   * Coarser step new mint strikes must align to. A numeric strike must be a whole
+   * multiple of this (the market's `referencePrice` is the one exception the chain
+   * admits off-grid); otherwise the mint aborts `EInvalidAdmissionTick`.
+   */
+  admissionTickSize: number;
+  mintPaused: boolean;
+  /** The window's anchor strike in USD, or null until the keeper seeds it. */
+  referencePrice: number | null;
+}
+/** A resolved live market: its on-chain state summary for the caller. */
+interface MarketSummary {
+  id: string;
+  expiryMs: bigint;
+  tickSize: number;
+  /**
+   * Coarser step new mint strikes must align to. A numeric strike must be a whole
+   * multiple of this (the market's `referencePrice` is the one exception the chain
+   * admits off-grid); otherwise the mint aborts `EInvalidAdmissionTick`.
+   */
+  admissionTickSize: number;
+  mintPaused: boolean;
+  nav: number;
+  /** The window's anchor strike in USD, or null until the keeper seeds it. */
+  referencePrice: number | null;
+}
+/** Aggregate pool figures. Balances in human units (shares raw); the pending fields
+ * are request COUNTS, not amounts — the on-chain getters expose queue lengths, and
+ * the escrowed DUSDC/PLP behind them is tracked separately. */
+interface PoolSummary {
+  plpTotalSupply: bigint;
+  idleUsdc: number;
+  /** Number of LP supply requests queued for the next flush. */
+  supplyRequestsPending: number;
+  /** Number of LP withdraw requests queued for the next flush. */
+  withdrawRequestsPending: number;
+}
+/** Exact pre-trade quote: the dry-run receipt of the mint you are about to send. */
+interface MintQuote {
+  /** Fill price, 0..1 per $1 payout. */
+  entryProbability: number;
+  /** Premium paid into LP backing (quote units). */
+  premium: number;
+  /**
+   * Fee breakdown. `referral` is a PORTION of the trader-paid trading fee and
+   * congestion surcharge routed to the referrer — it is already inside those
+   * numbers and is NOT an extra debit. `inventoryImpact` is a separate charge and
+   * IS part of `cost`.
+   */
+  fees: {
+    trading: number;
+    subsidy: number;
+    builder: number;
+    penalty: number;
+    referral: number;
+    inventoryImpact: number;
+  };
+  /**
+   * All-in account debit: premium + (trading − subsidy) + builder + penalty +
+   * inventoryImpact — exactly what the chain withdraws (the deployed
+   * `compute_mint_quote`'s `all_in_cost`); pass this (plus your buffer) as maxCost.
+   */
+  cost: number;
+  quantity: number;
+  raw: {
+    premium: bigint;
+    cost: bigint;
+    quantity: bigint;
+    entryProbability: bigint;
+  };
+  /** True: computed by the real mint code path against real account state. */
+  feesExact: true;
+}
+/** Exact pre-close quote: the dry-run receipt of the redeem you are about to send. */
+interface RedeemQuote {
+  /** NET quote credited to the account. */
+  proceeds: number;
+  /** Gross close value before fees. */
+  gross: number;
+  /** `inventoryImpactRebate` is credited back on the close, so `proceeds` is
+   * gross + rebate − trading − builder − penalty. */
+  fees: {
+    trading: number;
+    builder: number;
+    penalty: number;
+    inventoryImpactRebate: number;
+  };
+  quantityClosed: number;
+  remaining: number;
+  raw: {
+    proceeds: bigint;
+    gross: bigint;
+    quantityClosed: bigint;
+  };
+  feesExact: true;
+}
+type BinaryMarketCoordinates = Pick<MarketDescriptor, 'underlying' | 'expiryMs' | 'marketId'> & {
+  strike: number | 'reference';
+};
+/** The Sui client surface PredictClient reads through: any `ClientWithCoreApi`
+ * (gRPC or JSON-RPC) provides both the `simulateTransaction` the reads/quotes
+ * sit on and the `core` object methods position enumeration needs. */
+interface PredictCompatibleClient extends ClientWithCoreApi {}
+/**
+ * Register PredictClient as a `client.predict` extension, mirroring
+ * `@mysten/deepbook-v3`'s `deepbook(...)`: `client.$extend(predict({ network }))`.
+ */
+declare function predict<Name extends string = 'predict'>({
+  name,
+  network,
+  config
+}: {
+  name?: Name;
+  network: 'testnet' | 'mainnet';
+  config?: PredictConfig;
+}): SuiClientRegistration<PredictCompatibleClient, Name, PredictClient>;
+/**
+ * The one object an app constructs. Wraps the config, a client for reads, and
+ * a derived-account model so callers pass owner addresses, decimal amounts, and
+ * human market coordinates — the facade converts to raw units, resolves markets
+ * (cached), and delegates to the internal tx primitives / reads. Callers who need
+ * to compose their own PTBs can use the generated bindings under `contracts/`.
+ */
+declare class PredictClient {
+  #private;
+  readonly cfg: PredictConfig;
+  constructor(opts: {
+    network: 'testnet' | 'mainnet';
+    client: PredictCompatibleClient;
+    config?: PredictConfig;
+  });
+  /** The deterministic id of an owner's canonical account wrapper — no chain read. */
+  wrapperIdFor(owner: string): string;
+  readonly tx: {
+    createManager: () => Transaction;
+    deposit: (owner: string, amountUsdc: number | string, opts?: {
+      create?: boolean;
+    }) => Transaction;
+    withdraw: (owner: string, amountUsdc: number | string, opts?: {
+      toCoinObject?: boolean;
+    }) => Transaction;
+    mint: (owner: string, m: MarketDescriptor, opts: MintOptions) => Promise<Transaction>;
+    mintAmount: (owner: string, m: MarketDescriptor, opts: MintAmountOptions) => Promise<Transaction>;
+    redeem: (owner: string, m: MarketDescriptor, opts: CloseOptions) => Promise<Transaction>;
+    claimSettled: (owner: string, m: Pick<MarketDescriptor, "underlying" | "expiryMs" | "marketId">, opts: Pick<CloseOptions, "orderId">) => Promise<Transaction>;
+    supplyPlp: (owner: string, amountUsdc: number | string) => Transaction;
+    withdrawPlp: (owner: string, shares: bigint) => Transaction;
+    cancelSupplyPlp: (owner: string, index: bigint) => Transaction;
+    cancelWithdrawPlp: (owner: string, index: bigint) => Transaction;
+    setBuilderCode: (owner: string, builderCodeId: string) => Transaction;
+    unsetBuilderCode: (owner: string) => Transaction;
+  };
+  readonly read: {
+    markets: () => Promise<ActiveMarket[]>;
+    hasPosition: (owner: string, marketId: string, orderId: bigint) => Promise<boolean>;
+    positions: (owner: string) => Promise<OpenPosition[]>;
+    price: (m: BinaryMarketCoordinates) => Promise<{
+      up: number;
+      down: number;
+    }>;
+    pricer: (m: Pick<MarketDescriptor, "underlying" | "expiryMs">) => Promise<BoardPricer & {
+      asOf: PricerSnapshot["sources"];
+    }>;
+    quoteMint: (owner: string, m: MarketDescriptor, opts: Pick<MintOptions, "quantity">) => Promise<MintQuote>;
+    quoteRedeem: (owner: string, m: MarketDescriptor, opts: CloseOptions) => Promise<RedeemQuote>;
+    market: (m: Pick<MarketDescriptor, "underlying" | "expiryMs">) => Promise<MarketSummary | null>;
+    balance: (owner: string) => Promise<number>;
+    plpBalance: (owner: string) => Promise<bigint>;
+    pool: () => Promise<PoolSummary>;
+  };
+  readonly decode: {
+    mint: (r: DecodableTransactionResult) => MintReceipt;
+    mints: (r: DecodableTransactionResult) => MintReceipt[];
+    redeem: (r: DecodableTransactionResult) => RedeemReceipt;
+    redeems: (r: DecodableTransactionResult) => RedeemReceipt[];
+    claim: (r: DecodableTransactionResult) => ClaimReceipt;
+    claims: (r: DecodableTransactionResult) => ClaimReceipt[];
+    createManager: (r: DecodableTransactionResult) => CreateManagerReceipt;
+    deposit: (r: DecodableTransactionResult) => BalanceChangeReceipt;
+    withdraw: (r: DecodableTransactionResult) => BalanceChangeReceipt;
+    plpRequest: (r: DecodableTransactionResult) => PlpRequestReceipt;
+    plpCancel: (r: DecodableTransactionResult) => PlpCancelReceipt;
+    builderCode: (r: DecodableTransactionResult) => BuilderCodeReceipt;
+  };
+}
+//#endregion
+export { ActiveMarket, CloseOptions, MarketDescriptor, MarketSummary, MintAmountOptions, MintOptions, MintQuote, POSITION_LOT_SIZE, PoolSummary, PredictClient, PredictCompatibleClient, RedeemQuote, predict };
+//# sourceMappingURL=client.d.mts.map

package/dist/predict/client.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.mts","names":[],"sources":["../../src/predict/client.ts"],"mappings":";;;;;;;;;;;;AAyEA;;cAAa,iBAAA;;;KAWD,gBAAA;EACX,UAAA;EACA,QAAA;EASY;;;;;EAHZ,QAAA;AAAA;EAGE,IAAA,EAAM,IAAA;EAaN;;;;AAOH;EAdG,MAAA;AAAA;EAcyB;;EATzB,IAAA,WAYF;EAVE,KAAA,UAUY;EARZ,KAAA;AAAA;;UAKc,WAAA;EAChB,QAAA;EACA,OAAA;EACA,cAAA;AAAA;;UAIgB,iBAAA;EAUY;EAR5B,KAAA;EACA,WAAA;EASQ;EAPR,OAAA;AAAA;;;UAKgB,YAAA;EAChB,OAAA;EACA,QAAA;AAAA;;UAIgB,YAAA;EAChB,EAAA;EACA,QAAA;EAegB;EAbhB,QAAA;;;;;;EAMA,iBAAA;EACA,UAAA;EAiBA;EAfA,cAAA;AAAA;;UAIgB,aAAA;EAChB,EAAA;EACA,QAAA;EACA,QAAA;EAiBA;;;;;EAXA,iBAAA;EACA,UAAA;EACA,GAAA;;EAEA,cAAA;AAAA;;;;UAMgB,WAAA;EAChB,cAAA;EACA,QAAA;EAwBC;EAtBD,qBAAA;EA8BA;EA5BA,uBAAA;AAAA;;UAIgB,SAAA;EA0BsB;EAxBtC,gBAAA;EA0BA;EAxBA,OAAA;EAwBS;AAIV;;;;;EArBC,IAAA;IACC,OAAA;IACA,OAAA;IACA,OAAA;IACA,OAAA;IACA,QAAA;IACA,eAAA;EAAA;EAyBD;;;;;EAlBA,IAAA;EACA,QAAA;EACA,GAAA;IAAO,OAAA;IAAiB,IAAA;IAAc,QAAA;IAAkB,gBAAA;EAAA;EA4BxD;EA1BA,SAAA;AAAA;AAgCD;AAAA,UA5BiB,WAAA;;EAEhB,QAAA;EA0BiE;EAxBjE,KAAA;EA8BsB;;EA3BtB,IAAA;IAAQ,OAAA;IAAiB,OAAA;IAAiB,OAAA;IAAiB,qBAAA;EAAA;EAC3D,cAAA;EACA,SAAA;EACA,GAAA;IAAO,QAAA;IAAkB,KAAA;IAAe,cAAA;EAAA;EACxC,SAAA;AAAA;AAAA,KAUI,uBAAA,GAA0B,IAAA,CAAK,gBAAA;EACnC,MAAA;AAAA;;;;UAMgB,uBAAA,SAAgC,iBAAA;;;;;iBAMjC,OAAA,iCAAA,CAAA;EACf,IAAA;EACA,OAAA;EACA;AAAA;EAEA,IAAA,GAAO,IAAA;EACP,OAAA;EACA,MAAA,GAAS,aAAA;AAAA,IACN,qBAAA,CAAsB,uBAAA,EAAyB,IAAA,EAAM,aAAA;;;;;;;;cAc5C,aAAA;EAAA;WACH,GAAA,EAAK,aAAA;cAgBF,IAAA;IACX,OAAA;IACA,MAAA,EAAQ,uBAAA;IACR,MAAA,GAAS,aAAA;EAAA;EAuV0C;EAhVpD,YAAA,CAAa,KAAA;EAAA,SA0NJ,EAAA;yBACW,WAAA;6BAkBL,UAAA,mBACc,IAAA;MAClB,MAAA;IAAA,MACP,WAAA;8BAuCW,UAAA,mBACc,IAAA;MAClB,YAAA;IAAA,MACP,WAAA;0BAqBiB,CAAA,EAAK,gBAAA,EAAgB,IAAA,EAAQ,WAAA,KAAc,OAAA,CAAQ,WAAA;gCAIzD,CAAA,EACV,gBAAA,EAAgB,IAAA,EACb,iBAAA,KACJ,OAAA,CAAQ,WAAA;4BA0BW,CAAA,EAAK,gBAAA,EAAgB,IAAA,EAAQ,YAAA,KAAe,OAAA,CAAQ,WAAA;kCAI5D,CAAA,EACV,IAAA,CAAK,gBAAA,2CAAyD,IAAA,EAC3D,IAAA,CAAK,YAAA,iBACT,OAAA,CAAQ,WAAA;+BAkBc,UAAA,sBAAgC,WAAA;iCAmB9B,MAAA,aAAmB,WAAA;qCAcf,KAAA,aAAkB,WAAA;uCAUhB,KAAA,aAAkB,WAAA;oCAcrB,aAAA,aAA0B,WAAA;yCAWrB,WAAA;EAAA;EAAA,SAU3B,IAAA;mBAGW,OAAA,CAAQ,YAAA;iCAeA,QAAA,UAAkB,OAAA,aAAoB,OAAA;kCAM/B,OAAA,CAAQ,YAAA;eAezB,uBAAA,KAA0B,OAAA;MAAU,EAAA;MAAY,IAAA;IAAA;gBAuB7D,IAAA,CAAK,gBAAA,iCACN,OAAA,CAAQ,WAAA;MAAgB,IAAA,EAAM,cAAA;IAAA;+BAWnB,CAAA,EACV,gBAAA,EAAgB,IAAA,EACb,IAAA,CAAK,WAAA,kBACT,OAAA,CAAQ,SAAA;iCAiCG,CAAA,EACV,gBAAA,EAAgB,IAAA,EACb,YAAA,KACJ,OAAA,CAAQ,WAAA;gBAoBP,IAAA,CAAK,gBAAA,iCACN,OAAA,CAAQ,aAAA;gCAsBqB,OAAA;mCAIH,OAAA;gBAGb,OAAA,CAAQ,WAAA;EAAA;EAAA,SAiBhB,MAAA;cACE,0BAAA,KAA0B,WAAA;eACzB,0BAAA,KAA0B,WAAA;gBACzB,0BAAA,KAA0B,aAAA;iBAEzB,0BAAA,KAA0B,aAAA;eAC5B,0BAAA,KAA0B,YAAA;gBAEzB,0BAAA,KAA0B,YAAA;uBACnB,0BAAA,KAA0B,oBAAA;iBAEhC,0BAAA,KAA0B,oBAAA;kBAEzB,0BAAA,KAA0B,oBAAA;oBAExB,0BAAA,KAA0B,iBAAA;mBAE3B,0BAAA,KAA0B,gBAAA;qBAExB,0BAAA,KAA0B,kBAAA;EAAA;AAAA"}