@seal-protocol/backendjs 0.0.76 → 0.0.78

package/lib/utils/calculate-liquidity.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LiquidityBreakdown = void 0;
+exports.calculateLiquidity = calculateLiquidity;
+const abi_types_1 = require("../abi-types");
+const codegen_1 = require("../codegen");
+class LiquidityBreakdown {
+    spendable;
+    balance;
+    onChainAllowance;
+    onChainPermit2;
+    offChainPermission;
+    constructor(spendable, balance, onChainAllowance, onChainPermit2, offChainPermission) {
+        this.spendable = spendable;
+        this.balance = balance;
+        this.onChainAllowance = onChainAllowance;
+        this.onChainPermit2 = onChainPermit2;
+        this.offChainPermission = offChainPermission;
+    }
+    // if spendAmount was not provided, will use this.spendable, which is max spendable amount
+    getTransferPermissionForSpend(spendAmount) {
+        if (!spendAmount) {
+            spendAmount = this.spendable;
+        }
+        else if (spendAmount > this.spendable) {
+            return null;
+        }
+        // If we have enough on-chain allowance (ERC20 approve to spender), we can transfer without off-chain perms
+        if (spendAmount <= this.onChainAllowance) {
+            return { type: codegen_1.TypesTransferPermitType.TransferPermitTypeEip2612, submitPermit: false };
+        }
+        // If we have enough on-chain Permit2 allowance
+        if (spendAmount <= this.onChainPermit2) {
+            return { type: codegen_1.TypesTransferPermitType.TransferPermitTypePermit2, submitPermit: false };
+        }
+        const p = this.offChainPermission;
+        if (p) {
+            if (p.Eip2612PermitAmount && spendAmount <= p.Eip2612PermitAmount) {
+                return { type: codegen_1.TypesTransferPermitType.TransferPermitTypeEip2612, submitPermit: true };
+            }
+            if (p.Permit2 && spendAmount <= p.Permit2) {
+                return { type: codegen_1.TypesTransferPermitType.TransferPermitTypePermit2, submitPermit: true };
+            }
+        }
+        return null; // insufficient permitted balance
+    }
+}
+exports.LiquidityBreakdown = LiquidityBreakdown;
+function nowSeconds() {
+    return BigInt(Math.floor(Date.now() / 1000));
+}
+function isCloseToExpiry(expirySec, minDurationMs) {
+    // Compare seconds with seconds: convert minDurationMs to seconds
+    const minDurSec = BigInt(Math.floor(minDurationMs / 1000));
+    const remaining = expirySec - nowSeconds();
+    return remaining <= minDurSec;
+}
+function maxBigInt(a, b) {
+    return a >= b ? a : b;
+}
+function minBigInt(a, b) {
+    return a <= b ? a : b;
+}
+function effectiveOffchainAmount(p) {
+    if (!p)
+        return 0n;
+    if (p.Eip2612PermitAmount)
+        return p.Eip2612PermitAmount;
+    if (p.Permit2)
+        return p.Permit2;
+    return 0n;
+}
+async function calculateLiquidity(params) {
+    const { provider, owner, token, spender, permit2, minPermissionDurationMs } = params;
+    let backendPermission = params.permission ? { ...params.permission } : null;
+    // Contracts
+    const erc20Contract = abi_types_1.Erc20__factory.connect(token, provider);
+    const permit2Contract = abi_types_1.Permit2__factory.connect(permit2, provider);
+    // 1) On-chain balance
+    const balance = await erc20Contract.balanceOf(owner);
+    // 2) On-chain ERC20 allowance to spender
+    const onChainAllowance = await erc20Contract.allowance(owner, spender);
+    let maxAllowed = onChainAllowance;
+    // 3) ERC20 allowance to Permit2 contract (if zero, Permit2 approvals are not usable)
+    const onChainPermit2AllowanceToContract = await erc20Contract.allowance(owner, permit2);
+    // 4) On-chain Permit2 allowance amount (subject to expiry), only if token->Permit2 allowance > 0
+    let onChainPermit2 = 0n;
+    if (onChainPermit2AllowanceToContract > 0n) {
+        const result = await permit2Contract.allowance(owner, token, spender);
+        // tuple: [amount, expiration, nonce]
+        const amount = result[0];
+        const expiration = result[1];
+        if (expiration === 0n || isCloseToExpiry(expiration, minPermissionDurationMs)) {
+            onChainPermit2 = 0n;
+        }
+        else {
+            onChainPermit2 = amount;
+        }
+    }
+    maxAllowed = maxBigInt(maxAllowed, onChainPermit2);
+    let permission = {};
+    // 5) Validate optional off-chain permission against on-chain state and expiry windows
+    if (backendPermission) {
+        let amt = BigInt(backendPermission.allowance);
+        let sigDeadline = BigInt(backendPermission.sigDeadline?.seconds ?? 0n);
+        if (backendPermission.type == codegen_1.TypesTransferPermitType.TransferPermitTypePermit2) {
+            // Drop Permit2 part if:
+            //  - its amount <= onChainPermit2, OR
+            //  - ERC20 allowance to Permit2 contract is zero, OR
+            //  - close to expiry (either approval expiration or sig deadline)
+            let exp = BigInt(backendPermission.allowanceExpiration?.seconds ?? 0n);
+            const drop = (amt <= onChainPermit2)
+                || (onChainPermit2AllowanceToContract === 0n)
+                || isCloseToExpiry(exp, minPermissionDurationMs)
+                || isCloseToExpiry(sigDeadline, minPermissionDurationMs);
+            if (!drop)
+                permission.Permit2 = amt;
+        }
+        else if (backendPermission.type == codegen_1.TypesTransferPermitType.TransferPermitTypeEip2612) {
+            // Drop EIP2612 part if value <= onChainAllowance OR close to expiry
+            const drop = (amt <= onChainAllowance)
+                || isCloseToExpiry(sigDeadline, minPermissionDurationMs);
+            if (!drop)
+                permission.Eip2612PermitAmount = amt;
+        }
+        if (!permission.Eip2612PermitAmount && !permission.Permit2) {
+            permission = null;
+        }
+        else {
+            maxAllowed = maxBigInt(maxAllowed, effectiveOffchainAmount(permission));
+        }
+    }
+    const spendable = minBigInt(maxAllowed, balance);
+    return new LiquidityBreakdown(spendable, balance, onChainAllowance, onChainPermit2, permission);
+}

