@seal-protocol/backendjs 0.0.130 → 0.0.132

package/lib/utils/calculate-required-permit.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApprovalType = void 0;
+exports.calculateRequiredPermitForOrder = calculateRequiredPermitForOrder;
+const ethers_1 = require("ethers");
+const calculate_liquidity_1 = require("./calculate-liquidity");
+const abi_types_1 = require("../abi-types");
+const maxUint32 = BigInt(Math.pow(2, 32) - 1);
+var ApprovalType;
+(function (ApprovalType) {
+    ApprovalType[ApprovalType["Eip2612"] = 1] = "Eip2612";
+    ApprovalType[ApprovalType["Permit2"] = 2] = "Permit2";
+    ApprovalType[ApprovalType["Erc20"] = 3] = "Erc20";
+})(ApprovalType || (exports.ApprovalType = ApprovalType = {}));
+async function calculateRequiredPermitForOrder(params) {
+    let { provider, client, inputToken, owner, amountIn, sealContract, expirationTimeSeconds, } = params;
+    const chainId = inputToken.chainId;
+    if (sealContract == null) {
+        const contracts = (await client.getSealContracts({
+            chainId
+        })).data.contracts;
+        if (contracts.length < 1) {
+            throw new Error("no contract support for the given chain");
+        }
+        sealContract = contracts[0];
+    }
+    const stats = (await client.getOrderStatsForOwner({
+        chainId, owner, tokenIn: inputToken.address,
+    })).data;
+    const ordersCount = BigInt(stats.count);
+    const ordersRemaining = BigInt(stats.remaining);
+    const requiredAllowance = ordersRemaining + amountIn;
+    const approvals = (await client.getTokenPermitApprovals({
+        owner, spender: sealContract.address, chainId,
+    })).data.approvals;
+    if (approvals.length > 0 && Number(approvals[0].sigDeadline.seconds) >= expirationTimeSeconds && (approvals[0].allowanceExpiration == null || Number(approvals[0].allowanceExpiration.seconds) >= expirationTimeSeconds)) {
+        const allowance = BigInt(approvals[0].allowance);
+        if (allowance >= requiredAllowance) {
+            return {
+                ordersCount,
+                ordersRemaining,
+            };
+        }
+    }
+    let permit2 = (await client.getPermit2Contracts()).data.contracts.find(c => c.chainId == chainId);
+    const erc20Contract = abi_types_1.Erc20__factory.connect(inputToken.address, provider);
+    let { onChainAllowanceToPermit2Contract, permit2Nonce, isRequiredAmountCovered } = await (0, calculate_liquidity_1.fetchOnChainAllowance)({
+        provider, erc20Contract, owner, spender: sealContract.address,
+        permit2ContractAddress: permit2?.address, token: inputToken.address,
+        requiredAmount: requiredAllowance, deadlineUnixSeconds: expirationTimeSeconds,
+    });
+    if (isRequiredAmountCovered) {
+        return {
+            ordersCount,
+            ordersRemaining,
+        };
+    }
+    if (inputToken.isErc2612 === true) {
+        const permitContract = abi_types_1.Erc20Permit__factory.connect(inputToken.address, provider);
+        const nonce = await permitContract.nonces(owner);
+        return {
+            ordersCount,
+            ordersRemaining,
+            permit: {
+                nonce,
+                allowance: ethers_1.MaxUint256,
+                approvalType: ApprovalType.Eip2612,
+                spender: sealContract.address,
+                domainInfo: {
+                    name: inputToken.contractName,
+                    version: inputToken.contractVersion,
+                    verifyingContract: inputToken.address,
+                    chainId,
+                },
+                sigDeadline: maxUint32,
+            }
+        };
+    }
+    // TODO isn't it better to ask the user to submit a permit2 allowance for onChainAllowanceToPermit2Contract,
+    //  so he will be able to use permit2 from now on?
+    if (onChainAllowanceToPermit2Contract != null && onChainAllowanceToPermit2Contract >= requiredAllowance) {
+        return {
+            ordersCount,
+            ordersRemaining,
+            permit: {
+                nonce: permit2Nonce,
+                allowance: ethers_1.MaxUint256,
+                approvalType: ApprovalType.Permit2,
+                spender: sealContract.address,
+                domainInfo: {
+                    name: permit2.domainSeparatorName,
+                    version: permit2.domainSeparatorVersion,
+                    verifyingContract: permit2.address,
+                    chainId,
+                },
+                sigDeadline: maxUint32,
+                expiration: maxUint32,
+            },
+            permit2Contract: permit2,
+        };
+    }
+    return {
+        ordersCount,
+        ordersRemaining,
+        permit: {
+            allowance: requiredAllowance,
+            approvalType: ApprovalType.Erc20,
+            spender: sealContract.address,
+        }
+    };
+}

package/lib/utils/index.d.ts

@@ -1,2 +1,4 @@
-export { LiquidityBreakdown, TransferPermission, calculateLiquidity } from "./calculate-liquidity";
+export { LiquidityBreakdown, TransferPermission } from "./calculate-liquidity";
+export { default as calculateLiquidity } from "./calculate-liquidity";
 export { truncateFixedNumberToBigInt } from "./numbers";
+export * from "./calculate-required-permit";

package/lib/utils/index.js

@@ -1,8 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.truncateFixedNumberToBigInt = exports.calculateLiquidity = exports.LiquidityBreakdown = void 0;
 var calculate_liquidity_1 = require("./calculate-liquidity");
 Object.defineProperty(exports, "LiquidityBreakdown", { enumerable: true, get: function () { return calculate_liquidity_1.LiquidityBreakdown; } });
