{"bugs":{"url":"https://github.com/EthWorks/Waffle/issues"},"dist":{"shasum":"d346c7049b46788974a269b76891c2161bae49ed","tarball":"https://registry.npmjs.org/@ethereum-waffle/ens/-/ens-4.0.0-alpha.9.tgz","fileCount":29,"integrity":"sha512-CO+O4UG7zN2peRsEXYSnJo0/LYYAJNzy2UHQIP64b9Rj9en4t1dtRut7By44AQplUW76Lz2zv8tjwu1gn82D8g==","signatures":[{"sig":"MEQCIGJ5EbNCnlDrNExuRwn3gc7y36mMJk3Y5JiQbI2B96ckAiB+R/d37pyOImTTK/iPbVcQVz3169pI0bt4PcVx0Mc1Yw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":43288,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiTGAWACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoeKA/+Nx57owTw1lk3//B11/SA8krSohq+Bv7s5q05TSrbqANf290w\r\noztDYi6x+/LeXW1vVesAzAYANCDxOfJEbPjHyQk39r6pqV9eUHuRLAMSlLDT\r\ngaUTCivHYizxRhc66XcDlEyI+0Qx+B39/kMo9w+OWn8pXakWcxk1gBIoLOhZ\r\nrjlR3wAKAc8unrBdFVwnumAZCcWKnAgAsH+4KyHH5Vd5lFUUOEdjaSxhi2Yf\r\nkwE+L53jSe8jJFAGgEJDsxpnrEnitrI4tvIc9nxai2KFp5qiN+3k+0PeazH3\r\nfqxDImLMQU21aE6ojHYdZhfda9EBP/uHTQL/NV59Nvs7C2aRwf64N+rYUdtD\r\nlxNOWkkOCtLAK86ghmLa0rIh3tWvPOPcnac0vSJ6Pp/kK0gBC6ZP9xqgbLX+\r\no1y1SlT5CmgxEZX5Kno0QcnzCoTGlEhguMoLpYU0FbD9xDztYKn8oV/QTs0G\r\nd7F/YbJBWk5ESpHBFvHnb8uWQGiqnclOtKBght75qgQuROTTX12OsdPrgqn1\r\nXbOZDMIV5amm/qbgj6PXbxwoSOdz6gq/noXHgTyFPKSENvMu1a3cKuuc0yMz\r\nJSLYkHS9j1107/uIoaxrzQw/a9VLWjl2jvq6Y9XcCYaWyZkkJsg9IqZ19R5X\r\nFhDxPvHyxt7+J8SNVKX1tzocPaJiRUYlGwc=\r\n=q43D\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/cjs/index.js","name":"@ethereum-waffle/ens","types":"dist/esm/index.d.ts","author":{"url":"http://ethworks.io","name":"Marek Kirejczyk","email":"account@ethworks.io"},"module":"dist/esm/index.ts","readme":"![CI](https://github.com/EthWorks/Waffle/workflows/CI/badge.svg)\n[![](https://img.shields.io/npm/v/@ethereum-waffle/ens.svg)](https://www.npmjs.com/package/@ethereum-waffle/ens)\n\n![Ethereum Waffle](https://raw.githubusercontent.com/EthWorks/Waffle/master/docs/source/logo.png)\n\n# @ethereum-waffle/ens\n\nA simple `ENS` for testing.\n\n## Installation\n\nIn the current version of waffle (v2.x.x) you will install this package as a dependency of the main waffle package - `ethereum-waffle`.\n\n```\nyarn add --dev ethereum-waffle\nnpm install --save-dev ethereum-waffle\n```\n\nIf you want to use this package directly, please install it via:\n```\nyarn add --dev @ethereum-waffle/ens\nnpm install --save-dev @ethereum-waffle/ens\n```\n\n## Feature overview\n\n**NOTE**: You do not need to use this package directly. You can install it through the main package (`ethereum-waffle`) and use it instead.\n\n### ENS\n\nThe `ENS` class allows to create ENS domains for testing.\n\nIt will deploy ENS smart contracts system to your test node.\n\nTo create `ENS`, you should submit your `wallet`, available in `MockProvider` class in package `@ethereum-waffle/provider`.\n\nYou can read more about ENS [in the ENS's documentation](https://docs.ens.domains/).\n\n### Examples:\nCreating ENS:\n```ts\nimport {MockProvider} from '@ethereum-waffle/provider';\nimport {deployENS, ENS} from '@ethereum-waffle/ens';\n\nconst provider = new MockProvider();\nconst [wallet] = provider.getWallets();\nconst ens: ENS = await deployENS(wallet);\n```\n\n### Usage\n\nUse `createTopLevelDomain` function to create a top level domain:\n\n```ts\nawait ens.createTopLevelDomain('test');\n```\n\nUse `createSubDomain` function for creating a sub domain:\n\n```ts\nawait ens.createSubDomain('ethworks.test');\n```\n\nAlso, it's possible to create a sub domain recursively, if the top domain doesn't exist, by specifying the appropriate option:\n\n```ts\nawait ens.createSubDomain('ethworks.tld', {recursive: true});\n```\n\nUse `setAddress` function for setting address for the domain:\n\n```ts\nawait ens.setAddress('vlad.ethworks.test', '0x001...03');\n```\nAlso, it's possible to set an address for the domain recursively, if the domain doesn't exist, by specifying the appropriate option:\n\n```ts\nawait ens.setAddress('vlad.ethworks.tld', '0x001...03', {recursive: true});\n```\n\nUse `setAddressWithReverse` function for setting address for the domain and make this domain reverse. Add recursive option if the domain doesn't exist:\n\n```ts\nawait ens.setAddressWithReverse('vlad.ethworks.tld', wallet, {recursive: true});\n```\n","engines":{"node":">=10.0"},"gitHead":"e7299db6b37b027b6aeafdacb75f45c632898674","license":"MIT","private":false,"scripts":{"lint":"eslint '{src,test}/**/*.ts'","test":"mocha","build":"rimraf ./dist && yarn build:esm && yarn build:cjs","lint:fix":"eslint --fix '{src,test}/**/*.ts'","build:cjs":"tsc -p tsconfig.build.json --outDir dist/cjs --declaration false","build:esm":"tsc -p tsconfig.build.json --outDir dist/esm --module ES6"},"_npmUser":{"name":"ethworks","email":"account@ethworks.io"},"homepage":"https://github.com/EthWorks/Waffle","keywords":["ethereum","smart-contracts","solidity","testing","javascript","typescript","library","ens"],"repository":{"url":"git+ssh://git@github.com/EthWorks/Waffle.git","type":"git"},"_npmVersion":"8.5.0","description":"A mock ens implementation for testing.","directories":{},"maintainers":[{"name":"ethworks","email":"account@ethworks.io"}],"_nodeVersion":"16.14.2","dependencies":{"ethers":"5.6.1","@ensdomains/ens":"^0.4.4","@ensdomains/resolver":"^0.2.4"},"publishConfig":{"tag":"alpha","access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ganache":"^7.0.3"},"_npmOperationalInternal":{"tmp":"tmp/ens_4.0.0-alpha.9_1649172502765_0.7116527684558211","host":"s3://npm-registry-packages"},"_id":"@ethereum-waffle/ens@4.0.0-alpha.9","version":"4.0.0-alpha.9"}