@gauntlet-xyz/sdk 1.0.5 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gauntlet-xyz/sdk",
-  "version": "1.0.5",
+  "version": "2.0.0",
   "description": "Official Gauntlet SDK for vault deposits, withdrawals, and attribution",
   "license": "MIT",
   "keywords": [

package/src/constants.ts

@@ -0,0 +1,32 @@
+export const MAX_BPS = 10000n;
+export const DEFAULT_BPS = 100;
+
+export const SECOND = 1;
+export const MINUTE = SECOND * 60;
+export const HOUR = MINUTE * 60;
+export const DAY = HOUR * 24;
+
+export const REQUEST_DEADLINE_BUFFER_DAYS = 3;
+export const DEFAULT_MAX_PRICE_AGE_DAYS = 10;
+export const DEFAULT_SOLVER_TIP = 0n;
+export const DEFAULT_REQUEST_DEADLINE_BUFFER = DAY * REQUEST_DEADLINE_BUFFER_DAYS;
+export const DEFAULT_MAX_PRICE_AGE = BigInt(DAY * DEFAULT_MAX_PRICE_AGE_DAYS);
+
+export const CHAIN_NAMES: Record<number, string> = {
+  1: 'ethereum',
+  8453: 'base',
+  42161: 'arbitrum',
+  10: 'optimism',
+};
+
+// Approximate 3-day block lookback per chain based on avg block time.
+export const BLOCKS_3_DAYS: Record<number, bigint> = {
+  1: 21_600n,
+  8453: 129_600n,
+  42161: 1_036_800n,
+  10: 129_600n,
+};
+export const DEFAULT_BLOCKS_3_DAYS = 129_600n;
+
+// Many RPC providers cap eth_getLogs to 10,000 blocks per request.
+export const LOG_PAGE_SIZE = 9_999n;

package/src/errors.ts

@@ -1,4 +1,5 @@
-import { ChainId } from './client';
+import type { ChainId } from './client';
+import { MAX_BPS } from './constants';
 
 export class GauntletSDKError extends Error {
   constructor(message: string) {
@@ -48,10 +49,10 @@ export class ChainMismatchError extends GauntletSDKError {
 
 export class UnsupportedDepositModeError extends GauntletSDKError {
   readonly vaultId: string;
-  readonly requested: 'sync' | 'async';
+  readonly requested: string;
   readonly available: string;
 
-  constructor(vaultId: string, requested: 'sync' | 'async', available: string) {
+  constructor(vaultId: string, requested: string, available: string) {
     super(`Vault "${vaultId}" does not support ${requested} deposits (available: ${available})`);
     this.name = 'UnsupportedDepositModeError';
     this.vaultId = vaultId;
@@ -109,7 +110,7 @@ export class UnsupportedFeatureError extends GauntletSDKError {
 
   constructor(feature: string) {
     super(`Feature not supported: "${feature}"`);
-    this.name = 'UnimplementedFeatureError';
+    this.name = 'UnsupportedFeatureError';
     this.feature = feature;
   }
 }
@@ -124,11 +125,49 @@ export class UnitConversionError extends GauntletSDKError {
   }
 }
 
+export class StalePriceError extends GauntletSDKError {
+  readonly blockTimestamp: bigint;
+  readonly maxPriceAge: bigint;
+  readonly priceTimestamp: bigint;
+
+  constructor({
+    blockTimestamp,
+    maxPriceAge,
+    priceTimestamp,
+  }: {
+    blockTimestamp: bigint;
+    maxPriceAge: bigint;
+    priceTimestamp: bigint;
+  }) {
+    super(
+      `Price is stale: timestamp "${priceTimestamp}" with max age "${maxPriceAge}" is older than block timestamp "${blockTimestamp}"`
+    );
+    this.name = 'StalePriceError';
+    this.blockTimestamp = blockTimestamp;
+    this.maxPriceAge = maxPriceAge;
+    this.priceTimestamp = priceTimestamp;
+  }
+}
+
+export class InvalidSolverTipError extends GauntletSDKError {
+  readonly solverTip: bigint;
+  readonly availableAmount: bigint;
+
+  constructor(solverTip: bigint, availableAmount: bigint) {
+    super(
+      `Solver tip "${solverTip}" must be less than available token amount "${availableAmount}"`
+    );
+    this.name = 'InvalidSolverTipError';
+    this.solverTip = solverTip;
+    this.availableAmount = availableAmount;
+  }
+}
+
 export class InvalidSlippageBPSError extends GauntletSDKError {
   readonly slippage: number;
 
   constructor(slippage: number) {
-    super(`Slippage not in range of 10000-0; argumet passed: ${slippage}`);
+    super(`Slippage not in range of 0-${Number(MAX_BPS)}; argument passed: ${slippage}`);
     this.name = 'IncorrectArgument';
     this.slippage = slippage;
   }

package/src/evm/abis/priceAndFeeCalculatorV2.ts

@@ -0,0 +1,118 @@
+// Compact ABI derived from aera-finance/aera-contracts-v3@f4e3433058c29c3a0b1348ffbd358cc036a1687f
+// source: src/core/interfaces/IPriceAndFeeCalculatorV2.sol
+export const priceAndFeeCalculatorV2Abi = [
+  {
+    type: 'function',
+    inputs: [
+      { name: 'vault', internalType: 'address', type: 'address' },
+      { name: 'token', internalType: 'contract IERC20', type: 'address' },
+      { name: 'tokenAmount', internalType: 'uint256', type: 'uint256' },
+    ],
+    name: 'convertTokenToUnits',
+    outputs: [{ name: 'unitsAmount', internalType: 'uint256', type: 'uint256' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    inputs: [
+      { name: 'vault', internalType: 'address', type: 'address' },
+      { name: 'token', internalType: 'contract IERC20', type: 'address' },
+      { name: 'tokenAmount', internalType: 'uint256', type: 'uint256' },
+      { name: 'rounding', internalType: 'enum Math.Rounding', type: 'uint8' },
+    ],
+    name: 'convertTokenToUnitsIfActive',
+    outputs: [{ name: 'unitsAmount', internalType: 'uint256', type: 'uint256' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    inputs: [
+      { name: 'vault', internalType: 'address', type: 'address' },
+      { name: 'token', internalType: 'contract IERC20', type: 'address' },
+      { name: 'unitsAmount', internalType: 'uint256', type: 'uint256' },
+    ],
+    name: 'convertUnitsToToken',
+    outputs: [{ name: 'tokenAmount', internalType: 'uint256', type: 'uint256' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    inputs: [
+      { name: 'vault', internalType: 'address', type: 'address' },
+      { name: 'token', internalType: 'contract IERC20', type: 'address' },
+      { name: 'unitsAmount', internalType: 'uint256', type: 'uint256' },
+      { name: 'rounding', internalType: 'enum Math.Rounding', type: 'uint8' },
+    ],
+    name: 'convertUnitsToTokenIfActive',
+    outputs: [{ name: 'tokenAmount', internalType: 'uint256', type: 'uint256' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    inputs: [{ name: 'vault', internalType: 'address', type: 'address' }],
+    name: 'getAnchorTimestamp',
+    outputs: [{ name: 'timestamp', internalType: 'uint32', type: 'uint32' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    inputs: [{ name: 'vault', internalType: 'address', type: 'address' }],
+    name: 'getVaultState',
+    outputs: [
+      {
+        name: '',
+        internalType: 'struct VaultPriceStateV2',
+        type: 'tuple',
+        components: [
+          { name: 'paused', internalType: 'bool', type: 'bool' },
+          { name: 'pauseOnBadAnchorUpdate', internalType: 'bool', type: 'bool' },
+          { name: 'maxPriceAge', internalType: 'uint16', type: 'uint16' },
+          { name: 'minUpdateIntervalMinutes', internalType: 'uint16', type: 'uint16' },
+          { name: 'maxPriceToleranceRatio', internalType: 'uint16', type: 'uint16' },
+          { name: 'minPriceToleranceRatio', internalType: 'uint16', type: 'uint16' },
+          { name: 'maxUpdateDelayDays', internalType: 'uint8', type: 'uint8' },
+          { name: 'accrualLag', internalType: 'uint32', type: 'uint32' },
+          { name: 'anchorTimestamp', internalType: 'uint32', type: 'uint32' },
+          { name: 'driftTimestamp', internalType: 'uint32', type: 'uint32' },
+          { name: 'anchorPrice', internalType: 'uint128', type: 'uint128' },
+          { name: 'driftPrice', internalType: 'uint128', type: 'uint128' },
+          { name: 'highestPrice', internalType: 'uint128', type: 'uint128' },
+          { name: 'lastTotalSupply', internalType: 'uint128', type: 'uint128' },
+        ],
+      },
+      {
+        name: '',
+        internalType: 'struct VaultAccruals',
+        type: 'tuple',
+        components: [
+          {
+            name: 'fees',
+            internalType: 'struct Fee',
+            type: 'tuple',
+            components: [
+              { name: 'tvl', internalType: 'uint16', type: 'uint16' },
+              { name: 'performance', internalType: 'uint16', type: 'uint16' },
+            ],
+          },
+          { name: 'accruedFees', internalType: 'uint112', type: 'uint112' },
+          { name: 'accruedProtocolFees', internalType: 'uint112', type: 'uint112' },
+        ],
+      },
+    ],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    inputs: [{ name: 'vault', internalType: 'address', type: 'address' }],
+    name: 'isVaultPaused',
+    outputs: [{ name: '', internalType: 'bool', type: 'bool' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    inputs: [],
+    name: 'version',
+    outputs: [{ name: '', internalType: 'string', type: 'string' }],
+    stateMutability: 'pure',
+  },
+] as const;

package/src/evm/abis/provisionerV2.ts

@@ -0,0 +1,202 @@
+// Compact ABI derived from aera-finance/aera-contracts-v3@f4e3433058c29c3a0b1348ffbd358cc036a1687f
+// source: src/core/interfaces/IProvisionerV2.sol
+export const provisionerV2Abi = [
+  {
+    type: 'function',
+    inputs: [
+      { name: 'token', internalType: 'contract IERC20', type: 'address' },
+      { name: 'tokensIn', internalType: 'uint256', type: 'uint256' },
+      { name: 'minUnitsOut', internalType: 'uint256', type: 'uint256' },
+      { name: 'receiver', internalType: 'address', type: 'address' },
+    ],
+    name: 'deposit',
+    outputs: [{ name: 'unitsOut', internalType: 'uint256', type: 'uint256' }],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    inputs: [
+      { name: 'receiver', internalType: 'address', type: 'address' },
+      { name: 'depositor', internalType: 'address', type: 'address' },
+    ],
+    name: 'depositReceiverApprovals',
+    outputs: [{ name: 'approved', internalType: 'bool', type: 'bool' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    inputs: [
+      { name: 'token', internalType: 'contract IERC20', type: 'address' },
+      { name: 'tokensIn', internalType: 'uint256', type: 'uint256' },
+      { name: 'minUnitsOut', internalType: 'uint256', type: 'uint256' },
+      { name: 'solverTip', internalType: 'uint256', type: 'uint256' },
+      { name: 'deadline', internalType: 'uint256', type: 'uint256' },
+      { name: 'maxPriceAge', internalType: 'uint256', type: 'uint256' },
+      { name: 'isFixedPrice', internalType: 'bool', type: 'bool' },
+      { name: 'receiver', internalType: 'address', type: 'address' },
+    ],
+    name: 'requestDeposit',
+    outputs: [{ name: 'depositRequestHash', internalType: 'bytes32', type: 'bytes32' }],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    inputs: [],
+    name: 'getSyncRedeemDetails',
+    outputs: [
+      { name: 'maxPriceAge', internalType: 'uint24', type: 'uint24' },
+      { name: 'relativeCapBps', internalType: 'uint16', type: 'uint16' },
+      { name: 'maxDynamicPremiumBps', internalType: 'uint16', type: 'uint16' },
+      { name: 'epochTimestamp', internalType: 'uint32', type: 'uint32' },
+      { name: 'absoluteCapNumeraire', internalType: 'uint80', type: 'uint80' },
+      { name: 'epochRedeemedNumeraire', internalType: 'uint80', type: 'uint80' },
+    ],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    inputs: [
+      { name: 'depositor', internalType: 'address', type: 'address' },
+      { name: 'approved', internalType: 'bool', type: 'bool' },
+    ],
+    name: 'setDepositReceiverApproval',
+    outputs: [],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    inputs: [{ name: 'token', internalType: 'contract IERC20', type: 'address' }],
+    name: 'tokensDetails',
+    outputs: [
+      { name: 'asyncDepositEnabled', internalType: 'bool', type: 'bool' },
+      { name: 'asyncRedeemEnabled', internalType: 'bool', type: 'bool' },
+      { name: 'syncDepositEnabled', internalType: 'bool', type: 'bool' },
+      { name: 'syncRedeemEnabled', internalType: 'bool', type: 'bool' },
+      { name: 'asyncDepositMultiplier', internalType: 'uint16', type: 'uint16' },
+      { name: 'asyncRedeemMultiplier', internalType: 'uint16', type: 'uint16' },
+      { name: 'syncDepositMultiplier', internalType: 'uint16', type: 'uint16' },
+      { name: 'syncRedeemMultiplier', internalType: 'uint16', type: 'uint16' },
+      {
+        name: 'pushFundsSubmitDataPointer',
+        internalType: 'address',
+        type: 'address',
+      },
+      {
+        name: 'pullFundsSubmitDataPointer',
+        internalType: 'address',
+        type: 'address',
+      },
+    ],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    inputs: [
+      { name: 'token', internalType: 'contract IERC20', type: 'address' },
+      { name: 'unitsIn', internalType: 'uint256', type: 'uint256' },
+      { name: 'minTokensOut', internalType: 'uint256', type: 'uint256' },
+      { name: 'solverTip', internalType: 'uint256', type: 'uint256' },
+      { name: 'deadline', internalType: 'uint256', type: 'uint256' },
+      { name: 'maxPriceAge', internalType: 'uint256', type: 'uint256' },
+      { name: 'isFixedPrice', internalType: 'bool', type: 'bool' },
+      { name: 'receiver', internalType: 'address', type: 'address' },
+    ],
+    name: 'requestRedeem',
+    outputs: [{ name: 'redeemRequestHash', internalType: 'bytes32', type: 'bytes32' }],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    inputs: [
+      { name: 'token', internalType: 'contract IERC20', type: 'address' },
+      { name: 'unitsIn', internalType: 'uint256', type: 'uint256' },
+      { name: 'minTokensOut', internalType: 'uint256', type: 'uint256' },
+      { name: 'receiver', internalType: 'address', type: 'address' },
+    ],
+    name: 'redeem',
+    outputs: [{ name: 'tokensOut', internalType: 'uint256', type: 'uint256' }],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    inputs: [
+      { name: 'token', internalType: 'contract IERC20', type: 'address' },
+      { name: 'tokensOut', internalType: 'uint256', type: 'uint256' },
+      { name: 'maxUnitsIn', internalType: 'uint256', type: 'uint256' },
+      { name: 'receiver', internalType: 'address', type: 'address' },
+    ],
+    name: 'withdraw',
+    outputs: [{ name: 'unitsIn', internalType: 'uint256', type: 'uint256' }],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    inputs: [{ name: 'asyncRequestHash', internalType: 'bytes32', type: 'bytes32' }],
+    name: 'asyncRequestHashes',
+    outputs: [{ name: 'exists', internalType: 'bool', type: 'bool' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    inputs: [],
+    name: 'version',
+    outputs: [{ name: '', internalType: 'string', type: 'string' }],
+    stateMutability: 'pure',
+  },
+  {
+    type: 'event',
+    inputs: [
+      { name: 'user', internalType: 'address', type: 'address', indexed: true },
+      { name: 'receiver', internalType: 'address', type: 'address', indexed: true },
+      { name: 'token', internalType: 'contract IERC20', type: 'address', indexed: true },
+      { name: 'tokensIn', internalType: 'uint256', type: 'uint256', indexed: false },
+      { name: 'minUnitsOut', internalType: 'uint256', type: 'uint256', indexed: false },
+      { name: 'solverTip', internalType: 'uint256', type: 'uint256', indexed: false },
+      { name: 'deadline', internalType: 'uint256', type: 'uint256', indexed: false },
+      { name: 'maxPriceAge', internalType: 'uint256', type: 'uint256', indexed: false },
+      { name: 'isFixedPrice', internalType: 'bool', type: 'bool', indexed: false },
+      { name: 'depositRequestHash', internalType: 'bytes32', type: 'bytes32', indexed: false },
+    ],
+    name: 'DepositRequested',
+    anonymous: false,
+  },
+  {
+    type: 'event',
+    inputs: [
+      { name: 'receiver', internalType: 'address', type: 'address', indexed: true },
+      { name: 'depositor', internalType: 'address', type: 'address', indexed: true },
+      { name: 'approved', internalType: 'bool', type: 'bool', indexed: false },
+    ],
+    name: 'DepositReceiverApprovalSet',
+    anonymous: false,
+  },
+  {
+    type: 'event',
+    inputs: [
+      { name: 'user', internalType: 'address', type: 'address', indexed: true },
+      { name: 'receiver', internalType: 'address', type: 'address', indexed: true },
+      { name: 'token', internalType: 'contract IERC20', type: 'address', indexed: true },
+      { name: 'minTokensOut', internalType: 'uint256', type: 'uint256', indexed: false },
+      { name: 'unitsIn', internalType: 'uint256', type: 'uint256', indexed: false },
+      { name: 'solverTip', internalType: 'uint256', type: 'uint256', indexed: false },
+      { name: 'deadline', internalType: 'uint256', type: 'uint256', indexed: false },
+      { name: 'maxPriceAge', internalType: 'uint256', type: 'uint256', indexed: false },
+      { name: 'isFixedPrice', internalType: 'bool', type: 'bool', indexed: false },
+      { name: 'redeemRequestHash', internalType: 'bytes32', type: 'bytes32', indexed: false },
+    ],
+    name: 'RedeemRequested',
+    anonymous: false,
+  },
+  {
+    type: 'event',
+    inputs: [
+      { name: 'user', internalType: 'address', type: 'address', indexed: true },
+      { name: 'receiver', internalType: 'address', type: 'address', indexed: true },
+      { name: 'token', internalType: 'contract IERC20', type: 'address', indexed: true },
+      { name: 'unitsIn', internalType: 'uint256', type: 'uint256', indexed: false },
+      { name: 'tokensOut', internalType: 'uint256', type: 'uint256', indexed: false },
+    ],
+    name: 'Redeemed',
+    anonymous: false,
+  },
+] as const;