@pafi-dev/core 0.5.8 → 0.5.9

package/dist/index.d.ts

@@ -341,6 +341,122 @@ interface BuildPerpDepositWithGasDeductionParams {
  */
 declare function buildPerpDepositWithGasDeduction(params: BuildPerpDepositWithGasDeductionParams): PartialUserOperation;
 
+/**
+ * Minimal ABI for the Orderly perp-deposit Relay (deployed at
+ * `CONTRACT_ADDRESSES[chainId].orderlyRelay`).
+ *
+ * The Relay holds an ETH reserve and pays Orderly's LayerZero msg.value
+ * out of it. Users only need USDC + the Relay-charged USDC fee — they
+ * never hold ETH for msg.value, which unblocks the ERC-4337 sponsored
+ * gas path for perp deposits (paymaster covers gas, NOT msg.value).
+ */
+declare const ORDERLY_RELAY_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "deposit";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "req";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+        }, {
+            readonly name: "receiver";
+            readonly type: "address";
+        }, {
+            readonly name: "brokerHash";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "totalAmount";
+            readonly type: "uint128";
+        }, {
+            readonly name: "maxFee";
+            readonly type: "uint128";
+        }];
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "function";
+    readonly name: "quoteTokenFee";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "req";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+        }, {
+            readonly name: "receiver";
+            readonly type: "address";
+        }, {
+            readonly name: "brokerHash";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "totalAmount";
+            readonly type: "uint128";
+        }, {
+            readonly name: "maxFee";
+            readonly type: "uint128";
+        }];
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint128";
+    }];
+}];
+/**
+ * `Relay.DepositRequest` — the struct passed to `deposit()` and
+ * `quoteTokenFee()`. The Relay pulls `totalAmount` of `token` from
+ * `msg.sender`, computes a token-denominated fee (capped at `maxFee`)
+ * to cover the LayerZero msg.value out of its ETH reserve, and forwards
+ * `(totalAmount - tokenFee)` to Orderly Vault on behalf of `receiver`.
+ */
+interface OrderlyRelayDepositRequest {
+    /** ERC-20 to deposit (must be registered + enabled on the Relay). */
+    token: Address;
+    /** Orderly account owner — typically the user's EOA. */
+    receiver: Address;
+    /** Orderly broker hash (e.g. `BROKER_HASHES.woofi_pro`). */
+    brokerHash: Hex;
+    /** Total amount the user is sending to the Relay (raw token units, uint128). */
+    totalAmount: bigint;
+    /** Max acceptable token fee — slippage cap on the Relay's USD-pricing. */
+    maxFee: bigint;
+}
+interface BuildPerpDepositViaRelayParams {
+    /** User EOA (msg.sender via EIP-7702 delegation). */
+    userAddress: Address;
+    /** ERC-4337 account nonce. */
+    aaNonce: bigint;
+    /** Relay contract address — `getContractAddresses(chainId).orderlyRelay`. */
+    relayAddress: Address;
+    /** Deposit request (token, receiver, brokerHash, totalAmount, maxFee). */
+    request: OrderlyRelayDepositRequest;
+    /**
+     * Optional PT gas-fee transfer prepended to the batch. Set both
+     * `gasFeePtRecipient` and `gasFeePt` together for sponsored flows
+     * (PAFI gas reimbursement). Pass `0n` / `undefined` for the fallback
+     * path where the user pays ERC-4337 gas in ETH directly.
+     */
+    pointTokenAddress?: Address;
+    gasFeePt?: bigint;
+    gasFeePtRecipient?: Address;
+    gasLimits?: {
+        callGasLimit?: bigint;
+        verificationGasLimit?: bigint;
+        preVerificationGas?: bigint;
+    };
+}
+/**
+ * Build a UserOp for Orderly perp deposit via the PAFI Relay.
+ *
+ * Sponsored ops: `[PT.transfer(feeRecipient, gasFeePt), USDC.approve(relay, total), Relay.deposit(req)]`
+ * Fallback ops:  `[                                     USDC.approve(relay, total), Relay.deposit(req)]`
+ *
+ * No `msg.value` — the Relay covers LayerZero out of its own ETH reserve.
+ */
+declare function buildPerpDepositViaRelay(params: BuildPerpDepositViaRelayParams): PartialUserOperation;
+
 /**
  * Build an ERC-20 `transfer(to, amount)` operation. Used inside a batch
  * to move fee tokens from the user to the fee recipient atomically with
@@ -912,6 +1028,13 @@ interface ContractAddresses {
     pafiHook: Address;
     /** Chainlink ETH/USD price feed — used by FeeManager to convert gas cost to USDT. */
     chainlinkEthUsd: Address;
