{"bugs":{"url":"https://github.com/EthWorks/Waffle/issues"},"dist":{"shasum":"d620b560e71333ce3a3e2e301938505e8d6672b9","tarball":"https://registry.npmjs.org/@ethereum-waffle/ens/-/ens-4.0.2-dev.71e4b73.tgz","fileCount":39,"integrity":"sha512-Vfbb057I6hZHD6Wbd44SfUC27Tl2gOeAObB0vwxrqqaAM0roqciF6GlfZAyMx2d+p3qsDWBCfwFnreUYyUmLig==","signatures":[{"sig":"MEYCIQDfDvRBhHO7LB715ICidRwSL/vwpmXwKFmDBKk8FGw15AIhAM/I8QweLSz6JYV6Y9TdADWWvDM5joUcY3AmLeZ/ZDa3","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":2302844,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi/2Z/ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpllw/9EEPceVEczQ1jBa9eB7goJ68+LTXPr3M7t8VMdALhZ4CSdz0h\r\nB3fJHf1r5tvigfu9aRzxgyfp3eBiMEciQODuaupf53szAMhHZkOxgSQ0GtkP\r\n2cKv0j8OmPdTL5gF8Eke4SJ7M8Cu2cw50YwKiOKpSAzeEimTocRjq7qlSPNo\r\n21ljPK/Kpi2XFmw6L1l8KuLpvZtEQxTvo9rbxDHG3MQnsmpfGnmfAcSzR+xl\r\nKIeCOkLmiHK3fdlgu6Wu4DklMjWX7xXW0vXi8stadSFF4eSV4YO1y9FD723N\r\nz9P5RZcB3JgbcOQNHrvRdSp8DYvFyjw2kdap5fATw8CoqXaWoHOPnNqRKw1G\r\n4bZOzU5Lx3NLA53Fyv7xPYmwkSfutWH/jorKW4vte/SbvqVCneTqm1IQ20IW\r\nCp1FMmtnerLVB5iDY9BxRd2H5IyKZ5uA8W8phcRkfYhwxHdHeaSJqI1ms/T3\r\ndM9o9rX6+xz1PQcv8GXS/b62sNFxEUdFzV70AIoqeTRj/vWe7JGYaKe6SPe2\r\nQZqo5Qr1kiPE0lbC6F9mKN8bi2LMsPVDT1nWf/Pd92kQ6gL7/twnd7HWFMrZ\r\n7pIkbUJEB4nnasQ0nX6nSlVegeva/zIp1fjiPqn9tYWvkB5G8r34cfZV9oqE\r\ndJnm8Us6+D+s40yfjWiGiTy6Sht4KE+R28c=\r\n=rtVM\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/cjs/index.js","name":"@ethereum-waffle/ens","_from":"file:ethereum-waffle-ens-4.0.2-dev.71e4b73.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 && pnpm build:artifacts && pnpm build:esm && pnpm 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","build:artifacts":"node build-artifacts.js"},"_npmUser":{"name":"ethworks","email":"code@trusttoken.com"},"homepage":"https://github.com/EthWorks/Waffle","keywords":["ethereum","smart-contracts","solidity","testing","javascript","typescript","library","ens"],"_resolved":"/tmp/e79e9f68b928116ea312b13f91124208/ethereum-waffle-ens-4.0.2-dev.71e4b73.tgz","_integrity":"sha512-Vfbb057I6hZHD6Wbd44SfUC27Tl2gOeAObB0vwxrqqaAM0roqciF6GlfZAyMx2d+p3qsDWBCfwFnreUYyUmLig==","repository":{"url":"git+ssh://git@github.com/EthWorks/Waffle.git","type":"git"},"_npmVersion":"8.11.0","description":"A mock ens implementation for testing.","directories":{},"maintainers":[{"name":"ethworks","email":"code@trusttoken.com"}],"_nodeVersion":"16.16.0","dependencies":{"ethers":"5.6.2"},"publishConfig":{"tag":"dev","access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"mocha":"^8.2.1","eslint":"^7.14.0","rimraf":"^3.0.2","ganache":"7.4.0","typescript":"^4.6.2","@ensdomains/ens":"^0.4.4","@ensdomains/resolver":"^0.2.4"},"_npmOperationalInternal":{"tmp":"tmp/ens_4.0.2-dev.71e4b73_1660905086928_0.9307046011030145","host":"s3://npm-registry-packages"},"_id":"@ethereum-waffle/ens@4.0.2-dev.71e4b73","version":"4.0.2-dev.71e4b73"}