@ensdomains/ensjs 3.0.0-alpha.10 → 3.0.0-alpha.13

package/dist/esm/index.d.ts

@@ -4,8 +4,11 @@ import ContractManager from './contracts';
 import { getContractAddress as _getContractAddress } from './contracts/getContractAddress';
 import { SupportedNetworkId } from './contracts/types';
 import type burnFuses from './functions/burnFuses';
+import type commitName from './functions/commitName';
 import type createSubname from './functions/createSubname';
 import type deleteSubname from './functions/deleteSubname';
+import registerName from './functions/registerName';
+import renewName from './functions/renewName';
 import type setName from './functions/setName';
 import type setRecord from './functions/setRecord';
 import type setRecords from './functions/setRecords';
@@ -36,7 +39,9 @@ declare type WriteOptions = {
 };
 declare type OptionalWriteOptions<F> = F extends (x: any, arg_0: infer Z, options?: infer P) => infer R ? (name: Z, options?: P & WriteOptions) => R : F extends (x: any, arg_0: infer Z, options: infer P) => infer R ? (name: Z, options: P & WriteOptions) => R : never;
 interface WriteFunction<F extends (...args: any) => any> extends Function {
-    (...args: Parameters<OptionalWriteOptions<F>>): Promise<ContractTransaction>;
+    (...args: Parameters<OptionalWriteOptions<F>>): Promise<ContractTransaction & {
+        customData?: Record<string, any>;
+    }>;
     populateTransaction: (...args: Parameters<OptionalWriteOptions<F>>) => Promise<PopulatedTransaction>;
 }
 export declare type RawFunction = {
@@ -206,8 +211,8 @@ export declare class ENS {
             reverseResolverAddress: any;
             resolverAddress: any;
         } | {
-            name: null;
-            match: boolean;
+            name: undefined;
+            match?: undefined;
             reverseResolverAddress?: undefined;
             resolverAddress?: undefined;
         } | undefined>;
@@ -226,10 +231,9 @@ export declare class ENS {
         }>;
         decode: ({ contracts }: ENSArgs<"contracts">, data: string, name: string) => Promise<{
             fuseObj: {
-                [k: string]: any;
+                [k: string]: boolean;
             };
-            vulnerability: any;
-            vulnerableNode: null;
+            expiryDate: Date;
             rawFuses: ethers.BigNumber;
         } | undefined>;
     }>;
@@ -256,36 +260,6 @@ export declare class ENS {
             data: Record<string, any>;
         }[];
     } | undefined>;
