@ring-protocol/permit2-sdk 0.1.0

package/dist/types/src/providers/SignatureProvider.d.ts

@@ -0,0 +1,74 @@
+import { BigNumber, BigNumberish } from '@ethersproject/bignumber';
+import { Provider } from '@ethersproject/providers';
+import { PermitTransferFrom, PermitBatchTransferFrom } from '../signatureTransfer';
+export interface NonceValidationResult {
+    isUsed: boolean;
+    isExpired: boolean;
+    isValid: boolean;
+}
+export declare class SignatureProvider {
+    private provider;
+    private permit2Address;
+    private permit2;
+    constructor(provider: Provider, permit2Address: string);
+    /**
+     * Check if a nonce has been used for signature transfers
+     * @param owner The owner address
+     * @param nonce The nonce to check
+     * @returns true if the nonce has been used, false otherwise
+     */
+    isNonceUsed(owner: string, nonce: BigNumberish): Promise<boolean>;
+    /**
+     * Check if a permit has expired based on its deadline
+     * @param deadline The deadline timestamp
+     * @returns true if the permit has expired, false otherwise
+     */
+    isExpired(deadline: BigNumberish): Promise<boolean>;
+    /**
+     * Check if a permit is valid (not expired and nonce not used)
+     * @param permit The permit data to validate
+     * @returns true if the permit is valid, false otherwise
+     */
+    isPermitValid(permit: PermitTransferFrom | PermitBatchTransferFrom): Promise<boolean>;
+    /**
+     * Get detailed validation results for a permit
+     * @param permit The permit data to validate
+     * @returns Object containing validation results
+     */
+    validatePermit(permit: PermitTransferFrom | PermitBatchTransferFrom): Promise<NonceValidationResult>;
+    /**
+     * Get the current nonce bitmap for an owner at a specific word position
+     * @param owner The owner address
+     * @param wordPos The word position in the bitmap
+     * @returns The bitmap as a BigNumber
+     */
+    getNonceBitmap(owner: string, wordPos: BigNumberish): Promise<BigNumber>;
+    /**
+     * Check if a specific bit is set in the nonce bitmap
+     * @param bitmap The bitmap to check
+     * @param bitPos The bit position (0-255)
+     * @returns true if the bit is set, false otherwise
+     */
+    static isBitSet(bitmap: BigNumber, bitPos: number): boolean;
+    /**
+     * Get the word position and bit position for a given nonce
+     * @param nonce The nonce to analyze
+     * @returns Object containing wordPos and bitPos
+     */
+    static getNoncePositions(nonce: BigNumberish): {
+        wordPos: BigNumber;
+        bitPos: number;
+    };
+    /**
+     * Batch check multiple nonces for the same owner
+     * @param owner The owner address
+     * @param nonces Array of nonces to check
+     * @returns Array of boolean results indicating if each nonce is used
+     */
+    batchCheckNonces(owner: string, nonces: BigNumberish[]): Promise<boolean[]>;
+    /**
+     * Get the current block timestamp
+     * @returns Current block timestamp
+     */
+    getCurrentTimestamp(): Promise<number>;
+}

package/dist/types/src/providers/SignatureProvider.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/providers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './AllowanceProvider';
+export * from './SignatureProvider';

package/dist/types/src/signatureTransfer.d.ts

@@ -0,0 +1,41 @@
+import { TypedDataDomain, TypedDataField } from '@ethersproject/abstract-signer';
+import { BigNumberish } from '@ethersproject/bignumber';
+export interface Witness {
+    witness: any;
+    witnessTypeName: string;
+    witnessType: Record<string, TypedDataField[]>;
+}
+export interface TokenPermissions {
+    token: string;
+    amount: BigNumberish;
+}
+export interface PermitTransferFrom {
+    permitted: TokenPermissions;
+    spender: string;
+    nonce: BigNumberish;
+    deadline: BigNumberish;
+}
+export interface PermitBatchTransferFrom {
+    permitted: TokenPermissions[];
+    spender: string;
+    nonce: BigNumberish;
+    deadline: BigNumberish;
+}
+export type PermitTransferFromData = {
+    domain: TypedDataDomain;
+    types: Record<string, TypedDataField[]>;
+    values: PermitTransferFrom;
+};
+export type PermitBatchTransferFromData = {
+    domain: TypedDataDomain;
+    types: Record<string, TypedDataField[]>;
+    values: PermitBatchTransferFrom;
+};
+export declare abstract class SignatureTransfer {
+    /**
+     * Cannot be constructed.
+     */
+    private constructor();
+    static getPermitData(permit: PermitTransferFrom | PermitBatchTransferFrom, permit2Address: string, chainId: number, witness?: Witness): PermitTransferFromData | PermitBatchTransferFromData;
+    static hash(permit: PermitTransferFrom | PermitBatchTransferFrom, permit2Address: string, chainId: number, witness?: Witness): string;
+}

package/dist/types/src/signatureTransfer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@ring-protocol/permit2-sdk",
+  "description": "An sdk for interacting with permit2.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Few-Protocol/ring-sdks.git"
+  },
+  "keywords": [
+    "uniswap",
+    "ethereum"
+  ],
+  "license": "MIT",
+  "main": "./dist/cjs/src/index.js",
+  "module": "./dist/esm/src/index.js",
+  "types": "./dist/types/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/src/index.d.ts",
+      "import": "./dist/esm/src/index.js",
+      "require": "./dist/cjs/src/index.js"
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "yarn clean && yarn build:cjs && yarn build:esm && yarn build:types",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "clean": "rm -rf ./dist",
+    "interop": "yarn node writeInterop.js",
+    "lint": "prettier --check src/",
+    "release": "semantic-release",
+    "test": "jest"
+  },
+  "dependencies": {
+    "ethers": "^5.7.0",
+    "tiny-invariant": "^1.1.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^24.0.25",
+    "jest": "25.5.0",
+    "prettier": "^2.4.1",
+    "typescript": "^4.3.3"
+  },
+  "prettier": {
+    "printWidth": 120,
+    "semi": false,
+    "singleQuote": true
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "release": {
+    "extends": "semantic-release-monorepo",
+    "branches": [
+      {
+        "name": "main",
+        "prerelease": false
+      }
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "angular",
+          "releaseRules": "../../publishing/release-rules.cjs"
+        }
+      ],
+      "@semantic-release/release-notes-generator",
+      [
+        "@semantic-release/exec",
+        {
+          "prepareCmd": "node ../../publishing/replace-workspace-deps.js"
+        }
+      ],
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      [
+        "@semantic-release/exec",
+        {
+          "successCmd": "git restore ../../sdks/*/package.json ../../yarn.lock && [ -f ../../yarn.lock.bak ] && mv ../../yarn.lock.bak ../../yarn.lock || true; yarn",
+          "failCmd": "git restore ../../sdks/*/package.json ../../yarn.lock && [ -f ../../yarn.lock.bak ] && mv ../../yarn.lock.bak ../../yarn.lock || true; yarn",
+          "execCwd": "../.."
+        }
+      ]
+    ]
+  },
+  "version": "0.1.0"
+}