@0xmonaco/core 1.1.6 → 1.1.8

package/dist/errors/errors.js

@@ -804,6 +804,64 @@ export class ContractError extends MonacoCoreError {
         };
     }
 }
+/**
+ * Error thrown when the vault refuses a withdrawal because it exceeds the
+ * token's withdrawal rate limit (the contract's `WithdrawalRateLimited`
+ * revert).
+ *
+ * The vault caps how much withdrawals against recently confirmed roots can pay
+ * out at once, per token, and refills that allowance over time. A refused
+ * withdrawal is not lost: its balance is already debited and its index stays
+ * valid. Retry it with `sdk.vault.retryWithdrawal(withdrawalIndex)` once the
+ * limit has refilled, or once the withdrawal's root is a day old, when the limit
+ * no longer applies to it.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await sdk.vault.withdraw(assetId, amount);
+ * } catch (error) {
+ *   if (error instanceof WithdrawalRateLimitedError) {
+ *     // Keep error.withdrawalIndex and retry later.
+ *     console.log(`${error.available} of ${error.amount} can be paid out now`);
+ *   }
+ * }
+ * ```
+ */
+export class WithdrawalRateLimitedError extends ContractError {
+    /** The refused withdrawal's index; pass it to `retryWithdrawal`. */
+    withdrawalIndex;
+    /** The limited token's address (WSEI's for native withdrawals). */
+    token;
+    /** What the limit lets withdrawals pay out now, in the token's raw units. */
+    available;
+    /** The withdrawal's amount, in the token's raw units. */
+    amount;
+    constructor(withdrawalIndex, details) {
+        super(`Withdrawal ${withdrawalIndex} exceeds the vault's withdrawal rate limit for token ${details.token}: ` +
+            `${details.available} of its ${details.amount} can be paid out now. Its balance stays debited and its index stays valid: ` +
+            `retry with retryWithdrawal(${withdrawalIndex}) once the limit refills, or once the withdrawal's root is a day old.`, {
+            revertReason: "WithdrawalRateLimited",
+            contractAddress: details.contractAddress,
+            transactionHash: details.transactionHash,
+            cause: details.cause,
+        });
+        this.retryable = true;
+        this.withdrawalIndex = withdrawalIndex;
+        this.token = details.token;
+        this.available = details.available;
+        this.amount = details.amount;
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            withdrawalIndex: this.withdrawalIndex,
+            token: this.token,
+            available: this.available.toString(),
+            amount: this.amount.toString(),
+        };
+    }
+}
 /**
  * Get suggestions for common contract errors
  */
@@ -812,6 +870,9 @@ function getContractErrorSuggestion(revertReason) {
         return "Smart contract execution failed. Check transaction parameters and try again.";
     }
     const reason = revertReason.toLowerCase();
+    if (reason.includes("withdrawalratelimited")) {
+        return "The vault's withdrawal rate limit for this token is spent for now. Retry with sdk.vault.retryWithdrawal(withdrawalIndex) once it refills, or once the withdrawal's root is a day old.";
+    }
     if (reason.includes("insufficient allowance")) {
         return "Token allowance is insufficient. Call sdk.vault.approve() to increase the token allowance for the vault contract.";
     }

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { createMonacoWebSocket, type MonacoWebSocket, type MonacoWebSocketOptions } from "./api/websocket";
-export { APIError, ContractError, InvalidConfigError, InvalidStateError, MonacoCoreError } from "./errors";
+export { APIError, ContractError, InvalidConfigError, InvalidStateError, MonacoCoreError, WithdrawalRateLimitedError } from "./errors";
 export { resolveApiUrl, resolveWsUrl } from "./networks";
 export { createMonacoSDK, MonacoSDKImpl as MonacoSDK } from "./sdk";
 export { ALL_MAGNITUDES, calculateValidMagnitudes, MAX_BUCKETS_ALLOWED, MIN_BUCKETS_ALLOWED, } from "./utils";

package/dist/index.js

@@ -1,5 +1,5 @@
 export { createMonacoWebSocket } from "./api/websocket";
-export { APIError, ContractError, InvalidConfigError, InvalidStateError, MonacoCoreError } from "./errors";
+export { APIError, ContractError, InvalidConfigError, InvalidStateError, MonacoCoreError, WithdrawalRateLimitedError } from "./errors";
 export { resolveApiUrl, resolveWsUrl } from "./networks";
 export { createMonacoSDK, MonacoSDKImpl as MonacoSDK } from "./sdk";
 export { ALL_MAGNITUDES, calculateValidMagnitudes, MAX_BUCKETS_ALLOWED, MIN_BUCKETS_ALLOWED, } from "./utils";

package/dist/sdk.js

@@ -171,6 +171,9 @@ export class MonacoSDKImpl {
         this.subAccounts = configureSigning(new SubAccountsAPIImpl(apiUrl));
         this.faucet = configureSigning(new FaucetAPIImpl(apiUrl));
         this.sweeper = configureSigning(new SweeperAPIImpl(apiUrl));
+        if (this.walletClient) {
+            this.sweeper.setWalletClient(this.walletClient);
+        }
         this.managedMarkets = configureSigning(new ManagedMarketsAPIImpl(apiUrl));
         this.pulse = configureSigning(new PulseAPIImpl(apiUrl));
         this.compliance = configureSigning(new ComplianceAPIImpl(apiUrl));
@@ -377,6 +380,7 @@ export class MonacoSDKImpl {
         // Update APIs that depend on wallet client
         this.auth.setWalletClient(walletClient);
         this.vault.setWalletClient(walletClient);
+        this.sweeper.setWalletClient(walletClient);
     }
     /**
      * Get the current account address

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@0xmonaco/core",
-	"version": "1.1.6",
+	"version": "1.1.8",
 	"type": "module",
 	"homepage": "https://docs.0xmonaco.com/sdk/typescript",
 	"main": "./dist/index.js",
@@ -19,8 +19,8 @@
 		"viem": "^2.45.2"
 	},
 	"dependencies": {
-		"@0xmonaco/contracts": "1.1.6",
-		"@0xmonaco/types": "1.1.6",
+		"@0xmonaco/contracts": "1.1.8",
+		"@0xmonaco/types": "1.1.8",
 		"@noble/curves": "^2.4.0",
 		"@noble/hashes": "^2.4.0",
 		"http-status-codes": "^2.3.0"