{"bugs":{"url":"https://github.com/EthWorks/Waffle/issues"},"dist":{"shasum":"1609cb350d1a3e32963d0ae1334a8fe02231b8cd","tarball":"https://registry.npmjs.org/@ethereum-waffle/ens/-/ens-4.0.0-dev.498bffb.tgz","fileCount":20,"integrity":"sha512-xIfTxExWrwQs20YPwRoNFviDlp9QjfiQ8NWIdcF6kYU9053HLaj7ESULxvhEcdexKsSAixhZ30BXUHrpQgV34g==","signatures":[{"sig":"MEQCICmgNT+sYWDbxNHFXpJXSDFv9MZT6Ba5ks7PGMzBxU6tAiAFqN8BjvJWs7be71i/tUL/zkZWwYYteiRySWPJ2C1nKQ==","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\nwsFzBAEBCAAGBQJiaVOPACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpmDA//ZKN/p0A5x9BSeUwngX49qFnD6GavGkuL3mP3dkP5neW6m/ql\r\nuISw9EI2cTux62JxKBy9wN1OqMMlStUESsKCs87zBNnYVTonGk/NnHHslivr\r\nSoe91gGbHT+Mfu9WJsqeHZ5QcqcnSKpgSMFcBA+OeoZLEGeEYdNn1CMk+STX\r\n0O3KOF7WRtEIXRsGM/CT97KuCFw1+7c8B0dETsxfGmVJR4SK4BhBqgWWFkoa\r\n1ojHyXDvyeHsiQYBFSZiLhhsxoUfXuDw1BrYhn9jpkNjBqdMhFv/pRGNNuJ5\r\nikiCG1xwYeHfEwdepr9I3FAmsmqz4c+gvW7IKugI8UeclrPovM3OJKYYf6z7\r\nA1QWVglnfalIgZqBSTG60DWh2IvuYEW8sR9aCPYn+jjmCAM/HK7pI2B4BXn5\r\nkjS7Igt1NfRHz8vWPFsKbdEFYNqz1a7AjOMm8Sc0F6HONlNK6VAwUqujDNXQ\r\nKK0aBmv5n1DsKW7Yjk4L6Yacoq3iyAqVddEkJMcbBkWyrxCsmzuYo+7gAki0\r\nalHDmJlHCSIouRjgiL97EVi3lNbx3TvK0i4N8VNytAbXMJElgBXqxBvuyhvn\r\nR7P9fNyalJ8vINcYwgYLlAyBOR8IF3Rz8T0j1OEFKNEv7JjMAfW5m+YX14vt\r\nvMhuZ0DiK+feaFQO6cUeZWyPyieZ61tg7ZA=\r\n=f6Rj\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.498bffb.tgz","types":"dist/esm/index.d.ts","author":"Marek Kirejczyk <account@ethworks.io> (http://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.498bffb.tgz","_integrity":"sha512-xIfTxExWrwQs20YPwRoNFviDlp9QjfiQ8NWIdcF6kYU9053HLaj7ESULxvhEcdexKsSAixhZ30BXUHrpQgV34g==","repository":"git@github.com:EthWorks/Waffle.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.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.498bffb_1651069839751_0.7632521132820174","host":"s3://npm-registry-packages"},"_id":"@ethereum-waffle/ens@4.0.0-dev.498bffb","version":"4.0.0-dev.498bffb"}