{"bugs":{"url":"https://github.com/EthWorks/Waffle/issues"},"dist":{"shasum":"25d3a09dd4fa961aa119c70a3278184789b710a6","tarball":"https://registry.npmjs.org/@ethereum-waffle/ens/-/ens-4.0.2-dev.dd21fb0.tgz","fileCount":39,"integrity":"sha512-stPIe7X6/RKhGGbN7GlVPiHXq72TTtA9DUNGTQGMd0dO+5ojne0Oyp/noYJoVJknGv8GMJQAMtP/cBEzJeC/JQ==","signatures":[{"sig":"MEYCIQCYxkgeoAA4KbZjssUmueApqYULfw5GMdG1G9cNXRAgOQIhAOSaW2D9sfLMaKKHg7tYwFb9Fj3Qn5iaCji+gbzaFTke","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\nwsFzBAEBCAAGBQJjJJeQACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrjcA//XhBu14H9Qxi9NKzdCKuKQolVlhU1h6W0KC5T6gm5wGdFO+bm\r\nasUKaJBiiYiEpsqKRqsDrhTe8jIEaSRdTFWBfMnv0P+fC7laIqkZz82GG6O0\r\n8XZsIs8/Dwuev+oIDaXIw9yz9nk9o/jx+7EU4OdTUzSgB73kFLtKRdWBezht\r\nnEH/StR+THYGkNBahWi281cA973KYcsXrHgF+GULDP35Lf35LO+izPQXX5TS\r\nqbdW5Xhj2uHT5vWvSxyzQdbpCGly2mg0bjnizH7mkyLhbkUuybXe1wfxDjau\r\nBKbCerYG+fTkTsL/w5HdN22rJm4S6FXZAgBW2Bs93nrWAGhWB+fLUs1ExyM8\r\nc72QlfFK8Br0RFKgQ4CkBk3rMVAovLH0XYnArIy9lCzQSld7UILJhus21VCc\r\n1+IvpsUaYzhs6J4F/5hQe6PcAZaihG6j90lVc3z0tt0VxZzffqFKDad7JtCj\r\nXL0X4kFxkL016xUJpnQmBkA0rlApeQMNISywYLtKQFK0SkFcxif9EO/XoksP\r\nLiQ5C6SE1MxHc1KJxAPHRX7+pOdt+LUbeLhssM5VVET2QEdu/VNTHaThV5Lj\r\nrJjKwb6dWxWFIZ2bQgAJ+9HFzXsxXYKXFtQl+dTFlEyZC7u+R7PmNaiNthBc\r\nxatNQTgnvM1Hfmq2OAhy8yNKOzMMGCkWRkA=\r\n=93n8\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.dd21fb0.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/d7fb424b5b08dfd3c30c3b301df0c45b/ethereum-waffle-ens-4.0.2-dev.dd21fb0.tgz","_integrity":"sha512-stPIe7X6/RKhGGbN7GlVPiHXq72TTtA9DUNGTQGMd0dO+5ojne0Oyp/noYJoVJknGv8GMJQAMtP/cBEzJeC/JQ==","repository":{"url":"git+ssh://git@github.com/EthWorks/Waffle.git","type":"git"},"_npmVersion":"8.15.0","description":"A mock ens implementation for testing.","directories":{},"maintainers":[{"name":"ethworks","email":"code@trusttoken.com"}],"_nodeVersion":"16.17.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.dd21fb0_1663342480389_0.6098270018653624","host":"s3://npm-registry-packages"},"_id":"@ethereum-waffle/ens@4.0.2-dev.dd21fb0","version":"4.0.2-dev.dd21fb0"}