@enscribe/hardhat-enscribe 0.1.1

package/README.md

@@ -0,0 +1,211 @@
+# hardhat-enscribe
+
+A Hardhat v3 plugin that enables you to assign ENS (Ethereum Name Service) names to your smart contracts, making them easily discoverable and human-readable.
+
+## What is hardhat-enscribe?
+
+hardhat-enscribe allows developers to automatically assign ENS names to their smart contracts during or after deployment. This plugin handles the complete ENS integration process, including:
+
+- **Subname Creation**: Creates ENS subnames for your contracts
+- **Forward Resolution**: Maps ENS names to contract addresses  
+- **Reverse Resolution**: Maps contract addresses back to ENS names
+- **Multi-chain Support**: Works across multiple networks including Ethereum, Sepolia, Linea, and more
+
+## Features
+
+- 🏷️ **Primary ENS Naming**: Assign human-readable names to your contracts
+- 🌐 **Multi-chain Support**: Works on Ethereum, Sepolia
+- 🔧 **Hardhat v3 Compatible**: Built specifically for Hardhat v3 with Viem integration
+- 🛡️ **Contract Type Detection**: Automatically detects Ownable and ReverseClaimer contracts
+- ⚡ **Transaction Optimization**: Waits for confirmations to prevent race conditions
+
+## Installation
+
+```bash
+npm install @enscribe/hardhat-enscribe
+```
+
+## Configuration
+
+Add the plugin to your `hardhat.config.ts`:
+
+```typescript
+import type { HardhatUserConfig } from "hardhat/config";
+import hardhatEnscribePlugin from "@enscribe/hardhat-enscribe";
+import hardhatToolboxViemPlugin from "@nomicfoundation/hardhat-toolbox-viem";
+
+const config: HardhatUserConfig = {
+  plugins: [hardhatToolboxViemPlugin, hardhatEnscribePlugin],
+  // ... rest of your config
+};
+
+export default config;
+```
+
+## Usage
+
+### Basic Command
+
+```bash
+npx hardhat enscribe name <ENS_NAME> --contract <CONTRACT_ADDRESS>
+```
+
+### Examples
+
+#### Name a contract on Sepolia
+```bash
+npx hardhat enscribe name mycontract.mydomain.eth --contract 0x1234...5678
+```
+
+#### Name a contract on Linea
+```bash
+npx hardhat enscribe name mycontract.mydomain.eth --contract 0x1234...5678 --chain linea
+```
+
+### Command Options
+
+- `name` (required): The ENS name to assign (e.g., `mycontract.mydomain.eth`)
+- `--contract` (required): The contract address to name
+- `--chain` (optional): The network/chain to use (defaults to `sepolia`)
+
+## Supported Networks
+
+The plugin supports the following networks:
+
+- **Ethereum Mainnet** (`mainnet`)
+- **Sepolia Testnet** (`sepolia`) - Default
+- **Linea Mainnet** (`linea`)
+- **Linea Sepolia** (`linea-sepolia`)
+
+## Contract Requirements
+
+Your contract must implement one of the following patterns:
+
+### 1. Ownable Pattern
+Contracts that implement the `owner()` function (like OpenZeppelin's Ownable):
+
+```solidity
+contract MyContract {
+    address public owner;
+    
+    function owner() public view returns (address) {
+        return owner;
+    }
+}
+```
+
+### 2. ReverseClaimer Pattern
+Contracts that have reverse ENS resolution already set up.
+
+## How It Works
+
+1. **Subname Creation**: Creates an ENS subname record if it doesn't exist
+2. **Forward Resolution**: Maps the ENS name to your contract address
+3. **Reverse Resolution**: Maps your contract address back to the ENS name
+4. **Confirmation**: Waits for all transactions to be confirmed before proceeding
+
+## Example Workflow
+
+```bash
+# 1. Deploy your contract
+npx hardhat run scripts/deploy.ts --network sepolia
+
+# 2. Name your contract
+npx hardhat enscribe name myawesomecontract.mydomain.eth --contract 0x1234567890123456789012345678901234567890
+
+# 3. Your contract is now discoverable at:
+# https://app.enscribe.xyz/explore/11155111/myawesomecontract.mydomain.eth
+```
+
+## Environment Setup
+
+### Required Environment Variables
+
+For testnets like Sepolia, you'll need:
+
+```bash
+# Set your private key (use hardhat-keystore for security)
+npx hardhat keystore set SEPOLIA_PRIVATE_KEY
+
+# Or set as environment variable
+export SEPOLIA_PRIVATE_KEY="your_private_key_here"
+```
+
+### Network Configuration
+
+Ensure your `hardhat.config.ts` includes the networks you want to use:
+
+```typescript
+networks: {
+  sepolia: {
+    type: "http",
+    chainType: "l1", 
+    url: configVariable("SEPOLIA_RPC_URL"),
+    accounts: [configVariable("SEPOLIA_PRIVATE_KEY")],
+  },
+  linea: {
+    type: "http",
+    chainType: "l2",
+    url: configVariable("LINEA_RPC_URL"), 
+    accounts: [configVariable("LINEA_PRIVATE_KEY")],
+  },
+}
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**"Contract does not implement required interface"**
+- Ensure your contract implements either `owner()` function or reverse ENS resolution
+- Check that the contract address is correct and deployed
+
+**"Insufficient funds"**
+- Ensure your account has enough ETH to pay for ENS transactions
+- Gas fees vary by network and ENS operation complexity
+
+## Development
+
+### Building
+
+```bash
+npm run build
+```
+
+### Testing
+
+```bash
+# Run all tests
+npm test
+
+# Run specific test suites
+npm run test:unit
+npm run test:integration
+npm run test:hardhat
+```
+
+### Linting
+
+```bash
+npm run lint
+npm run format
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT
+
+## Links
+
+- [GitHub Repository](https://github.com/enscribexyz/hardhat-enscribe)
+- [Enscribe](https://app.enscribe.xyz)
+- [Hardhat Documentation](https://hardhat.org/docs)
+- [ENS Documentation](https://docs.ens.domains/)
+
+## Support
+
+For support, please open an issue on GitHub or visit [app.enscribe.xyz](https://app.enscribe.xyz).

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+import "./internal/type-extensions";
+import type { HardhatPlugin } from "hardhat/types/plugins";
+declare const plugin: HardhatPlugin;
+export default plugin;

package/dist/src/index.js

@@ -0,0 +1,33 @@
+import "./internal/type-extensions";
+import { PLUGIN_ID } from "./internal/constants.js";
+import { emptyTask, task } from "hardhat/config";
+import { ArgumentType } from "hardhat/types/arguments";
+const plugin = {
+    id: PLUGIN_ID,
+    dependencies: () => [],
+    tasks: [
+        emptyTask("enscribe", "Set ENS primary names for smart contracts.").build(),
+        task(["enscribe", "name"])
+            .addPositionalArgument({
+            name: "name",
+            type: ArgumentType.STRING,
+        })
+            .addOption({
+            name: "contract",
+            type: ArgumentType.STRING_WITHOUT_DEFAULT,
+            description: "Contract address for which the primary name is to be set.",
+            defaultValue: undefined,
+        })
+            .addOption({
+            name: "chain",
+            type: ArgumentType.STRING_WITHOUT_DEFAULT,
+            description: "Chain on which the address is to be named.",
+            defaultValue: undefined,
+        })
+            .setAction(() => import("./internal/tasks/name.js"))
+            .build(),
+    ],
+    hookHandlers: {},
+    globalOptions: [],
+};
+export default plugin;

package/dist/src/internal/abi/ENSRegistry.d.ts

@@ -0,0 +1,36 @@
+declare const ensRegistryABI: ({
+    inputs: never[];
+    stateMutability: string;
+    type: string;
+    anonymous?: undefined;
+    name?: undefined;
+    outputs?: undefined;
+} | {
+    anonymous: boolean;
+    inputs: {
+        indexed: boolean;
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    type: string;
+    stateMutability?: undefined;
+    outputs?: undefined;
+} | {
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+    anonymous?: undefined;
+})[];
+export default ensRegistryABI;

package/dist/src/internal/abi/ENSRegistry.js

@@ -0,0 +1,377 @@
+const ensRegistryABI = [
+    {
+        inputs: [],
+        stateMutability: "nonpayable",
+        type: "constructor",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                internalType: "address",
+                name: "owner",
+                type: "address",
+            },
+            {
+                indexed: true,
+                internalType: "address",
+                name: "operator",
+                type: "address",
+            },
+            {
+                indexed: false,
+                internalType: "bool",
+                name: "approved",
+                type: "bool",
+            },
+        ],
+        name: "ApprovalForAll",
+        type: "event",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+            {
+                indexed: true,
+                internalType: "bytes32",
+                name: "label",
+                type: "bytes32",
+            },
+            {
+                indexed: false,
+                internalType: "address",
+                name: "owner",
+                type: "address",
+            },
+        ],
+        name: "NewOwner",
+        type: "event",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+            {
+                indexed: false,
+                internalType: "address",
+                name: "resolver",
+                type: "address",
+            },
+        ],
+        name: "NewResolver",
+        type: "event",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+            {
+                indexed: false,
+                internalType: "uint64",
+                name: "ttl",
+                type: "uint64",
+            },
+        ],
+        name: "NewTTL",
+        type: "event",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+            {
+                indexed: false,
+                internalType: "address",
+                name: "owner",
+                type: "address",
+            },
+        ],
+        name: "Transfer",
+        type: "event",
+    },
+    {
+        inputs: [
+            {
+                internalType: "address",
+                name: "owner",
+                type: "address",
+            },
+            {
+                internalType: "address",
+                name: "operator",
+                type: "address",
+            },
+        ],
+        name: "isApprovedForAll",
+        outputs: [
+            {
+                internalType: "bool",
+                name: "",
+                type: "bool",
+            },
+        ],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [
+            {
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+        ],
+        name: "owner",
+        outputs: [
+            {
+                internalType: "address",
+                name: "",
+                type: "address",
+            },
+        ],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [
+            {
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+        ],
+        name: "recordExists",
+        outputs: [
+            {
+                internalType: "bool",
+                name: "",
+                type: "bool",
+            },
+        ],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [
+            {
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+        ],
+        name: "resolver",
+        outputs: [
+            {
+                internalType: "address",
+                name: "",
+                type: "address",
+            },
+        ],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [
+            {
+                internalType: "address",
+                name: "operator",
+                type: "address",
+            },
+            {
+                internalType: "bool",
+                name: "approved",
+                type: "bool",
+            },
+        ],
+        name: "setApprovalForAll",
+        outputs: [],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        inputs: [
+            {
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+            {
+                internalType: "address",
+                name: "owner",
+                type: "address",
+            },
+        ],
+        name: "setOwner",
+        outputs: [],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        inputs: [
+            {
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+            {
+                internalType: "address",
+                name: "owner",
+                type: "address",
+            },
+            {
+                internalType: "address",
+                name: "resolver",
+                type: "address",
+            },
+            {
+                internalType: "uint64",
+                name: "ttl",
+                type: "uint64",
+            },
+        ],
+        name: "setRecord",
+        outputs: [],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        inputs: [
+            {
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+            {
+                internalType: "address",
+                name: "resolver",
+                type: "address",
+            },
+        ],
+        name: "setResolver",
+        outputs: [],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        inputs: [
+            {
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+            {
+                internalType: "bytes32",
+                name: "label",
+                type: "bytes32",
+            },
+            {
+                internalType: "address",
+                name: "owner",
+                type: "address",
+            },
+        ],
+        name: "setSubnodeOwner",
+        outputs: [
+            {
+                internalType: "bytes32",
+                name: "",
+                type: "bytes32",
+            },
+        ],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        inputs: [
+            {
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+            {
+                internalType: "bytes32",
+                name: "label",
+                type: "bytes32",
+            },
+            {
+                internalType: "address",
+                name: "owner",
+                type: "address",
+            },
+            {
+                internalType: "address",
+                name: "resolver",
+                type: "address",
+            },
+            {
+                internalType: "uint64",
+                name: "ttl",
+                type: "uint64",
+            },
+        ],
+        name: "setSubnodeRecord",
+        outputs: [],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        inputs: [
+            {
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+            {
+                internalType: "uint64",
+                name: "ttl",
+                type: "uint64",
+            },
+        ],
+        name: "setTTL",
+        outputs: [],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        inputs: [
+            {
+                internalType: "bytes32",
+                name: "node",
+                type: "bytes32",
+            },
+        ],
+        name: "ttl",
+        outputs: [
+            {
+                internalType: "uint64",
+                name: "",
+                type: "uint64",
+            },
+        ],
+        stateMutability: "view",
+        type: "function",
+    },
+];
+export default ensRegistryABI;

package/dist/src/internal/abi/NameWrapper.d.ts

@@ -0,0 +1,51 @@
+declare const nameWrapperABI: ({
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+    name?: undefined;
+    anonymous?: undefined;
+    outputs?: undefined;
+} | {
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    type: string;
+    stateMutability?: undefined;
+    anonymous?: undefined;
+    outputs?: undefined;
+} | {
+    anonymous: boolean;
+    inputs: {
+        indexed: boolean;
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    type: string;
+    stateMutability?: undefined;
+    outputs?: undefined;
+} | {
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+    anonymous?: undefined;
+})[];
+export default nameWrapperABI;