-Object.defineProperty(exports, "calculateLiquidity", { enumerable: true, get: function () { return calculate_liquidity_1.calculateLiquidity; } });
+var calculate_liquidity_2 = require("./calculate-liquidity");
+Object.defineProperty(exports, "calculateLiquidity", { enumerable: true, get: function () { return __importDefault(calculate_liquidity_2).default; } });
 var numbers_1 = require("./numbers");
 Object.defineProperty(exports, "truncateFixedNumberToBigInt", { enumerable: true, get: function () { return numbers_1.truncateFixedNumberToBigInt; } });
+__exportStar(require("./calculate-required-permit"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seal-protocol/backendjs",
-  "version": "0.0.130",
+  "version": "0.0.132",
   "description": "Javascript SDK for Seal Backend",
   "author": "amin <amin@refractedlabs.com>",
   "homepage": "https://github.com/seal-protocol/backend/tree/main/ts-client#readme",

package/lib/codegen/model/seal-approval-type.js

@@ -1,28 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * seal/seal.proto
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: version not set
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SealApprovalType = void 0;
-/**
- *
- * @export
- * @enum {string}
- */
-var SealApprovalType;
-(function (SealApprovalType) {
-    SealApprovalType["ApprovalTypeUnspecified"] = "ApprovalType_UNSPECIFIED";
-    SealApprovalType["ApprovalTypeEip2612"] = "ApprovalType_EIP2612";
-    SealApprovalType["ApprovalTypePermit2"] = "ApprovalType_PERMIT2";
-    SealApprovalType["ApprovalTypeErc20"] = "ApprovalType_ERC20";
-})(SealApprovalType || (exports.SealApprovalType = SealApprovalType = {}));

package/lib/codegen/model/seal-calculate-required-permit-response.d.ts

@@ -1,74 +0,0 @@
-/**
- * seal/seal.proto
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: version not set
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { SealApprovalType } from './seal-approval-type';
-import type { SealDomainInfo } from './seal-domain-info';
-/**
- *
- * @export
- * @interface SealCalculateRequiredPermitResponse
- */
-export interface SealCalculateRequiredPermitResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof SealCalculateRequiredPermitResponse
-     */
-    'ordersCount'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCalculateRequiredPermitResponse
-     */
-    'ordersRemaining'?: string;
-    /**
-     *
-     * @type {SealApprovalType}
-     * @memberof SealCalculateRequiredPermitResponse
-     */
-    'approvalType'?: SealApprovalType;
-    /**
-     *
-     * @type {SealDomainInfo}
-     * @memberof SealCalculateRequiredPermitResponse
-     */
-    'domainInfo'?: SealDomainInfo;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCalculateRequiredPermitResponse
-     */
-    'spender'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCalculateRequiredPermitResponse
-     */
-    'allowance'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCalculateRequiredPermitResponse
-     */
-    'nonce'?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof SealCalculateRequiredPermitResponse
-     */
-    'sigDeadline'?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof SealCalculateRequiredPermitResponse
-     */
-    'allowanceExpiration'?: number;
-}

package/lib/codegen/model/seal-orders-order-by-property.js

@@ -1,37 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * seal/seal.proto
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: version not set
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SealOrdersOrderByProperty = void 0;
-/**
- *
- * @export
- * @enum {string}
- */
-var SealOrdersOrderByProperty;
-(function (SealOrdersOrderByProperty) {
-    SealOrdersOrderByProperty["OrdersOrderByPropertyUnspecified"] = "OrdersOrderByProperty_UNSPECIFIED";
-    SealOrdersOrderByProperty["OrdersOrderByPropertyId"] = "OrdersOrderByProperty_ID";
-    SealOrdersOrderByProperty["OrdersOrderByPropertyOwner"] = "OrdersOrderByProperty_OWNER";
-    SealOrdersOrderByProperty["OrdersOrderByPropertyTokenIn"] = "OrdersOrderByProperty_TOKEN_IN";
-    SealOrdersOrderByProperty["OrdersOrderByPropertyTokenOut"] = "OrdersOrderByProperty_TOKEN_OUT";
-    SealOrdersOrderByProperty["OrdersOrderByPropertyAmountIn"] = "OrdersOrderByProperty_AMOUNT_IN";
-    SealOrdersOrderByProperty["OrdersOrderByPropertyPrice"] = "OrdersOrderByProperty_PRICE";
-    SealOrdersOrderByProperty["OrdersOrderByPropertyDeadline"] = "OrdersOrderByProperty_DEADLINE";
-    SealOrdersOrderByProperty["OrdersOrderByPropertyReservationDepositToken"] = "OrdersOrderByProperty_RESERVATION_DEPOSIT_TOKEN";
-    SealOrdersOrderByProperty["OrdersOrderByPropertyMinReservationDepositAmount"] = "OrdersOrderByProperty_MIN_RESERVATION_DEPOSIT_AMOUNT";
-    SealOrdersOrderByProperty["OrdersOrderByPropertyRemainingAmount"] = "OrdersOrderByProperty_REMAINING_AMOUNT";
-    SealOrdersOrderByProperty["OrdersOrderByPropertyReservedAmount"] = "OrdersOrderByProperty_RESERVED_AMOUNT";
-    SealOrdersOrderByProperty["OrdersOrderByPropertyFilledAmount"] = "OrdersOrderByProperty_FILLED_AMOUNT";
-})(SealOrdersOrderByProperty || (exports.SealOrdersOrderByProperty = SealOrdersOrderByProperty = {}));