@dimes-dot-fi/sdk 1.4.3 → 2.0.0

package/dist/contract/index.d.cts

@@ -1,8 +1,8 @@
 import { Abi, Address, Hex } from 'viem';
 export { Address, Hex } from 'viem';
-import { O as Offer } from '../aliases-C2l_JZX_.cjs';
-import { D as DimesClient } from '../dimes-client-ty6xwk0b.cjs';
-import { a as DimesContractError } from '../dimes-error-5ldDx2_G.cjs';
+import { Q as Quote, d as ContractInfo } from '../aliases-BJyM8ydu.cjs';
+import { D as DimesClient } from '../dimes-client-DZPhU1CG.cjs';
+import { D as DimesContractError } from '../dimes-error-BlQWPqhQ.cjs';
 
 declare const vaultAbi: Abi;
 declare const erc20Abi: readonly [{
@@ -71,9 +71,16 @@ interface RequestCloseTxData {
     functionName: "requestClose";
     args: readonly [`0x${string}`];
 }
-declare function buildCreatePositionTx(offer: Offer): CreatePositionTxData;
+interface RequestPartialCloseTxData {
+    address: `0x${string}`;
+    abi: Abi;
+    functionName: "requestPartialClose";
+    args: readonly [`0x${string}`, bigint];
+}
+declare function buildCreatePositionTx(quote: Quote): CreatePositionTxData;
 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;
 
 /**
  * Helpers for opening and closing positions from a Polymarket **deposit wallet** (DW).
@@ -134,13 +141,13 @@ declare const depositWalletBatchTypes: {
 /**
  * Build the three inner calls for a push-funded `createPosition`.
  *
- * The relayer submits these atomically; `offer.totalUserAmountUsdcUnits` is the
+ * The relayer submits these atomically; `quote.totalUserAmountUsdcUnits` is the
  * contract-ready amount (collateral + fees) used for both the reservation and the transfer.
  *
- * @param offer - the signed offer returned by the quote endpoint
+ * @param quote - the signed quote returned by the quote endpoint
  * @param pUsdAddress - the pUSD (USDC) token address (from `GET /contract-info`)
  */
-declare function buildPushFundedCreateCalls(offer: Offer, pUsdAddress: string): DepositWalletCall[];
+declare function buildPushFundedCreateCalls(quote: Quote, pUsdAddress: string): DepositWalletCall[];
 /**
  * Build the single inner call for a deposit-wallet `requestClose`.
  *
@@ -148,6 +155,14 @@ declare function buildPushFundedCreateCalls(offer: Offer, pUsdAddress: string):
  * @param positionKey - the `on_chain_position_key` field from `GET /positions`
  */
 declare function buildRequestCloseCalls(vaultAddress: string, positionKey: string): DepositWalletCall[];
+/**
+ * Build the single inner call for a deposit-wallet `requestPartialClose`.
+ *
+ * @param vaultAddress - the vault contract address
+ * @param positionKey - the `on_chain_position_key` field from `GET /positions`
+ * @param closeTokenUnits - the slice to close, in token units (1000000 units = 1 token)
+ */
+declare function buildRequestPartialCloseCalls(vaultAddress: string, positionKey: string, closeTokenUnits: bigint): DepositWalletCall[];
 interface BuildBatchParams {
     depositWalletAddress: string;
     /** Current `nonce()` read from the deposit wallet. */
@@ -226,10 +241,53 @@ interface BuildRelayerHeadersParams {
  */
 declare function buildRelayerAuthHeaders(params: BuildRelayerHeadersParams): Promise<Record<string, string>>;
 
-declare function recoverCreatePositionSigner(offer: Offer, userAddress: `0x${string}`): Promise<`0x${string}`>;
+declare function recoverCreatePositionSigner(quote: Quote, userAddress: `0x${string}`): Promise<`0x${string}`>;
 declare function resolveExpectedSigner(apiSigner: string | undefined): `0x${string}` | undefined;
-declare function verifyOfferSignature(client: DimesClient, offer: Offer, userAddress: `0x${string}`): Promise<void>;
+/**
+ * Recover the quote's contract signer and assert it matches `expectedSigner`,
+ * throwing `DimesContractError("invalid_signer")` on mismatch.
+ *
+ * Use this when you already hold the authorized signer address (e.g. from a cached
+ * `GET /contract-info` query) and don't want to plumb a {@link DimesClient} through.
+ * {@link verifyQuoteSignature} is the client-based convenience that fetches and caches
+ * the signer for you, then delegates here.
+ */
+declare function assertQuoteSigner(quote: Quote, userAddress: `0x${string}`, expectedSigner: `0x${string}`): Promise<void>;
+/**
+ * Fetch `GET /contract-info` once per {@link DimesClient} and cache it. Use this to read
+ * any on-chain config (signer, vault, pUSD token address) without re-hitting the API.
+ */
+declare function getCachedContractInfo(client: DimesClient): Promise<ContractInfo>;
+declare function verifyQuoteSignature(client: DimesClient, quote: Quote, userAddress: `0x${string}`): Promise<void>;
+/** @deprecated Renamed to {@link verifyQuoteSignature}. Kept as an alias for backward compatibility. */
+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.
+ *
+ * Prefer this over the raw {@link buildCreatePositionTx} so a tampered or stale
+ * quote fails fast in the client instead of reverting on-chain. Throws
+ * `DimesContractError("invalid_signer")` if the signature does not verify.
+ *
+ * @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>;
+/**
+ * Verify a quote's signature (see {@link buildVerifiedCreatePositionTx}) and then
+ * build the push-funded deposit-wallet calls. Prefer this over the raw
+ * {@link buildPushFundedCreateCalls}: it resolves the correct pUSD token address from
+ * the client's cached `GET /contract-info`, so the transfer can never target the wrong
+ * stablecoin (e.g. USDC.e instead of pUSD).
+ *
+ * @param userAddress - the deposit wallet that will be `msg.sender` on-chain.
+ * @param pUsdAddress - optional override for the pUSD (USDC) token address. Omit it to
+ *   use the canonical address from `GET /contract-info`; only pass it to force a
+ *   specific token.
+ */
+declare function buildVerifiedPushFundedCreateCalls(client: DimesClient, quote: Quote, userAddress: `0x${string}`, pUsdAddress?: string): Promise<DepositWalletCall[]>;
 
 declare function formatContractError(err: unknown): DimesContractError;
 
-export { type ApproveTxData, type CreatePositionTxData, type DepositWalletBatch, type DepositWalletCall, type RequestCloseTxData, buildApproveTx, buildCreatePositionTx, buildDepositWalletBatch, buildPushFundedCreateCalls, buildRelayerAuthHeaders, buildRelayerSubmitPayload, buildRequestCloseCalls, buildRequestCloseTx, depositWalletBatchTypes, depositWalletFactoryAddress, erc20Abi, formatContractError, getDepositWalletBatchTypedData, polymarketRelayerBaseUrl, recoverCreatePositionSigner, resolveExpectedSigner, toAddress, toHex, vaultAbi, verifyOfferSignature };
+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 };

package/dist/contract/index.d.ts

@@ -1,8 +1,8 @@
 import { Abi, Address, Hex } from 'viem';
 export { Address, Hex } from 'viem';
-import { O as Offer } from '../aliases-C2l_JZX_.js';
-import { D as DimesClient } from '../dimes-client-u5wLYVfp.js';
-import { a as DimesContractError } from '../dimes-error-D2RVknPr.js';
+import { Q as Quote, d as ContractInfo } from '../aliases-BJyM8ydu.js';
+import { D as DimesClient } from '../dimes-client-DYFvnZUx.js';
+import { D as DimesContractError } from '../dimes-error-DBKV5bfr.js';
 
 declare const vaultAbi: Abi;
 declare const erc20Abi: readonly [{
@@ -71,9 +71,16 @@ interface RequestCloseTxData {
     functionName: "requestClose";
     args: readonly [`0x${string}`];
 }
-declare function buildCreatePositionTx(offer: Offer): CreatePositionTxData;
+interface RequestPartialCloseTxData {
+    address: `0x${string}`;
+    abi: Abi;
+    functionName: "requestPartialClose";
+    args: readonly [`0x${string}`, bigint];
+}
+declare function buildCreatePositionTx(quote: Quote): CreatePositionTxData;
 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;
 
 /**
  * Helpers for opening and closing positions from a Polymarket **deposit wallet** (DW).
@@ -134,13 +141,13 @@ declare const depositWalletBatchTypes: {
 /**
  * Build the three inner calls for a push-funded `createPosition`.
  *
- * The relayer submits these atomically; `offer.totalUserAmountUsdcUnits` is the
+ * The relayer submits these atomically; `quote.totalUserAmountUsdcUnits` is the
  * contract-ready amount (collateral + fees) used for both the reservation and the transfer.
  *
- * @param offer - the signed offer returned by the quote endpoint
+ * @param quote - the signed quote returned by the quote endpoint
  * @param pUsdAddress - the pUSD (USDC) token address (from `GET /contract-info`)
  */
-declare function buildPushFundedCreateCalls(offer: Offer, pUsdAddress: string): DepositWalletCall[];
+declare function buildPushFundedCreateCalls(quote: Quote, pUsdAddress: string): DepositWalletCall[];
 /**
  * Build the single inner call for a deposit-wallet `requestClose`.
  *
@@ -148,6 +155,14 @@ declare function buildPushFundedCreateCalls(offer: Offer, pUsdAddress: string):
  * @param positionKey - the `on_chain_position_key` field from `GET /positions`
  */
 declare function buildRequestCloseCalls(vaultAddress: string, positionKey: string): DepositWalletCall[];
+/**
+ * Build the single inner call for a deposit-wallet `requestPartialClose`.
+ *
+ * @param vaultAddress - the vault contract address
+ * @param positionKey - the `on_chain_position_key` field from `GET /positions`
+ * @param closeTokenUnits - the slice to close, in token units (1000000 units = 1 token)
+ */
+declare function buildRequestPartialCloseCalls(vaultAddress: string, positionKey: string, closeTokenUnits: bigint): DepositWalletCall[];
 interface BuildBatchParams {
     depositWalletAddress: string;
     /** Current `nonce()` read from the deposit wallet. */
@@ -226,10 +241,53 @@ interface BuildRelayerHeadersParams {
  */
 declare function buildRelayerAuthHeaders(params: BuildRelayerHeadersParams): Promise<Record<string, string>>;
 
-declare function recoverCreatePositionSigner(offer: Offer, userAddress: `0x${string}`): Promise<`0x${string}`>;
+declare function recoverCreatePositionSigner(quote: Quote, userAddress: `0x${string}`): Promise<`0x${string}`>;
 declare function resolveExpectedSigner(apiSigner: string | undefined): `0x${string}` | undefined;
-declare function verifyOfferSignature(client: DimesClient, offer: Offer, userAddress: `0x${string}`): Promise<void>;
+/**
+ * Recover the quote's contract signer and assert it matches `expectedSigner`,
+ * throwing `DimesContractError("invalid_signer")` on mismatch.
+ *
+ * Use this when you already hold the authorized signer address (e.g. from a cached
+ * `GET /contract-info` query) and don't want to plumb a {@link DimesClient} through.
+ * {@link verifyQuoteSignature} is the client-based convenience that fetches and caches
+ * the signer for you, then delegates here.
+ */
+declare function assertQuoteSigner(quote: Quote, userAddress: `0x${string}`, expectedSigner: `0x${string}`): Promise<void>;
+/**
+ * Fetch `GET /contract-info` once per {@link DimesClient} and cache it. Use this to read
+ * any on-chain config (signer, vault, pUSD token address) without re-hitting the API.
+ */
+declare function getCachedContractInfo(client: DimesClient): Promise<ContractInfo>;
+declare function verifyQuoteSignature(client: DimesClient, quote: Quote, userAddress: `0x${string}`): Promise<void>;
+/** @deprecated Renamed to {@link verifyQuoteSignature}. Kept as an alias for backward compatibility. */
+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.
+ *
+ * Prefer this over the raw {@link buildCreatePositionTx} so a tampered or stale
+ * quote fails fast in the client instead of reverting on-chain. Throws
+ * `DimesContractError("invalid_signer")` if the signature does not verify.
+ *
+ * @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>;
+/**
+ * Verify a quote's signature (see {@link buildVerifiedCreatePositionTx}) and then
+ * build the push-funded deposit-wallet calls. Prefer this over the raw
+ * {@link buildPushFundedCreateCalls}: it resolves the correct pUSD token address from
+ * the client's cached `GET /contract-info`, so the transfer can never target the wrong
+ * stablecoin (e.g. USDC.e instead of pUSD).
+ *
+ * @param userAddress - the deposit wallet that will be `msg.sender` on-chain.
+ * @param pUsdAddress - optional override for the pUSD (USDC) token address. Omit it to
+ *   use the canonical address from `GET /contract-info`; only pass it to force a
+ *   specific token.
+ */
+declare function buildVerifiedPushFundedCreateCalls(client: DimesClient, quote: Quote, userAddress: `0x${string}`, pUsdAddress?: string): Promise<DepositWalletCall[]>;
 
 declare function formatContractError(err: unknown): DimesContractError;
 
-export { type ApproveTxData, type CreatePositionTxData, type DepositWalletBatch, type DepositWalletCall, type RequestCloseTxData, buildApproveTx, buildCreatePositionTx, buildDepositWalletBatch, buildPushFundedCreateCalls, buildRelayerAuthHeaders, buildRelayerSubmitPayload, buildRequestCloseCalls, buildRequestCloseTx, depositWalletBatchTypes, depositWalletFactoryAddress, erc20Abi, formatContractError, getDepositWalletBatchTypedData, polymarketRelayerBaseUrl, recoverCreatePositionSigner, resolveExpectedSigner, toAddress, toHex, vaultAbi, verifyOfferSignature };
+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 };