@dimes-dot-fi/sdk 2.3.0 → 2.5.0

package/dist/contract/index.d.cts

@@ -1,8 +1,8 @@
 import { Abi, Address, Hex } from 'viem';
 export { Address, Hex } from 'viem';
-import { Q as Quote, e as ContractInfo } from '../aliases-Dne14KBa.cjs';
-import { D as DimesClient } from '../dimes-client-D9tohawC.cjs';
-import { D as DimesContractError } from '../dimes-error-E9yPAZb-.cjs';
+import { Q as Quote, f as ContractInfo } from '../aliases-lNsFUKPA.cjs';
+import { D as DimesClient } from '../dimes-client-BUAeOsgL.cjs';
+import { D as DimesContractError } from '../dimes-error-I7lEZ2V5.cjs';
 
 declare const vaultAbi: Abi;
 declare const erc20Abi: readonly [{
@@ -59,6 +59,31 @@ interface CreatePositionTxData {
         bigint
     ];
 }
+interface CreatePositionWithMarginTxData {
+    address: `0x${string}`;
+    abi: Abi;
+    functionName: "createPositionWithMargin";
+    args: readonly [
+        `0x${string}`,
+        `0x${string}`,
+        bigint,
+        bigint,
+        number,
+        bigint,
+        number,
+        number,
+        number,
+        bigint,
+        bigint,
+        `0x${string}`,
+        bigint
+    ];
+}
+/**
+ * What {@link buildCreatePositionTx} returns: the plain call for an adaptive quote, the
+ * margin-bearing call for a committed one.
+ */
+type OpenPositionTxData = CreatePositionTxData | CreatePositionWithMarginTxData;
 interface ApproveTxData {
     address: `0x${string}`;
     abi: typeof erc20Abi;
@@ -77,11 +102,34 @@ interface RequestPartialCloseTxData {
     functionName: "requestPartialClose";
     args: readonly [`0x${string}`, bigint];
 }
-declare function buildCreatePositionTx(quote: Quote): CreatePositionTxData;
+/**
+ * Build the vault call that opens the position this quote was signed for.
+ *
+ * The quote names its own mode in `riskMode`: a committed-mode quote
+ * is signed over a different EIP-712 type and opens through `createPositionWithMargin`, which
+ * pulls `marginUsdcUnits` on top of collateral and fees. Submitting one quote's signature to
+ * the other entry point always reverts, so the mode is read off the quote rather than left to
+ * the caller.
+ *
+ * `quote.totalUserAmountUsdcUnits` already includes the margin — approve that amount.
+ */
+declare function buildCreatePositionTx(quote: Quote): OpenPositionTxData;
 declare function buildApproveTx(usdcAddress: `0x${string}`, spender: `0x${string}`, amount: bigint): ApproveTxData;
 declare function buildRequestCloseTx(vaultAddress: `0x${string}`, positionKey: `0x${string}`): RequestCloseTxData;
 declare function buildRequestPartialCloseTx(vaultAddress: `0x${string}`, positionKey: `0x${string}`, closeTokenUnits: bigint): RequestPartialCloseTxData;
 
+/**
+ * Whether this quote opens in committed mode — a fixed ladder of price-triggered unwinds,
+ * backed by extra margin locked in the vault.
+ *
+ * Read from `riskMode`, the quote's own statement of the mode it was issued in, so a quote
+ * issued before committed mode existed reads as adaptive. Asking for committed mode does not
+ * guarantee getting it: when the market, price or leverage rules it out the request is rejected
+ * with `quote_committed_risk_mode_unavailable`, and a partner without the beta feature enabled
+ * is rejected with `beta_feature_not_enabled`.
+ */
+declare function isCommittedQuote(quote: Quote): boolean;
+
 /**
  * Helpers for opening and closing positions from a Polymarket **deposit wallet** (DW).
  *
@@ -142,7 +190,12 @@ declare const depositWalletBatchTypes: {
  * Build the three inner calls for a push-funded `createPosition`.
  *
  * The relayer submits these atomically; `quote.totalUserAmountUsdcUnits` is the
- * contract-ready amount (collateral + fees) used for both the reservation and the transfer.
+ * contract-ready amount (collateral + fees + committed-mode margin) used for both the
+ * reservation and the transfer. The vault checks the pushed amount for exact equality, so
+ * a committed quote whose margin was left out of the transfer reverts the whole batch.
+ *
+ * A committed quote is opened through `createPositionPushFundedWithMargin`, chosen from the
+ * quote itself — see {@link isCommittedQuote}.
  *
  * @param quote - the signed quote returned by the quote endpoint
  * @param pUsdAddress - the pUSD (USDC) token address (from `GET /contract-info`)
@@ -241,6 +294,13 @@ interface BuildRelayerHeadersParams {
  */
 declare function buildRelayerAuthHeaders(params: BuildRelayerHeadersParams): Promise<Record<string, string>>;
 
+/**
+ * Recover the address that signed this quote.
+ *
+ * A committed-mode quote is signed over `CreatePositionWithMargin`, a separate EIP-712 type
+ * carrying `marginUsdcUnits`; recovering it against the adaptive type would yield a garbage
+ * address, so the type is chosen from the quote itself.
+ */
 declare function recoverCreatePositionSigner(quote: Quote, userAddress: `0x${string}`): Promise<`0x${string}`>;
 declare function resolveExpectedSigner(apiSigner: string | undefined): `0x${string}` | undefined;
 /**
@@ -264,7 +324,8 @@ declare const verifyOfferSignature: typeof verifyQuoteSignature;
 
 /**
  * Verify a quote's signature against the on-chain authority (using the client's
- * cached `/contract-info`) and then build the `createPosition` transaction.
+ * cached `/contract-info`) and then build the transaction that opens the position —
+ * `createPosition`, or `createPositionWithMargin` for a committed-mode quote.
  *
  * Prefer this over the raw {@link buildCreatePositionTx} so a tampered or stale
  * quote fails fast in the client instead of reverting on-chain. Throws
@@ -273,7 +334,7 @@ declare const verifyOfferSignature: typeof verifyQuoteSignature;
  * @param userAddress - the wallet that will submit the tx (the signed `user`,
  *   bound to `msg.sender` by the contract).
  */
-declare function buildVerifiedCreatePositionTx(client: DimesClient, quote: Quote, userAddress: `0x${string}`): Promise<CreatePositionTxData>;
+declare function buildVerifiedCreatePositionTx(client: DimesClient, quote: Quote, userAddress: `0x${string}`): Promise<OpenPositionTxData>;
 /**
  * Verify a quote's signature (see {@link buildVerifiedCreatePositionTx}) and then
  * build the push-funded deposit-wallet calls. Prefer this over the raw
@@ -290,4 +351,4 @@ declare function buildVerifiedPushFundedCreateCalls(client: DimesClient, quote:
 
 declare function formatContractError(err: unknown): DimesContractError;
 
-export { type ApproveTxData, type CreatePositionTxData, type DepositWalletBatch, type DepositWalletCall, type RequestCloseTxData, type RequestPartialCloseTxData, assertQuoteSigner, buildApproveTx, buildCreatePositionTx, buildDepositWalletBatch, buildPushFundedCreateCalls, buildRelayerAuthHeaders, buildRelayerSubmitPayload, buildRequestCloseCalls, buildRequestCloseTx, buildRequestPartialCloseCalls, buildRequestPartialCloseTx, buildVerifiedCreatePositionTx, buildVerifiedPushFundedCreateCalls, depositWalletBatchTypes, depositWalletFactoryAddress, erc20Abi, formatContractError, getCachedContractInfo, getDepositWalletBatchTypedData, polymarketRelayerBaseUrl, recoverCreatePositionSigner, resolveExpectedSigner, toAddress, toHex, vaultAbi, verifyOfferSignature, verifyQuoteSignature };
+export { type ApproveTxData, type CreatePositionTxData, type CreatePositionWithMarginTxData, type DepositWalletBatch, type DepositWalletCall, type OpenPositionTxData, type RequestCloseTxData, type RequestPartialCloseTxData, assertQuoteSigner, buildApproveTx, buildCreatePositionTx, buildDepositWalletBatch, buildPushFundedCreateCalls, buildRelayerAuthHeaders, buildRelayerSubmitPayload, buildRequestCloseCalls, buildRequestCloseTx, buildRequestPartialCloseCalls, buildRequestPartialCloseTx, buildVerifiedCreatePositionTx, buildVerifiedPushFundedCreateCalls, depositWalletBatchTypes, depositWalletFactoryAddress, erc20Abi, formatContractError, getCachedContractInfo, getDepositWalletBatchTypedData, isCommittedQuote, polymarketRelayerBaseUrl, recoverCreatePositionSigner, resolveExpectedSigner, toAddress, toHex, vaultAbi, verifyOfferSignature, verifyQuoteSignature };

package/dist/contract/index.d.ts

@@ -1,8 +1,8 @@
 import { Abi, Address, Hex } from 'viem';
 export { Address, Hex } from 'viem';
-import { Q as Quote, e as ContractInfo } from '../aliases-Dne14KBa.js';
-import { D as DimesClient } from '../dimes-client-DJ1d_p31.js';
-import { D as DimesContractError } from '../dimes-error-hSoOierP.js';
+import { Q as Quote, f as ContractInfo } from '../aliases-lNsFUKPA.js';
+import { D as DimesClient } from '../dimes-client-DDF-f8yA.js';
+import { D as DimesContractError } from '../dimes-error-CkcjExUy.js';
 
 declare const vaultAbi: Abi;
 declare const erc20Abi: readonly [{
@@ -59,6 +59,31 @@ interface CreatePositionTxData {
         bigint
     ];
 }
+interface CreatePositionWithMarginTxData {
+    address: `0x${string}`;
+    abi: Abi;
+    functionName: "createPositionWithMargin";
+    args: readonly [
+        `0x${string}`,
+        `0x${string}`,
+        bigint,
+        bigint,
+        number,
+        bigint,
+        number,
+        number,
+        number,
+        bigint,
+        bigint,
+        `0x${string}`,
+        bigint
+    ];
+}
+/**
+ * What {@link buildCreatePositionTx} returns: the plain call for an adaptive quote, the
+ * margin-bearing call for a committed one.
+ */
+type OpenPositionTxData = CreatePositionTxData | CreatePositionWithMarginTxData;
 interface ApproveTxData {
     address: `0x${string}`;
     abi: typeof erc20Abi;
@@ -77,11 +102,34 @@ interface RequestPartialCloseTxData {
     functionName: "requestPartialClose";
     args: readonly [`0x${string}`, bigint];
 }
-declare function buildCreatePositionTx(quote: Quote): CreatePositionTxData;
+/**
+ * Build the vault call that opens the position this quote was signed for.
+ *
+ * The quote names its own mode in `riskMode`: a committed-mode quote
+ * is signed over a different EIP-712 type and opens through `createPositionWithMargin`, which
+ * pulls `marginUsdcUnits` on top of collateral and fees. Submitting one quote's signature to
+ * the other entry point always reverts, so the mode is read off the quote rather than left to
+ * the caller.
+ *
+ * `quote.totalUserAmountUsdcUnits` already includes the margin — approve that amount.
+ */
+declare function buildCreatePositionTx(quote: Quote): OpenPositionTxData;
 declare function buildApproveTx(usdcAddress: `0x${string}`, spender: `0x${string}`, amount: bigint): ApproveTxData;
 declare function buildRequestCloseTx(vaultAddress: `0x${string}`, positionKey: `0x${string}`): RequestCloseTxData;
 declare function buildRequestPartialCloseTx(vaultAddress: `0x${string}`, positionKey: `0x${string}`, closeTokenUnits: bigint): RequestPartialCloseTxData;
 
+/**
+ * Whether this quote opens in committed mode — a fixed ladder of price-triggered unwinds,
+ * backed by extra margin locked in the vault.
+ *
+ * Read from `riskMode`, the quote's own statement of the mode it was issued in, so a quote
+ * issued before committed mode existed reads as adaptive. Asking for committed mode does not
+ * guarantee getting it: when the market, price or leverage rules it out the request is rejected
+ * with `quote_committed_risk_mode_unavailable`, and a partner without the beta feature enabled
+ * is rejected with `beta_feature_not_enabled`.
+ */
+declare function isCommittedQuote(quote: Quote): boolean;
+
 /**
  * Helpers for opening and closing positions from a Polymarket **deposit wallet** (DW).
  *
@@ -142,7 +190,12 @@ declare const depositWalletBatchTypes: {
  * Build the three inner calls for a push-funded `createPosition`.
  *
  * The relayer submits these atomically; `quote.totalUserAmountUsdcUnits` is the
- * contract-ready amount (collateral + fees) used for both the reservation and the transfer.
+ * contract-ready amount (collateral + fees + committed-mode margin) used for both the
+ * reservation and the transfer. The vault checks the pushed amount for exact equality, so
+ * a committed quote whose margin was left out of the transfer reverts the whole batch.
+ *
+ * A committed quote is opened through `createPositionPushFundedWithMargin`, chosen from the
+ * quote itself — see {@link isCommittedQuote}.
  *
  * @param quote - the signed quote returned by the quote endpoint
  * @param pUsdAddress - the pUSD (USDC) token address (from `GET /contract-info`)
@@ -241,6 +294,13 @@ interface BuildRelayerHeadersParams {
  */
 declare function buildRelayerAuthHeaders(params: BuildRelayerHeadersParams): Promise<Record<string, string>>;
 
+/**
+ * Recover the address that signed this quote.
+ *
+ * A committed-mode quote is signed over `CreatePositionWithMargin`, a separate EIP-712 type
+ * carrying `marginUsdcUnits`; recovering it against the adaptive type would yield a garbage
+ * address, so the type is chosen from the quote itself.
+ */
 declare function recoverCreatePositionSigner(quote: Quote, userAddress: `0x${string}`): Promise<`0x${string}`>;
 declare function resolveExpectedSigner(apiSigner: string | undefined): `0x${string}` | undefined;
 /**
@@ -264,7 +324,8 @@ declare const verifyOfferSignature: typeof verifyQuoteSignature;
 
 /**
  * Verify a quote's signature against the on-chain authority (using the client's
- * cached `/contract-info`) and then build the `createPosition` transaction.
+ * cached `/contract-info`) and then build the transaction that opens the position —
+ * `createPosition`, or `createPositionWithMargin` for a committed-mode quote.
  *
  * Prefer this over the raw {@link buildCreatePositionTx} so a tampered or stale
  * quote fails fast in the client instead of reverting on-chain. Throws
@@ -273,7 +334,7 @@ declare const verifyOfferSignature: typeof verifyQuoteSignature;
  * @param userAddress - the wallet that will submit the tx (the signed `user`,
  *   bound to `msg.sender` by the contract).
  */
-declare function buildVerifiedCreatePositionTx(client: DimesClient, quote: Quote, userAddress: `0x${string}`): Promise<CreatePositionTxData>;
+declare function buildVerifiedCreatePositionTx(client: DimesClient, quote: Quote, userAddress: `0x${string}`): Promise<OpenPositionTxData>;
 /**
  * Verify a quote's signature (see {@link buildVerifiedCreatePositionTx}) and then
  * build the push-funded deposit-wallet calls. Prefer this over the raw
@@ -290,4 +351,4 @@ declare function buildVerifiedPushFundedCreateCalls(client: DimesClient, quote:
 
 declare function formatContractError(err: unknown): DimesContractError;
 
-export { type ApproveTxData, type CreatePositionTxData, type DepositWalletBatch, type DepositWalletCall, type RequestCloseTxData, type RequestPartialCloseTxData, assertQuoteSigner, buildApproveTx, buildCreatePositionTx, buildDepositWalletBatch, buildPushFundedCreateCalls, buildRelayerAuthHeaders, buildRelayerSubmitPayload, buildRequestCloseCalls, buildRequestCloseTx, buildRequestPartialCloseCalls, buildRequestPartialCloseTx, buildVerifiedCreatePositionTx, buildVerifiedPushFundedCreateCalls, depositWalletBatchTypes, depositWalletFactoryAddress, erc20Abi, formatContractError, getCachedContractInfo, getDepositWalletBatchTypedData, polymarketRelayerBaseUrl, recoverCreatePositionSigner, resolveExpectedSigner, toAddress, toHex, vaultAbi, verifyOfferSignature, verifyQuoteSignature };
+export { type ApproveTxData, type CreatePositionTxData, type CreatePositionWithMarginTxData, type DepositWalletBatch, type DepositWalletCall, type OpenPositionTxData, type RequestCloseTxData, type RequestPartialCloseTxData, assertQuoteSigner, buildApproveTx, buildCreatePositionTx, buildDepositWalletBatch, buildPushFundedCreateCalls, buildRelayerAuthHeaders, buildRelayerSubmitPayload, buildRequestCloseCalls, buildRequestCloseTx, buildRequestPartialCloseCalls, buildRequestPartialCloseTx, buildVerifiedCreatePositionTx, buildVerifiedPushFundedCreateCalls, depositWalletBatchTypes, depositWalletFactoryAddress, erc20Abi, formatContractError, getCachedContractInfo, getDepositWalletBatchTypedData, isCommittedQuote, polymarketRelayerBaseUrl, recoverCreatePositionSigner, resolveExpectedSigner, toAddress, toHex, vaultAbi, verifyOfferSignature, verifyQuoteSignature };