-    getHistoryWithDetail: (name: string) => Promise<{
-        domain: {
-            type: any;
-            blockNumber: any;
-            transactionHash: any;
-            id: any;
-            data: Record<string, any>;
-        }[];
-        registration: {
-            type: any;
-            blockNumber: any;
-            transactionHash: any;
-            id: any;
-            data: Record<string, any>;
-        }[];
-        resolver: {
-            type: any;
-            blockNumber: any;
-            transactionHash: any;
-            id: any;
-            data: Record<string, any>;
-        }[];
-    } | undefined>;
-    getHistoryDetailForTransactionHash: (hash: string, indexInTransaction?: number | undefined) => Promise<({
-        key: any;
-        value: any;
-    } | undefined)[] | {
-        key: any;
-        value: any;
-    } | undefined>;
     getContentHash: GeneratedRawFunction<{
         raw: ({ contracts, universalWrapper }: ENSArgs<"contracts" | "universalWrapper">, name: string) => Promise<{
             to: string;
@@ -370,11 +344,18 @@ export declare class ENS {
         } | undefined>;
     }>;
     getExpiry: GeneratedRawFunction<{
-        raw: ({ contracts, multicallWrapper }: ENSArgs<"contracts" | "multicallWrapper">, name: string) => Promise<{
+        raw: (ensArgs: ENSArgs<"contracts" | "multicallWrapper">, name: string, { contract }?: {
+            contract?: ("nameWrapper" | "registrar") | undefined;
+        }) => Promise<{
             to: string;
             data: string;
         }>;
-        decode: ({ contracts, multicallWrapper }: ENSArgs<"contracts" | "multicallWrapper">, data: string) => Promise<{
+        decode: (ensArgs: ENSArgs<"contracts" | "multicallWrapper">, data: string, name: string, { contract }?: {
+            contract?: ("nameWrapper" | "registrar") | undefined;
+        }) => Promise<{
+            expiry: Date;
+            gracePeriod: null;
+        } | {
             expiry: Date | null;
             gracePeriod: number;
         } | undefined>;
@@ -385,7 +366,7 @@ export declare class ENS {
         pageSize?: number | undefined;
         orderDirection?: "asc" | "desc" | undefined;
         orderBy?: "labelName" | "createdAt" | undefined;
-        lastSubnames: any[];
+        lastSubnames?: any[] | undefined;
         isLargeQuery?: boolean | undefined;
     }) => Promise<{
         subnames: {
@@ -429,6 +410,7 @@ export declare class ENS {
             premium: ethers.BigNumber;
         } | undefined>;
     }>;
+    getDNSOwner: (dnsName: string) => Promise<any>;
     universalWrapper: GeneratedRawFunction<{
         raw: ({ contracts }: ENSArgs<"contracts">, name: string, data: string) => Promise<{
             to: string;
@@ -467,6 +449,8 @@ export declare class ENS {
     createSubname: WriteFunction<typeof createSubname>;
     deleteSubname: WriteFunction<typeof deleteSubname>;
     transferSubname: WriteFunction<typeof transferSubname>;
-    getDNSOwner: (dnsName: string) => Promise<any>;
+    commitName: WriteFunction<typeof commitName>;
+    registerName: WriteFunction<typeof registerName>;
+    renewName: WriteFunction<typeof renewName>;
 }
 export {};

package/dist/esm/index.js

@@ -168,8 +168,6 @@ export class ENS {
             'contracts',
         ]);
         this.getHistory = this.generateFunction('getHistory', ['gqlInstance'], 'getHistory');
-        this.getHistoryWithDetail = this.generateFunction('getHistory', ['contracts', 'gqlInstance', 'provider'], 'getHistoryWithDetail');
-        this.getHistoryDetailForTransactionHash = this.generateFunction('getHistory', ['contracts', 'provider'], 'getHistoryDetailForTransactionHash');
         this.getContentHash = this.generateRawFunction('initialGetters', ['contracts', 'universalWrapper'], 'getContentHash');
         this._getContentHash = this.generateRawFunction('initialGetters', ['contracts'], '_getContentHash');
         this.getAddr = this.generateRawFunction('initialGetters', ['contracts', 'universalWrapper'], 'getAddr');
@@ -181,6 +179,7 @@ export class ENS {
         this.getSubnames = this.generateFunction('initialGetters', ['gqlInstance'], 'getSubnames');
         this.getNames = this.generateFunction('initialGetters', ['gqlInstance'], 'getNames');
         this.getPrice = this.generateRawFunction('initialGetters', ['contracts', 'multicallWrapper'], 'getPrice');
+        this.getDNSOwner = this.generateFunction('getDNSOwner', []);
         this.universalWrapper = this.generateRawFunction('initialGetters', ['contracts'], 'universalWrapper');
         this.resolverMulticallWrapper = this.generateRawFunction('initialGetters', ['contracts'], 'resolverMulticallWrapper');
         this.multicallWrapper = this.generateRawFunction('initialGetters', ['contracts'], 'multicallWrapper');
@@ -197,15 +196,20 @@ export class ENS {
         this.transferName = this.generateWriteFunction('transferName', ['contracts']);
         this.wrapName = this.generateWriteFunction('wrapName', [
             'contracts',
+            'getExpiry',
         ]);
         this.unwrapName = this.generateWriteFunction('unwrapName', ['contracts']);
         this.burnFuses = this.generateWriteFunction('burnFuses', [
             'contracts',
         ]);
-        this.createSubname = this.generateWriteFunction('createSubname', ['contracts']);
+        this.createSubname = this.generateWriteFunction('createSubname', ['contracts', 'getExpiry']);
         this.deleteSubname = this.generateWriteFunction('deleteSubname', ['transferSubname']);
-        this.transferSubname = this.generateWriteFunction('transferSubname', ['contracts']);
-        this.getDNSOwner = this.generateFunction('getDNSOwner', []);
+        this.transferSubname = this.generateWriteFunction('transferSubname', ['contracts', 'getExpiry']);
+        this.commitName = this.generateWriteFunction('commitName', ['contracts']);
+        this.registerName = this.generateWriteFunction('registerName', ['contracts']);
+        this.renewName = this.generateWriteFunction('renewName', [
+            'contracts',
+        ]);
         this.options = options;
         this.getContractAddress = options?.getContractAddress || _getContractAddress;
     }

package/dist/esm/utils/registerHelpers.d.ts

@@ -1,26 +1,54 @@
 import type { FuseOptions } from '../@types/FuseOptions';
 import type { PublicResolver } from '../generated';
 import { RecordOptions } from './recordHelpers';
-export declare const randomSecret: () => string;
-export declare const makeCommitment: ({ name, owner, duration, resolver, records, reverseRecord, fuses, }: {
+export declare type RegistrationParams = {
     name: string;
     owner: string;
     duration: number;
+    secret: string;
     resolver: PublicResolver;
-    records?: RecordOptions | undefined;
-    reverseRecord?: boolean | undefined;
-    fuses?: FuseOptions | undefined;
-}) => {
+    records?: RecordOptions;
+    reverseRecord?: boolean;
+    fuses?: FuseOptions;
+    wrapperExpiry: number;
+};
+export declare type CommitmentParams = Omit<RegistrationParams, 'secret' | 'wrapperExpiry'> & {
+    secret?: string;
+    wrapperExpiry?: number;
+};
+export declare type RegistrationTuple = [
+    name: string,
+    owner: string,
+    duration: number,
+    secret: string,
+    resolver: string,
+    data: string[],
+    reverseRecord: boolean,
+    fuses: string,
+    wrapperExpiry: number
+];
+export declare type CommitmentTuple = [
+    labelhash: string,
+    owner: string,
+    duration: number,
+    resolver: string,
+    data: string[],
+    secret: string,
+    reverseRecord: boolean,
+    fuses: string,
+    wrapperExpiry: number
+];
+export declare const randomSecret: () => string;
+export declare const makeCommitmentData: ({ name, owner, duration, resolver, records, reverseRecord, fuses, wrapperExpiry, secret, }: Omit<RegistrationParams, "secret" | "wrapperExpiry"> & {
+    secret?: string | undefined;
+    wrapperExpiry?: number | undefined;
+} & {
+    secret: string;
+}) => CommitmentTuple;
+export declare const makeRegistrationData: (params: RegistrationParams) => RegistrationTuple;
+export declare const makeCommitment: ({ secret, ...inputParams }: CommitmentParams) => {
     secret: string;
     commitment: string;
+    wrapperExpiry: number;
 };
-export declare const _makeCommitment: ({ labelhash, owner, duration, secret, resolver, data, reverseRecord, fuses, }: {
-    labelhash: string;
-    owner: string;
-    duration: number;
-    secret: string;
-    resolver: string;
-    data: string[];
-    reverseRecord: boolean;
-    fuses: string;
-}) => string;
+export declare const _makeCommitment: (params: CommitmentTuple) => string;

package/dist/esm/utils/registerHelpers.js

@@ -7,37 +7,63 @@ export const randomSecret = () => {
     const bytes = Buffer.allocUnsafe(32);
     return '0x' + crypto.getRandomValues(bytes).toString('hex');
 };
-export const makeCommitment = ({ name, owner, duration, resolver, records, reverseRecord, fuses, }) => {
+export const makeCommitmentData = ({ name, owner, duration, resolver, records, reverseRecord, fuses, wrapperExpiry, secret, }) => {
     const label = labelhash(name.split('.')[0]);
     const hash = namehash(name);
     const resolverAddress = resolver.address;
-    const data = records ? generateRecordCallArray(hash, records, resolver) : [];
-    const secret = randomSecret();
     const fuseData = fuses ? generateFuseInput(fuses) : '0';
-    const commitment = _makeCommitment({
-        labelhash: label,
+    if (reverseRecord) {
+        if (!records) {
+            records = { coinTypes: [{ key: 'ETH', value: owner }] };
+        }
+        else if (!records.coinTypes?.find((c) => c.key === 'ETH')) {
+            if (!records.coinTypes)
+                records.coinTypes = [];
+            records.coinTypes.push({ key: 'ETH', value: owner });
+        }
+    }
+    const data = records ? generateRecordCallArray(hash, records, resolver) : [];
+    return [
+        label,
         owner,
         duration,
-        secret,
-        resolver: resolverAddress,
+        resolverAddress,
         data,
-        reverseRecord: !!reverseRecord,
-        fuses: fuseData,
+        secret,
+        !!reverseRecord,
+        fuseData,
+        wrapperExpiry || Math.floor(Date.now() / 1000) + duration,
+    ];
+};
+export const makeRegistrationData = (params) => {
+    const commitmentData = makeCommitmentData(params);
+    commitmentData[0] = params.name.split('.')[0];
+    const secret = commitmentData.splice(5, 1)[0];
+    commitmentData.splice(3, 0, secret);
+    return commitmentData;
+};
+export const makeCommitment = ({ secret = randomSecret(), ...inputParams }) => {
+    const generatedParams = makeCommitmentData({
+        ...inputParams,
+        secret,
     });
+    const commitment = _makeCommitment(generatedParams);
     return {
         secret,
         commitment,
+        wrapperExpiry: generatedParams[8],
     };
 };
-export const _makeCommitment = ({ labelhash, owner, duration, secret, resolver, data, reverseRecord, fuses, }) => {
-    return utils.solidityKeccak256([
+export const _makeCommitment = (params) => {
+    return utils.keccak256(utils.defaultAbiCoder.encode([
         'bytes32',
         'address',
         'uint256',
-        'bytes32',
         'address',
         'bytes[]',
+        'bytes32',
         'bool',
-        'uint96',
-    ], [labelhash, owner, duration, secret, resolver, data, reverseRecord, fuses]);
+        'uint32',
+        'uint64',
+    ], params));
 };

package/dist/esm/utils/wrapperExpiry.d.ts

@@ -0,0 +1,5 @@
+import { BigNumber } from 'ethers';
+import { ENSArgs } from '..';
+export declare type Expiry = string | number | Date | BigNumber;
+export declare const MAX_EXPIRY: BigNumber;
+export declare const makeExpiry: ({ getExpiry }: ENSArgs<'getExpiry'>, name: string, expiry?: Expiry | undefined) => Promise<BigNumber>;

package/dist/esm/utils/wrapperExpiry.js

@@ -0,0 +1,26 @@
+import { BigNumber } from 'ethers';
+export const MAX_EXPIRY = BigNumber.from(2).pow(64).sub(1);
+export const makeExpiry = async ({ getExpiry }, name, expiry) => {
+    if (expiry) {
+        if (expiry instanceof Date) {
+            return BigNumber.from(expiry.getTime() / 1000);
+        }
+        else if (expiry instanceof BigNumber) {
+            return expiry;
+        }
+        else {
+            return BigNumber.from(expiry);
+        }
+    }
+    else {
+        if (name.endsWith('.eth')) {
+            const expResponse = await getExpiry(name);
+            if (!expResponse?.expiry)
+                throw new Error("Couldn't get expiry for name, please provide one.");
+            return BigNumber.from(expResponse.expiry.getTime() / 1000);
+        }
+        else {
+            return MAX_EXPIRY;
+        }
+    }
+};

package/dist/esm/utils/writeTx.d.ts

@@ -1,4 +1,21 @@
 import { JsonRpcSigner } from '@ethersproject/providers';
 import type { PopulatedTransaction } from 'ethers';
-declare const _default: (signer: JsonRpcSigner, populate: boolean) => (tx: PopulatedTransaction) => PopulatedTransaction | Promise<import("@ethersproject/abstract-provider").TransactionResponse>;
+declare type CustomData = Record<string, any>;
+declare const _default: (signer: JsonRpcSigner, populate: boolean) => ({ customData, ...tx }: PopulatedTransaction) => {
+    to?: string | undefined;
+    from?: string | undefined;
+    nonce?: number | undefined;
+    gasLimit?: import("ethers").BigNumber | undefined;
+    gasPrice?: import("ethers").BigNumber | undefined;
+    data?: string | undefined;
+    value?: import("ethers").BigNumber | undefined;
+    chainId?: number | undefined;
+    type?: number | undefined;
+    accessList?: import("ethers/lib/utils").AccessList | undefined;
+    maxFeePerGas?: import("ethers").BigNumber | undefined;
+    maxPriorityFeePerGas?: import("ethers").BigNumber | undefined;
+    ccipReadEnabled?: boolean | undefined;
+} | Promise<import("@ethersproject/providers").TransactionResponse | (import("@ethersproject/providers").TransactionResponse & {
+    customData: CustomData;
+})>;
 export default _default;

package/dist/esm/utils/writeTx.js

@@ -1 +1,4 @@
-export default (signer, populate) => (tx) => populate ? tx : signer.sendTransaction(tx);
+const withCustomData = (tx, customData) => customData ? { ...tx, customData } : tx;
+export default (signer, populate) => ({ customData, ...tx }) => populate
+    ? withCustomData(tx, customData)
+    : signer.sendTransaction(tx).then((r) => withCustomData(r, customData));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ensdomains/ensjs",
-  "version": "3.0.0-alpha.10",
+  "version": "3.0.0-alpha.13",
   "description": "ENS javascript library for contract interaction",
   "main": "./dist/cjs/index.js",
   "types": "./dist/cjs/index.d.ts",
@@ -22,27 +22,9 @@
   "repository": "git@github.com:ensdomains/ensjs-v3.git",
   "author": "TateB <yo@taytems.xyz>",
   "license": "MIT",
-  "scripts": {
-    "env": "yarn ens-test-env",
-    "generate-types": "ts-node scripts/runTypechain.ts",
-    "generate-abis": "hardhat export-abi",
-    "start": "ts-node --files src/index.test.ts",
-    "test": "jest --run-in-band",
-    "test:watch": "jest --watch --run-in-band",
-    "test:specific": "ts-node --files ",
-    "clean": "rm -rf ./dist ./README.md ./LICENSE",
-    "build:esm": "tsc --project tsconfig.esm.json",
-    "build:cjs": "tsc --project tsconfig.cjs.json",
-    "build": "yarn clean && yarn build:esm && yarn build:cjs",
-    "prepublish": "yarn build && cp ../../{README.md,LICENSE} ./",
-    "remove-stableVersion": "ex -c '%s/,\\n\\s\\+\"stableVersion\".*\"//g' -cwq ./package.json",
-    "version:create": "yarn remove-stableVersion && yarn version"
-  },
-  "packageManager": "yarn@3.2.0",
   "dependencies": {
-    "@ensdomains/address-encoder": "^0.2.16",
+    "@ensdomains/address-encoder": "0.2.16",
     "@ensdomains/content-hash": "^2.5.7",
-    "@ensdomains/ens-contracts": "^0.0.11",
     "dns-packet": "^5.3.1",
     "ethers": "^5.6.1",
     "graphql": "^16.3.0",
@@ -52,36 +34,53 @@
   },
   "devDependencies": {
     "@ensdomains/buffer": "^0.0.13",
-    "@ensdomains/ens-test-env": "0.1.5",
+    "@ensdomains/ens-contracts": "^0.0.12",
+    "@ensdomains/ens-test-env": "0.2.2",
     "@ethersproject/abi": "^5.6.0",
     "@ethersproject/providers": "^5.6.2",
-    "@nomiclabs/hardhat-ethers": "^2.0.5",
+    "@nomiclabs/hardhat-ethers": "npm:hardhat-deploy-ethers",
     "@openzeppelin/contracts": "^4.5.0",
     "@swc/core": "^1.2.162",
     "@swc/jest": "^0.2.20",
-    "@typechain/ethers-v5": "^10.0.0",
+    "@typechain/ethers-v5": "^10.1.0",
     "@types/bn.js": "^5.1.0",
     "@types/jest": "^27.4.1",
     "@types/traverse": "^0.6.32",
     "dotenv": "^16.0.0",
-    "ens-contracts": "github:ensdomains/ens-contracts#head=master&commit=3ecc56b14beb4aae8296f8a94f7c0d095e62fd93",
-    "hardhat": "^2.9.3",
+    "ganache": "^7.4.0",
+    "hardhat": "^2.10.1",
     "hardhat-abi-exporter": "^2.8.0",
-    "hardhat-deploy": "^0.11.4",
+    "hardhat-deploy": "^0.11.12",
     "jest": "^27.5.1",
     "jest-environment-node": "^27.5.1",
     "jest-localstorage-mock": "^2.4.21",
     "nock": "^13.2.8",
     "node-fetch": "^3.2.6",
+    "node-fetch-commonjs": "^3.1.1",
     "solc": "^0.8.13",
     "ts-jest": "^27.1.4",
     "ts-node": "^10.7.0",
-    "typechain": "^8.0.0",
+    "typechain": "^8.1.0",
     "typescript": "^4.6.2",
     "wait-on": "^6.0.1"
   },
   "peerDependencies": {
     "ethers": "*"
   },
-  "stableVersion": "3.0.0-alpha.9"
+  "scripts": {
+    "tenv": "ens-test-env -a",
+    "generate-types": "ts-node scripts/runTypechain.ts",
+    "generate-abis": "hardhat export-abi",
+    "start": "ts-node --files src/index.test.ts",
+    "test": "jest --run-in-band",
+    "test:watch": "jest --watch --run-in-band",
+    "test:specific": "ts-node --files ",
+    "clean": "rm -rf ./dist ./README.md ./LICENSE",
+    "build:esm": "tsc --project tsconfig.esm.json",
+    "build:cjs": "tsc --project tsconfig.cjs.json",
+    "build": "pnpm clean && pnpm build:esm && pnpm build:cjs",
+    "prepublish": "pnpm build && cp ../../README.md ../../LICENSE ./",
+    "enode": "ganache --wallet.mnemonic=\"test test test test test test test test test test test junk\" --chain.chainId 1337 --chain.networkId 1337 --chain.time 1659500634000",
+    "ver": "pnpm version --no-workspaces-update"
+  }
 }