@1inch/solidity-utils 5.0.0 → 5.1.0

package/dist/src/bySig.d.ts

@@ -0,0 +1,50 @@
+import { Wallet } from 'ethers';
+import { SignerWithAddress } from '@nomicfoundation/hardhat-ethers/signers';
+/**
+ * Enum defining types of nonces.
+ */
+export declare enum NonceType {
+    Account = 0,// Nonce for account
+    Selector = 1,// Nonce for selector
+    Unique = 2
+}
+/**
+ * Builds traits for {bySig} contract by combining params.
+ * @param nonceType The type of nonce to use. Default is NonceType.Account.
+ * @param deadline The deadline for the message. Default is 0.
+ * @param relayer The relayer address. Default is the zero address.
+ * @param nonce The nonce. Default is 0.
+ * @returns A bigint representing the combined traits.
+ * @throws Error if provided with invalid parameters.
+ */
+export declare function buildBySigTraits({ nonceType, deadline, relayer, nonce, }?: {
+    nonceType?: NonceType | undefined;
+    deadline?: number | undefined;
+    relayer?: string | undefined;
+    nonce?: number | undefined;
+}): bigint;
+export interface SignedCallStruct {
+    traits: bigint;
+    data: string;
+}
+/**
+ * Computes the EIP-712 hash for a given bySig call.
+ * @param name The user readable name of EIP-712 domain.
+ * @param version The version of the EIP-712 domain.
+ * @param chainId The unique identifier for the blockchain network.
+ * @param verifyingContract The Ethereum address of the contract that will verify the signature. This ties the signature to a specific contract.
+ * @param sig The data to be signed.
+ * @returns The EIP-712 hash of the fully encoded data.
+ */
+export declare function hashBySig(name: string, version: string, chainId: bigint, verifyingContract: string, sig: SignedCallStruct): string;
+/**
+ * Signs a given data for {bySig} contract call using EIP-712 standard.
+ * @param name The user readable name of EIP-712 domain.
+ * @param version The version of the EIP-712 domain.
+ * @param chainId The unique identifier for the blockchain network.
+ * @param verifyingContract The Ethereum address of the contract that will verify the signature. This ties the signature to a specific contract.
+ * @param signer The wallet or signer to sign the data.
+ * @param signedCall The call data to be signed, consisting of traits and data.
+ * @returns A Promise that resolves to the signature.
+ */
+export declare function signSignedCall(name: string, version: string, chainId: bigint | string, verifyingContract: string, signer: Wallet | SignerWithAddress, signedCall: SignedCallStruct): Promise<string>;

package/dist/src/bySig.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signSignedCall = exports.hashBySig = exports.buildBySigTraits = exports.NonceType = void 0;
+const hardhat_1 = require("hardhat");
+const prelude_1 = require("./prelude");
+/**
+ * Enum defining types of nonces.
+ */
+var NonceType;
+(function (NonceType) {
+    NonceType[NonceType["Account"] = 0] = "Account";
+    NonceType[NonceType["Selector"] = 1] = "Selector";
+    NonceType[NonceType["Unique"] = 2] = "Unique";
+})(NonceType || (exports.NonceType = NonceType = {}));
+/**
+ * Builds traits for {bySig} contract by combining params.
+ * @param nonceType The type of nonce to use. Default is NonceType.Account.
+ * @param deadline The deadline for the message. Default is 0.
+ * @param relayer The relayer address. Default is the zero address.
+ * @param nonce The nonce. Default is 0.
+ * @returns A bigint representing the combined traits.
+ * @throws Error if provided with invalid parameters.
+ */
+function buildBySigTraits({ nonceType = NonceType.Account, deadline = 0, relayer = prelude_1.constants.ZERO_ADDRESS.toString(), nonce = 0, } = {}) {
+    if (nonceType > 3) {
+        throw new Error('Wrong nonce type, it should be less than 4');
+    }
+    if (deadline > 0xffffffffff) {
+        throw new Error('Wrong deadline, it should be less than 0xffffffff');
+    }
+    if (relayer.length > 42) {
+        throw new Error('Wrong relayer address, it should be less than 42 symbols');
+    }
+    if (nonce > 0xffffffffffffffffffffffffffffffffn) {
+        throw new Error('Wrong nonce, it should not be more than 128 bits');
+    }
+    return (BigInt(nonceType) << 254n) +
+        (BigInt(deadline) << 208n) +
+        ((BigInt(relayer) & 0xffffffffffffffffffffn) << 128n) +
+        BigInt(nonce);
+}
+exports.buildBySigTraits = buildBySigTraits;
+/**
+ * Computes the EIP-712 hash for a given bySig call.
+ * @param name The user readable name of EIP-712 domain.
+ * @param version The version of the EIP-712 domain.
+ * @param chainId The unique identifier for the blockchain network.
+ * @param verifyingContract The Ethereum address of the contract that will verify the signature. This ties the signature to a specific contract.
+ * @param sig The data to be signed.
+ * @returns The EIP-712 hash of the fully encoded data.
+ */
+function hashBySig(name, version, chainId, verifyingContract, sig) {
+    const domain = { name, version, chainId, verifyingContract };
+    const types = {
+        SignedCall: [
+            { name: 'traits', type: 'uint256' },
+            { name: 'data', type: 'bytes' },
+        ],
+    };
+    return hardhat_1.ethers.TypedDataEncoder.hash(domain, types, sig);
+}
+exports.hashBySig = hashBySig;
+/**
+ * Signs a given data for {bySig} contract call using EIP-712 standard.
+ * @param name The user readable name of EIP-712 domain.
+ * @param version The version of the EIP-712 domain.
+ * @param chainId The unique identifier for the blockchain network.
+ * @param verifyingContract The Ethereum address of the contract that will verify the signature. This ties the signature to a specific contract.
+ * @param signer The wallet or signer to sign the data.
+ * @param signedCall The call data to be signed, consisting of traits and data.
+ * @returns A Promise that resolves to the signature.
+ */
+function signSignedCall(name, version, chainId, verifyingContract, signer, signedCall) {
+    return signer.signTypedData({ name, version, chainId, verifyingContract }, { SignedCall: [{ name: 'traits', type: 'uint256' }, { name: 'data', type: 'bytes' }] }, signedCall);
+}
+exports.signSignedCall = signSignedCall;
+//# sourceMappingURL=bySig.js.map

