hooddomains 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,184 @@
+import * as viem from 'viem';
+import { PublicClient, WalletClient, Hex, Address } from 'viem';
+
+declare const CHAIN_ID = 4663;
+/** Robinhood Chain (Arbitrum Orbit L2). RPC is supplied by the caller. */
+declare const robinhoodChain: {
+    blockExplorers?: {
+        [key: string]: {
+            name: string;
+            url: string;
+            apiUrl?: string | undefined;
+        };
+        default: {
+            name: string;
+            url: string;
+            apiUrl?: string | undefined;
+        };
+    } | undefined | undefined;
+    blockTime?: number | undefined | undefined;
+    contracts?: {
+        [x: string]: viem.ChainContract | {
+            [sourceId: number]: viem.ChainContract | undefined;
+        } | undefined;
+        ensRegistry?: viem.ChainContract | undefined;
+        ensUniversalResolver?: viem.ChainContract | undefined;
+        multicall3?: viem.ChainContract | undefined;
+        erc6492Verifier?: viem.ChainContract | undefined;
+    } | undefined;
+    ensTlds?: readonly string[] | undefined;
+    id: 4663;
+    name: "Robinhood Chain";
+    nativeCurrency: {
+        readonly name: "Ether";
+        readonly symbol: "ETH";
+        readonly decimals: 18;
+    };
+    experimental_preconfirmationTime?: number | undefined | undefined;
+    rpcUrls: {
+        readonly default: {
+            readonly http: readonly [];
+        };
+    };
+    sourceId?: number | undefined | undefined;
+    testnet?: boolean | undefined | undefined;
+    custom?: Record<string, unknown> | undefined;
+    extendSchema?: Record<string, unknown> | undefined;
+    fees?: viem.ChainFees<undefined> | undefined;
+    formatters?: undefined;
+    prepareTransactionRequest?: ((args: viem.PrepareTransactionRequestParameters, options: {
+        client: viem.Client;
+        phase: "beforeFillTransaction" | "beforeFillParameters" | "afterFillParameters";
+    }) => Promise<viem.PrepareTransactionRequestParameters>) | [fn: ((args: viem.PrepareTransactionRequestParameters, options: {
+        client: viem.Client;
+        phase: "beforeFillTransaction" | "beforeFillParameters" | "afterFillParameters";
+    }) => Promise<viem.PrepareTransactionRequestParameters>) | undefined, options: {
+        runAt: readonly ("beforeFillTransaction" | "beforeFillParameters" | "afterFillParameters")[];
+    }] | undefined;
+    serializers?: viem.ChainSerializers<undefined, viem.TransactionSerializable> | undefined;
+    verifyHash?: ((client: viem.Client, parameters: viem.VerifyHashActionParameters) => Promise<viem.VerifyHashActionReturnType>) | undefined;
+};
+interface HoodContracts {
+    registry: `0x${string}`;
+    registrar: `0x${string}`;
+    oracle: `0x${string}`;
+    reverseRegistrar: `0x${string}`;
+    resolverImpl: `0x${string}`;
+    verifiableFactory: `0x${string}`;
+}
+/** Live Hood Domains deployment on Robinhood Chain (hood-robinhood-v2). */
+declare const DEFAULT_CONTRACTS: HoodContracts;
+/** Roles granted to a per-owner resolver at deploy: ADDR + TEXT (regular + admin). */
+declare const RESOLVER_RECORD_ROLES: bigint;
+/** Block the registry was deployed at — lower bound for TextChanged log scans. */
+declare const REGISTRY_DEPLOY_BLOCK = 5785243n;
+declare const SECONDS_PER_YEAR = 31536000n;
+/** Common text-record keys probed in addition to keys discovered from events. */
+declare const TEXT_KEYS: string[];
+
+/**
+ * Hood Domains SDK — resolve, look up, and register `.hood` names on Robinhood Chain.
+ * Everything is on-chain; this is a thin wrapper over viem. No backend, no API keys.
+ *
+ *   Website: https://www.hood.domains
+ *   App:     https://app.hood.domains
+ *   Docs:    https://app.hood.domains/docs
+ *   X:       https://x.com/hooddomains  (@hooddomains)
+ */
+
+interface HoodOptions {
+    /** RPC URL for Robinhood Chain (chainId 4663). Ignored if `publicClient` is given. */
+    rpcUrl?: string;
+    /** Bring your own read client. */
+    publicClient?: PublicClient;
+    /** Bring your own signer (with account + chain configured) for writes. */
+    walletClient?: WalletClient;
+    /** Or a private key to sign writes. */
+    privateKey?: Hex | string;
+    /** Override contract addresses. */
+    contracts?: Partial<HoodContracts>;
+    /** Lower bound for TextChanged log scans (defaults to the registry deploy block). */
+    deployBlock?: bigint;
+}
+interface NameRecords {
+    /** The wallet the name resolves to (its addr record), or null. */
+    address: Address | null;
+    /** Text records: key -> value (only non-empty). */
+    records: Record<string, string>;
+    /** The name's resolver, or null if none set. */
+    resolver: Address | null;
+}
+interface NameInfo {
+    name: string;
+    registered: boolean;
+    owner: Address | null;
+    expiry: Date | null;
+    resolver: Address | null;
+    tokenId: string;
+}
+interface RegisterResult {
+    name: string;
+    owner: Address;
+    years: number;
+    paid: {
+        wei: bigint;
+        eth: string;
+    };
+    tokenId: string;
+    commitTx: Hex;
+    registerTx: Hex;
+}
+/**
+ * Client for Hood Domains (.hood names on Robinhood Chain). Read methods need only an RPC;
+ * write methods need a signer (pass `privateKey` or `walletClient`).
+ *
+ * @example
+ * const hood = new Hood({ rpcUrl });
+ * await hood.resolve("alice.hood");   // -> 0x… | null
+ * await hood.reverse("0x…");          // -> "alice.hood" | null
+ */
+declare class Hood {
+    readonly publicClient: PublicClient;
+    readonly walletClient?: WalletClient;
+    readonly contracts: HoodContracts;
+    readonly deployBlock: bigint;
+    private readonly acct?;
+    constructor(opts?: HoodOptions);
+    private signer;
+    private accountAddress;
+    private node;
+    private labelId;
+    private resolverOf;
+    /** Resolve a name to the wallet it points at (forward resolution). */
+    resolve(name: string): Promise<Address | null>;
+    /** Get the primary (reverse) name of a wallet. */
+    reverse(address: Address): Promise<string | null>;
+    /** Read a single text record. */
+    text(name: string, key: string): Promise<string | null>;
+    /** Read a name's address + all text records (custom keys discovered via TextChanged events). */
+    records(name: string): Promise<NameRecords>;
+    /** Whether a label is available to register. */
+    available(label: string): Promise<boolean>;
+    /** Registration price for a label over `years`. */
+    price(label: string, years?: number): Promise<{
+        wei: bigint;
+        eth: string;
+    }>;
+    /** Owner, expiry, resolver, and tokenId of a name. */
+    nameInfo(name: string): Promise<NameInfo>;
+    /** Register a name via commit → wait (~60s) → register. Paid in native ETH. */
+    register(label: string, opts?: {
+        years?: number;
+        owner?: Address;
+    }): Promise<RegisterResult>;
+    /** Set the caller's primary (reverse) name. */
+    setPrimary(name: string): Promise<Hex>;
+    /** Set the address record (deploys a per-owner resolver on first use). */
+    setAddr(name: string, address: Address): Promise<Hex>;
+    /** Set a text record (deploys a per-owner resolver on first use). */
+    setText(name: string, key: string, value: string): Promise<Hex>;
+    /** Return the name's resolver, deploying + linking a per-owner one (addr+text roles) if needed. */
+    ensureResolver(name: string): Promise<Address>;
+}
+
+export { CHAIN_ID, DEFAULT_CONTRACTS, Hood, type HoodContracts, type HoodOptions, type NameInfo, type NameRecords, REGISTRY_DEPLOY_BLOCK, RESOLVER_RECORD_ROLES, type RegisterResult, SECONDS_PER_YEAR, TEXT_KEYS, robinhoodChain };