+    /**
+     * Orderly perp-deposit Relay — holds an ETH reserve to cover the
+     * LayerZero msg.value, charges a USDC token-fee reimbursement.
+     * Lets perp deposits ride the ERC-4337 sponsored gas path without
+     * the user holding ETH for msg.value.
+     */
+    orderlyRelay: Address;
 }
 declare const CONTRACT_ADDRESSES: Record<number, ContractAddresses>;
 /**
@@ -1307,4 +1430,4 @@ declare class PafiSDK {
     signLoginMessage(message: string): Promise<Hex>;
 }
 
-export { ApiError, BATCH_EXECUTOR_ABI, BATCH_EXECUTOR_ADDRESS_BASE_MAINNET, BATCH_EXECUTOR_ADDRESS_BASE_SEPOLIA, BROKER_HASHES, BestQuote, type BuildDelegationUserOpParams, type BuildPartialUserOpParams, type BuildPerpDepositWithGasDeductionParams, COMMON_POOLS, COMMON_TOKENS, CONTRACT_ADDRESSES, ChainConfig, type CheckEthAndBranchParams, ConfigurationError, type ContractAddresses, EIP712Signature, ENTRY_POINT_V07, LoginMessageParams, MintRequest, type ModalOpenOptions, ORDERLY_VAULT_ABI, ORDERLY_VAULT_ADDRESSES, ORDERLY_VAULT_BASE_MAINNET, Operation, PAFI_SUBGRAPH_URL, PERMIT2_ADDRESS, POINT_TOKEN_FACTORY_ADDRESSES, POINT_TOKEN_IMPL_ADDRESSES, POINT_TOKEN_POOLS, type PafiProxyTransportParams, PafiSDK, PafiSDKConfig, PafiSDKError, type PafiWebModalAdapter, type PafiWebModalHandle, PartialUserOperation, type PaymasterConfig, PointTokenDomainConfig, PoolKey, QuoteResult, ReceiverConsent, SUPPORTED_CHAINS, type SendWithPaymasterFallbackParams, type SignatureStruct, SignatureVerification, SigningError, SimulationError, type SmartAccountSender, type SponsorshipScenario, type SubmissionPath, SwapSimulationResult, TOKEN_HASHES, UNIVERSAL_ROUTER_ADDRESSES, UserOperation, V4_QUOTER_ADDRESSES, type VaultDepositFE, _resetPaymasterConfigForTests, assembleUserOperation, buildDelegationUserOp, buildPartialUserOperation, buildPerpDepositWithGasDeduction, burnRequestTypes, checkDelegation, checkEthAndBranch, computeAccountId, computeAuthorizationHash, computeUserOpHash, createPafiProxyTransport, decodeBatchExecuteCalls, encodeBatchExecute, erc20ApproveOp, erc20BurnOp, erc20TransferOp, fetchPafiPools, getAaNonce, getContractAddresses, getPafiWebModalAdapter, getPaymasterConfig, isDelegatedTo, isDelegatedToTarget, isPaymasterConfigured, isPaymasterError, mintRequestTypes, openPafiWebModal, openWebPopup, parseEip7702DelegatedAddress, rawCallOp, receiverConsentTypes, sendWithPaymasterFallback, serializeUserOpToJsonRpc, setPafiWebModalAdapter, setPaymasterConfig, webPopupAdapter };
+export { ApiError, BATCH_EXECUTOR_ABI, BATCH_EXECUTOR_ADDRESS_BASE_MAINNET, BATCH_EXECUTOR_ADDRESS_BASE_SEPOLIA, BROKER_HASHES, BestQuote, type BuildDelegationUserOpParams, type BuildPartialUserOpParams, type BuildPerpDepositViaRelayParams, type BuildPerpDepositWithGasDeductionParams, COMMON_POOLS, COMMON_TOKENS, CONTRACT_ADDRESSES, ChainConfig, type CheckEthAndBranchParams, ConfigurationError, type ContractAddresses, EIP712Signature, ENTRY_POINT_V07, LoginMessageParams, MintRequest, type ModalOpenOptions, ORDERLY_RELAY_ABI, ORDERLY_VAULT_ABI, ORDERLY_VAULT_ADDRESSES, ORDERLY_VAULT_BASE_MAINNET, Operation, type OrderlyRelayDepositRequest, PAFI_SUBGRAPH_URL, PERMIT2_ADDRESS, POINT_TOKEN_FACTORY_ADDRESSES, POINT_TOKEN_IMPL_ADDRESSES, POINT_TOKEN_POOLS, type PafiProxyTransportParams, PafiSDK, PafiSDKConfig, PafiSDKError, type PafiWebModalAdapter, type PafiWebModalHandle, PartialUserOperation, type PaymasterConfig, PointTokenDomainConfig, PoolKey, QuoteResult, ReceiverConsent, SUPPORTED_CHAINS, type SendWithPaymasterFallbackParams, type SignatureStruct, SignatureVerification, SigningError, SimulationError, type SmartAccountSender, type SponsorshipScenario, type SubmissionPath, SwapSimulationResult, TOKEN_HASHES, UNIVERSAL_ROUTER_ADDRESSES, UserOperation, V4_QUOTER_ADDRESSES, type VaultDepositFE, _resetPaymasterConfigForTests, assembleUserOperation, buildDelegationUserOp, buildPartialUserOperation, buildPerpDepositViaRelay, buildPerpDepositWithGasDeduction, burnRequestTypes, checkDelegation, checkEthAndBranch, computeAccountId, computeAuthorizationHash, computeUserOpHash, createPafiProxyTransport, decodeBatchExecuteCalls, encodeBatchExecute, erc20ApproveOp, erc20BurnOp, erc20TransferOp, fetchPafiPools, getAaNonce, getContractAddresses, getPafiWebModalAdapter, getPaymasterConfig, isDelegatedTo, isDelegatedToTarget, isPaymasterConfigured, isPaymasterError, mintRequestTypes, openPafiWebModal, openWebPopup, parseEip7702DelegatedAddress, rawCallOp, receiverConsentTypes, sendWithPaymasterFallback, serializeUserOpToJsonRpc, setPafiWebModalAdapter, setPaymasterConfig, webPopupAdapter };

package/dist/index.js

@@ -244,6 +244,113 @@ function buildPerpDepositWithGasDeduction(params) {
   });
 }
 
+// src/perp/buildPerpDepositViaRelay.ts
+import { encodeFunctionData as encodeFunctionData2, erc20Abi as erc20Abi2 } from "viem";
+var ORDERLY_RELAY_ABI = [
+  {
+    type: "function",
+    name: "deposit",
+    stateMutability: "nonpayable",
+    inputs: [
+      {
+        name: "req",
+        type: "tuple",
+        components: [
+          { name: "token", type: "address" },
+          { name: "receiver", type: "address" },
+          { name: "brokerHash", type: "bytes32" },
+          { name: "totalAmount", type: "uint128" },
+          { name: "maxFee", type: "uint128" }
+        ]
+      }
+    ],
+    outputs: []
+  },
+  {
+    type: "function",
+    name: "quoteTokenFee",
+    stateMutability: "view",
+    inputs: [
+      {
+        name: "req",
+        type: "tuple",
+        components: [
+          { name: "token", type: "address" },
+          { name: "receiver", type: "address" },
+          { name: "brokerHash", type: "bytes32" },
+          { name: "totalAmount", type: "uint128" },
+          { name: "maxFee", type: "uint128" }
+        ]
+      }
+    ],
+    outputs: [{ name: "", type: "uint128" }]
+  }
+];
+function buildPerpDepositViaRelay(params) {
+  if (params.request.totalAmount <= 0n) {
+    throw new Error("buildPerpDepositViaRelay: totalAmount must be positive");
+  }
+  if (params.request.maxFee < 0n) {
+    throw new Error("buildPerpDepositViaRelay: maxFee cannot be negative");
+  }
+  if (!params.relayAddress) {
+    throw new Error("buildPerpDepositViaRelay: relayAddress required");
+  }
+  const operations = [];
+  if (params.gasFeePt && params.gasFeePt > 0n) {
+    if (!params.pointTokenAddress) {
+      throw new Error(
+        "buildPerpDepositViaRelay: pointTokenAddress required when gasFeePt > 0"
+      );
+    }
+    if (!params.gasFeePtRecipient) {
+      throw new Error(
+        "buildPerpDepositViaRelay: gasFeePtRecipient required when gasFeePt > 0"
+      );
+    }
+    operations.push({
+      target: params.pointTokenAddress,
+      value: 0n,
+      data: encodeFunctionData2({
+        abi: erc20Abi2,
+        functionName: "transfer",
+        args: [params.gasFeePtRecipient, params.gasFeePt]
+      })
+    });
+  }
+  operations.push(
+    erc20ApproveOp(
+      params.request.token,
+      params.relayAddress,
+      params.request.totalAmount
+    )
+  );
+  const depositCallData = encodeFunctionData2({
+    abi: ORDERLY_RELAY_ABI,
+    functionName: "deposit",
+    args: [
+      {
+        token: params.request.token,
+        receiver: params.request.receiver,
+        brokerHash: params.request.brokerHash,
+        totalAmount: params.request.totalAmount,
+        maxFee: params.request.maxFee
+      }
+    ]
+  });
+  operations.push(rawCallOp(params.relayAddress, depositCallData));
+  return buildPartialUserOperation({
+    sender: params.userAddress,
+    nonce: params.aaNonce,
+    operations,
+    gasLimits: {
+      callGasLimit: params.gasLimits?.callGasLimit ?? 800000n,
+      verificationGasLimit: params.gasLimits?.verificationGasLimit ?? 150000n,
+      preVerificationGas: params.gasLimits?.preVerificationGas ?? 50000n
+    }
+  });
+}
+
 // src/userop/types.ts
 var ZERO_VALUE = 0n;
 
@@ -520,7 +627,8 @@ var CONTRACT_ADDRESSES = {
     issuerRegistry: "0xda2D3338CF70F462Ac175F5f2edfa45660CA4f31",
     mintingOracle: "0xD85165939C700E51c8a45099316C6482634C2Ab9",
     pafiHook: "0x870cAF9882d3160602AaC1769C2B264A2d8EC044",
-    chainlinkEthUsd: "0x71041dddad3595F9CEd3DcCFBe3D1F4b0a16Bb70"
+    chainlinkEthUsd: "0x71041dddad3595F9CEd3DcCFBe3D1F4b0a16Bb70",
+    orderlyRelay: "0xDA082DAce1522c185aeB5A713FcA6fa6B6E99e7f"
   },
   // Base Sepolia — not in active use; placeholders kept so the map
   // compiles for tooling that enumerates chains.
@@ -531,7 +639,8 @@ var CONTRACT_ADDRESSES = {
     issuerRegistry: PLACEHOLDER_DEAD("dead"),
     mintingOracle: PLACEHOLDER_DEAD("dead"),
     pafiHook: PLACEHOLDER_DEAD("dead"),
-    chainlinkEthUsd: PLACEHOLDER_DEAD("de02")
+    chainlinkEthUsd: PLACEHOLDER_DEAD("de02"),
+    orderlyRelay: PLACEHOLDER_DEAD("de03")
   }
 };
 var POINT_TOKEN_FACTORY_ADDRESSES = {
@@ -974,6 +1083,7 @@ export {
   CONTRACT_ADDRESSES,
   ConfigurationError,
   ENTRY_POINT_V07,
+  ORDERLY_RELAY_ABI,
   ORDERLY_VAULT_ABI,
   ORDERLY_VAULT_ADDRESSES,
   ORDERLY_VAULT_BASE_MAINNET,
@@ -1008,6 +1118,7 @@ export {
   buildMintRequestTypedData,
   buildPartialUserOperation,
   buildPermit2ApprovalCalldata,
+  buildPerpDepositViaRelay,
   buildPerpDepositWithGasDeduction,
   buildReceiverConsentTypedData,
   buildSponsorAuthDomain,