package/lib/utils/index.d.ts

@@ -0,0 +1 @@
+export { LiquidityBreakdown, TransferPermission, calculateLiquidity } from "./calculate-liquidity";

package/lib/utils/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seal-protocol/backendjs",
-  "version": "0.0.76",
+  "version": "0.0.78",
   "description": "Javascript SDK for Seal Backend",
   "author": "amin <amin@refractedlabs.com>",
   "homepage": "https://github.com/seal-protocol/backend/tree/main/ts-client#readme",
@@ -22,16 +22,21 @@
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.21.4",
+    "@typechain/ethers-v6": "^0.5.1",
     "@types/node": "^24.2.1",
+    "ethers": "^6.15.0",
     "execa": "^9.6.0",
     "ts-node": "^10.9.2",
+    "typechain": "^8.3.2",
     "typescript": "^5.9.2"
   },
   "dependencies": {
-    "axios": "^1.11.0"
+    "axios": "^1.11.0",
+    "ethers": "^6.15.0"
   },
   "scripts": {
     "compile": "rm -rf lib && tsc",
-    "codegen": "node scripts/codegen.js"
+    "codegen": "node scripts/codegen.js",
+    "gen:abi": "pnpm dlx typechain --target ethers-v6 --out-dir src/abi-types 'abis/*.json'"
   }
 }

package/lib/model/seal-create-order-intent-request.d.ts

@@ -1,121 +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 { SealTransferPermission } from './seal-transfer-permission';
-/**
- *
- * @export
- * @interface SealCreateOrderIntentRequest
- */
-export interface SealCreateOrderIntentRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'owner': string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'chainId': string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'tokenIn': string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'amountIn': string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'tokenOut': string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'price': string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'depositAmount': string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'depositToken': string;
-    /**
-     *
-     * @type {number}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'reservationPeriodSeconds': number;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'minFillRatio': string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'minReservationDepositAmount': string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'nonce': string;
-    /**
-     *
-     * @type {number}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'deadline': number;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'signature': string;
-    /**
-     *
-     * @type {SealTransferPermission}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'transferPermission': SealTransferPermission;
-    /**
-     *
-     * @type {boolean}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'reservationAllowed': boolean;
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentRequest
-     */
-    'makerFee': string;
-}

package/lib/model/seal-create-order-intent-response.d.ts