package/dist/index.d.ts

@@ -0,0 +1,184 @@
+import * as viem from 'viem';
+import { PublicClient, WalletClient, Hex, Address } from 'viem';
+
+declare const CHAIN_ID = 4663;
+/** Robinhood Chain (Arbitrum Orbit L2). RPC is supplied by the caller. */
+declare const robinhoodChain: {
+    blockExplorers?: {
+        [key: string]: {
+            name: string;
+            url: string;
+            apiUrl?: string | undefined;
+        };
+        default: {
+            name: string;
+            url: string;
+            apiUrl?: string | undefined;
+        };
+    } | undefined | undefined;
+    blockTime?: number | undefined | undefined;
+    contracts?: {
+        [x: string]: viem.ChainContract | {
+            [sourceId: number]: viem.ChainContract | undefined;
+        } | undefined;
+        ensRegistry?: viem.ChainContract | undefined;
+        ensUniversalResolver?: viem.ChainContract | undefined;
+        multicall3?: viem.ChainContract | undefined;
+        erc6492Verifier?: viem.ChainContract | undefined;
+    } | undefined;
+    ensTlds?: readonly string[] | undefined;
+    id: 4663;
+    name: "Robinhood Chain";
+    nativeCurrency: {
+        readonly name: "Ether";
+        readonly symbol: "ETH";
+        readonly decimals: 18;
+    };
+    experimental_preconfirmationTime?: number | undefined | undefined;
+    rpcUrls: {
+        readonly default: {
+            readonly http: readonly [];
+        };
+    };
+    sourceId?: number | undefined | undefined;
+    testnet?: boolean | undefined | undefined;
+    custom?: Record<string, unknown> | undefined;
+    extendSchema?: Record<string, unknown> | undefined;
+    fees?: viem.ChainFees<undefined> | undefined;
+    formatters?: undefined;
+    prepareTransactionRequest?: ((args: viem.PrepareTransactionRequestParameters, options: {
+        client: viem.Client;
+        phase: "beforeFillTransaction" | "beforeFillParameters" | "afterFillParameters";
+    }) => Promise<viem.PrepareTransactionRequestParameters>) | [fn: ((args: viem.PrepareTransactionRequestParameters, options: {
+        client: viem.Client;
+        phase: "beforeFillTransaction" | "beforeFillParameters" | "afterFillParameters";
+    }) => Promise<viem.PrepareTransactionRequestParameters>) | undefined, options: {
+        runAt: readonly ("beforeFillTransaction" | "beforeFillParameters" | "afterFillParameters")[];
+    }] | undefined;
+    serializers?: viem.ChainSerializers<undefined, viem.TransactionSerializable> | undefined;
+    verifyHash?: ((client: viem.Client, parameters: viem.VerifyHashActionParameters) => Promise<viem.VerifyHashActionReturnType>) | undefined;
+};
+interface HoodContracts {
+    registry: `0x${string}`;
+    registrar: `0x${string}`;
+    oracle: `0x${string}`;
+    reverseRegistrar: `0x${string}`;
+    resolverImpl: `0x${string}`;
+    verifiableFactory: `0x${string}`;
+}
+/** Live Hood Domains deployment on Robinhood Chain (hood-robinhood-v2). */
+declare const DEFAULT_CONTRACTS: HoodContracts;
+/** Roles granted to a per-owner resolver at deploy: ADDR + TEXT (regular + admin). */
+declare const RESOLVER_RECORD_ROLES: bigint;
+/** Block the registry was deployed at — lower bound for TextChanged log scans. */
+declare const REGISTRY_DEPLOY_BLOCK = 5785243n;
+declare const SECONDS_PER_YEAR = 31536000n;
+/** Common text-record keys probed in addition to keys discovered from events. */
+declare const TEXT_KEYS: string[];
+
+/**
+ * Hood Domains SDK — resolve, look up, and register `.hood` names on Robinhood Chain.
+ * Everything is on-chain; this is a thin wrapper over viem. No backend, no API keys.
+ *
+ *   Website: https://www.hood.domains
+ *   App:     https://app.hood.domains
+ *   Docs:    https://app.hood.domains/docs
+ *   X:       https://x.com/hooddomains  (@hooddomains)
+ */
+
+interface HoodOptions {
+    /** RPC URL for Robinhood Chain (chainId 4663). Ignored if `publicClient` is given. */
+    rpcUrl?: string;
+    /** Bring your own read client. */
+    publicClient?: PublicClient;
+    /** Bring your own signer (with account + chain configured) for writes. */
+    walletClient?: WalletClient;
+    /** Or a private key to sign writes. */
+    privateKey?: Hex | string;
+    /** Override contract addresses. */
+    contracts?: Partial<HoodContracts>;
+    /** Lower bound for TextChanged log scans (defaults to the registry deploy block). */
+    deployBlock?: bigint;
+}
+interface NameRecords {
+    /** The wallet the name resolves to (its addr record), or null. */
+    address: Address | null;
+    /** Text records: key -> value (only non-empty). */
+    records: Record<string, string>;
+    /** The name's resolver, or null if none set. */
+    resolver: Address | null;
+}
+interface NameInfo {
+    name: string;
+    registered: boolean;
+    owner: Address | null;
+    expiry: Date | null;
+    resolver: Address | null;
+    tokenId: string;
+}
+interface RegisterResult {
+    name: string;
+    owner: Address;
+    years: number;
+    paid: {
+        wei: bigint;
+        eth: string;
+    };
+    tokenId: string;
+    commitTx: Hex;
+    registerTx: Hex;
+}
+/**
+ * Client for Hood Domains (.hood names on Robinhood Chain). Read methods need only an RPC;
+ * write methods need a signer (pass `privateKey` or `walletClient`).
+ *
+ * @example
+ * const hood = new Hood({ rpcUrl });
+ * await hood.resolve("alice.hood");   // -> 0x… | null
+ * await hood.reverse("0x…");          // -> "alice.hood" | null
+ */
+declare class Hood {
+    readonly publicClient: PublicClient;
+    readonly walletClient?: WalletClient;
+    readonly contracts: HoodContracts;
+    readonly deployBlock: bigint;
+    private readonly acct?;
+    constructor(opts?: HoodOptions);
+    private signer;
+    private accountAddress;
+    private node;
+    private labelId;
+    private resolverOf;
+    /** Resolve a name to the wallet it points at (forward resolution). */
+    resolve(name: string): Promise<Address | null>;
+    /** Get the primary (reverse) name of a wallet. */
+    reverse(address: Address): Promise<string | null>;
+    /** Read a single text record. */
+    text(name: string, key: string): Promise<string | null>;
+    /** Read a name's address + all text records (custom keys discovered via TextChanged events). */
+    records(name: string): Promise<NameRecords>;
+    /** Whether a label is available to register. */
+    available(label: string): Promise<boolean>;
+    /** Registration price for a label over `years`. */
+    price(label: string, years?: number): Promise<{
+        wei: bigint;
+        eth: string;
+    }>;
+    /** Owner, expiry, resolver, and tokenId of a name. */
+    nameInfo(name: string): Promise<NameInfo>;
+    /** Register a name via commit → wait (~60s) → register. Paid in native ETH. */
+    register(label: string, opts?: {
+        years?: number;
+        owner?: Address;
+    }): Promise<RegisterResult>;
+    /** Set the caller's primary (reverse) name. */
+    setPrimary(name: string): Promise<Hex>;
+    /** Set the address record (deploys a per-owner resolver on first use). */
+    setAddr(name: string, address: Address): Promise<Hex>;
+    /** Set a text record (deploys a per-owner resolver on first use). */
+    setText(name: string, key: string, value: string): Promise<Hex>;
+    /** Return the name's resolver, deploying + linking a per-owner one (addr+text roles) if needed. */
+    ensureResolver(name: string): Promise<Address>;
+}
+
+export { CHAIN_ID, DEFAULT_CONTRACTS, Hood, type HoodContracts, type HoodOptions, type NameInfo, type NameRecords, REGISTRY_DEPLOY_BLOCK, RESOLVER_RECORD_ROLES, type RegisterResult, SECONDS_PER_YEAR, TEXT_KEYS, robinhoodChain };