{"bugs":{"url":"https://github.com/EthWorks/Waffle/issues"},"dist":{"shasum":"71809e70d4d517abaf290001ca2f4557e798da3c","tarball":"https://registry.npmjs.org/@ethereum-waffle/ens/-/ens-4.0.0-dev.ba7033f.tgz","fileCount":20,"integrity":"sha512-4ajoKr4ZNVzQL68uWtj2WdjhDSeFNU59WdP5sJJMTE7kJIPWYPdc4wUX+NIrJXdZ/FSEZ5xyAUFaJVT4AI+EvA==","signatures":[{"sig":"MEYCIQCIDI12RBM0Gtia1WSOP6VSYBI+w+dM0SgFhyTG2uRl7gIhAJfUoA7bDy88+Tz5jsaKpeoy7NgGxpdgZQEOeqi/uvWa","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":30493,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJidOgZACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoTkBAAhejkq/FXJRuP7jUKCaEWbVVzuTvsfxYSPHuuCHScXgbITJqv\r\n0ng8NYtwZAtMC89tyukInWdhZIzBcc/eQAL7rpSjxaZ14xpTcnLD6DdZfGI0\r\ni6dsyHJN9oD4506tk31Q0aX1bwWlAKqbTz3ZrjkLr3cjfT9vCiTPpy/EEeYZ\r\nc2MijFPYXyT9g22uEjz95wJ+3pNxISGcP8PS3sJxi4ISDK4qmLPm6ClLqc5Z\r\nHcrZ1/Za5k179DUGCRUSPNJjtoz3Td5/8y0DC9MGgI/H747YMX/SF0uUpNZO\r\nrrboBay8Qxt6Oadt33NGJ9jKRMz5YDuuhk685PWkkDlmz0yqYHYPsrg99MlN\r\nbGilthLf3iQf/8Ag2DsuSeyjOnzGq1vJJyBb7WSwhQ9FcEa6BwMy+xAS/Bmo\r\n0YaTPNHLg5/F+q1v32+GMzSNMeRJCX47aFessA4N2T5KOqzfZHE+5eqkjXxT\r\n/G4tprd6B1EO8Eo8TyCz2VQSTfYEH0Zd4YUhr1sG6T65OWSjSiFDFFcYPgBi\r\nDwAZ9okChvnixa8A/4wXlUoEn6GhxLMPClM6U1g3oJwQo8VD146Gkfm+Brfw\r\nYip9R8vyYSZVNQ7O6TDFGoqh8yzb/tB4us9Nre2mE88cQFHVMRfKVTMHWiQM\r\nIwxdGmWlZt3yCU44C4tng0n3zPIfTF3NRFg=\r\n=+SfD\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/cjs/index.js","name":"@ethereum-waffle/ens","_from":"file:ethereum-waffle-ens-4.0.0-dev.ba7033f.tgz","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"},"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"],"_resolved":"/home/runner/work/Waffle/Waffle/waffle-ens/ethereum-waffle-ens-4.0.0-dev.ba7033f.tgz","_integrity":"sha512-4ajoKr4ZNVzQL68uWtj2WdjhDSeFNU59WdP5sJJMTE7kJIPWYPdc4wUX+NIrJXdZ/FSEZ5xyAUFaJVT4AI+EvA==","repository":{"url":"git+ssh://git@github.com/EthWorks/Waffle.git","type":"git"},"_npmVersion":"8.5.5","description":"A mock ens implementation for testing.","directories":{},"maintainers":[{"name":"ethworks","email":"account@ethworks.io"}],"_nodeVersion":"16.15.0","dependencies":{"ethers":"5.6.2","@ensdomains/ens":"^0.4.4","@ensdomains/resolver":"^0.2.4"},"publishConfig":{"tag":"dev","access":"public"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^8.2.1","eslint":"^7.14.0","rimraf":"^3.0.2","ganache":"^7.0.3","typescript":"^4.6.2"},"_npmOperationalInternal":{"tmp":"tmp/ens_4.0.0-dev.ba7033f_1651828760988_0.7990163316144943","host":"s3://npm-registry-packages"},"_id":"@ethereum-waffle/ens@4.0.0-dev.ba7033f","version":"4.0.0-dev.ba7033f"}