{"bugs":{"url":"https://github.com/EthWorks/Waffle/issues"},"dist":{"shasum":"ba35fc8ed053d1c4328cffad9b78a8b8485cea0e","tarball":"https://registry.npmjs.org/@ethereum-waffle/ens/-/ens-4.0.0-alpha.11.tgz","fileCount":29,"integrity":"sha512-XaeBQt2MrhWaYObtfBhtABrp0Y0zu3rJZEE+HiLDKSt3iorlh4x7FOy4/B6UnbKRsDkwXHLF4UJLsnvEfYrdCA==","signatures":[{"sig":"MEYCIQDPUMxn+swpyYTInd2FFYQrEQwg1If+TcWMOEGJTyr4JgIhAPx/tpVqH1JQIC0v1FSMNfbTPWJmddaEpsTtZj32vMq7","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":43290,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiUDcHACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr8rQ/+P4Ce5+YwZebouiARE22vNJEf/RFxNYSq4tCosk8Mc2p4el+I\r\n1obrlB0G2e7comPsrAlgdcZ1monYqwsCV/lrCwXRZH299HJ2UzT7gJT+Zpwe\r\nNV3YJs6iSMXEJQNf/KN3oWEBqGCMoqZyfyg0eyfM7Z3HuwQca4ebXamt33jb\r\n9GBhtSvfLQFBrgMFfw/i4wa2F7xZjSQH4RONJfUg5ONHA3phogUEQPkaWWlm\r\nNHwpDnC/QSUnAViQERaFAMxqH3NAkk80XMI+SiXRUwBCzeMZTfqg46N2GyFT\r\nIlRIZf4r7PQAr9LHY87dGqUpvtELvN1Qw9dMeNVCW5A6+zWIZq7/N76y7z3i\r\nGPiBl4wJSMjZ2BnGVXWQsAq3FXbp3FoeByjhEgd4oCpHTsQJPFxBsD530+6u\r\nOH0hbIsIUI+76FHjURCF02+8cjglJuvQFydrrVKHpgOwMASotkOUE+Hmub9o\r\nx1AIMpO9+KUoKt8TKybZi6TDInqXcTIjhCcjfaaWKqYmKqCPYGSAhjfirPBP\r\n7kj/KqMN9Ht/7r1/HyEJW5UzvBj9WbsZcAR52liY6o3pL4E5IIYxNGtH1nNG\r\nRmCLF3mXQZV7GAwPzQcRVJBgwPnDj5AZgZQZiRAc/8XPmGofT3qPD3vtmPOa\r\nTyDjEDowP6h2qpdabFdr1vxRsyg1SQGfzM8=\r\n=TUuK\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":"ed044d59f258f45fa3e155fe6f9b271ce9d39de1","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.11_1649424135242_0.6262186370701248","host":"s3://npm-registry-packages"},"_id":"@ethereum-waffle/ens@4.0.0-alpha.11","version":"4.0.0-alpha.11"}