@@ -1,24 +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.
- */
-/**
- *
- * @export
- * @interface SealCreateOrderIntentResponse
- */
-export interface SealCreateOrderIntentResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof SealCreateOrderIntentResponse
-     */
-    'id'?: string;
-}

package/lib/model/seal-create-order-intent-response.js

@@ -1,15 +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 });

package/lib/model/seal-eip712-domain-config.d.ts

@@ -1,42 +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.
- */
-/**
- *
- * @export
- * @interface SealEIP712DomainConfig
- */
-export interface SealEIP712DomainConfig {
-    /**
-     *
-     * @type {string}
-     * @memberof SealEIP712DomainConfig
-     */
-    'name'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealEIP712DomainConfig
-     */
-    'version'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealEIP712DomainConfig
-     */
-    'chainId'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealEIP712DomainConfig
-     */
-    'verifyingContract'?: string;
-}

package/lib/model/seal-eip712-domain-config.js

@@ -1,15 +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 });

package/lib/model/seal-get-permit-approvals-response.d.ts

@@ -1,31 +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 { SealTokenPermitApproval } from './seal-token-permit-approval';
-/**
- *
- * @export
- * @interface SealGetPermitApprovalsResponse
- */
-export interface SealGetPermitApprovalsResponse {
-    /**
-     *
-     * @type {Array<SealTokenPermitApproval>}
-     * @memberof SealGetPermitApprovalsResponse
-     */
-    'permits'?: Array<SealTokenPermitApproval>;
-    /**
-     *
-     * @type {string}
-     * @memberof SealGetPermitApprovalsResponse
-     */
-    'paginationNextKey'?: string;
-}

package/lib/model/seal-get-permit-approvals-response.js

@@ -1,15 +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 });

package/lib/model/seal-get-reservation-settlement-activities-response.d.ts

@@ -1,31 +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 { SealOrderActivity } from './seal-order-activity';
-/**
- *
- * @export
- * @interface SealGetReservationSettlementActivitiesResponse
- */
-export interface SealGetReservationSettlementActivitiesResponse {
-    /**
-     *
-     * @type {Array<SealOrderActivity>}
-     * @memberof SealGetReservationSettlementActivitiesResponse
-     */
-    'activities': Array<SealOrderActivity>;
-    /**
-     *
-     * @type {string}
-     * @memberof SealGetReservationSettlementActivitiesResponse
-     */
-    'paginationNextKey'?: string;
-}

package/lib/model/seal-get-reservation-settlement-activities-response.js

@@ -1,15 +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 });

package/lib/model/seal-order-activity-with-order.d.ts

@@ -1,32 +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 { SealOrder } from './seal-order';
-import type { SealOrderActivity } from './seal-order-activity';
-/**
- *
- * @export
- * @interface SealOrderActivityWithOrder
- */
-export interface SealOrderActivityWithOrder {
-    /**
-     *
-     * @type {SealOrderActivity}
-     * @memberof SealOrderActivityWithOrder
-     */
-    'activity': SealOrderActivity;
-    /**
-     *
-     * @type {SealOrder}
-     * @memberof SealOrderActivityWithOrder
-     */
-    'order': SealOrder;
-}

package/lib/model/seal-order-activity-with-order.js

@@ -1,15 +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 });

package/lib/model/seal-order-config.d.ts

@@ -1,36 +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.
- */
-/**
- *
- * @export
- * @interface SealOrderConfig
- */
-export interface SealOrderConfig {
-    /**
-     *
-     * @type {string}
-     * @memberof SealOrderConfig
-     */
-    'minReservationDepositAllowed'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealOrderConfig
-     */
-    'maxReservationDepositAllowed'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof SealOrderConfig
-     */
-    'reservationDepositDenom'?: string;
-}

package/lib/model/seal-order-config.js

@@ -1,15 +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 });

package/lib/model/seal-order-intent.d.ts

@@ -1,31 +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 { SealTransferPermission } from './seal-transfer-permission';
-/**
- *
- * @export
- * @interface SealOrderIntent
- */
-export interface SealOrderIntent {
-    /**
-     *
-     * @type {string}
-     * @memberof SealOrderIntent
-     */
-    'signature'?: string;
-    /**
-     *
-     * @type {SealTransferPermission}
-     * @memberof SealOrderIntent
-     */
-    'transferPermission'?: SealTransferPermission;
-}

package/lib/model/seal-order-intent.js

@@ -1,15 +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 });