package/dist/src/bySig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bySig.js","sourceRoot":"","sources":["../../src/bySig.ts"],"names":[],"mappings":";;;AAAA,qCAAiC;AACjC,uCAAsC;AAItC;;GAEG;AACH,IAAY,SAIX;AAJD,WAAY,SAAS;IACjB,+CAAO,CAAA;IACP,iDAAQ,CAAA;IACR,6CAAM,CAAA;AACV,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AAED;;;;;;;;GAQG;AACH,SAAgB,gBAAgB,CAAC,EAC7B,SAAS,GAAG,SAAS,CAAC,OAAO,EAC7B,QAAQ,GAAG,CAAC,EACZ,OAAO,GAAG,mBAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,EAC3C,KAAK,GAAG,CAAC,GACZ,GAAG,EAAE;IACF,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAClE,CAAC;IACD,IAAI,QAAQ,GAAG,YAAY,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACzE,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IAChF,CAAC;IACD,IAAI,KAAK,GAAG,mCAAmC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACxE,CAAC;IAED,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC;QAC1B,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC;QAC1B,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,uBAAuB,CAAC,IAAI,IAAI,CAAC;QACrD,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAvBD,4CAuBC;AAOD;;;;;;;;GAQG;AACH,SAAgB,SAAS,CAAC,IAAY,EAAE,OAAe,EAAE,OAAe,EAAE,iBAAyB,EAAE,GAAqB;IACtH,MAAM,MAAM,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAC7D,MAAM,KAAK,GAAG;QACV,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;YACnC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE;SAClC;KACJ,CAAC;IACF,OAAO,gBAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;AAC5D,CAAC;AATD,8BASC;AAED;;;;;;;;;GASG;AACH,SAAgB,cAAc,CAC1B,IAAY,EACZ,OAAe,EACf,OAAwB,EACxB,iBAAyB,EACzB,MAAkC,EAClC,UAA4B;IAE5B,OAAO,MAAM,CAAC,aAAa,CACvB,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,EAC7C,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,EACtF,UAAU,CACb,CAAC;AACN,CAAC;AAbD,wCAaC"}

package/dist/src/index.d.ts

@@ -1,3 +1,4 @@
+export * from './bySig';
 export * from './expect';
 export * from './permit';
 export * from './prelude';

package/dist/src/index.js

@@ -2,6 +2,7 @@
 // created from 'create-ts-index'
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./bySig"), exports);
 tslib_1.__exportStar(require("./expect"), exports);
 tslib_1.__exportStar(require("./permit"), exports);
 tslib_1.__exportStar(require("./prelude"), exports);

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,iCAAiC;;;AAEjC,mDAAyB;AACzB,mDAAyB;AACzB,oDAA0B;AAC1B,uDAA6B;AAC7B,kDAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,iCAAiC;;;AAEjC,kDAAwB;AACxB,mDAAyB;AACzB,mDAAyB;AACzB,oDAA0B;AAC1B,uDAA6B;AAC7B,kDAAwB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1inch/solidity-utils",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "exports": {