@monadns/sdk 1.0.0 → 2.0.0

package/dist/react.d.cts

@@ -7,6 +7,426 @@ type MNSClientConfig = {
     client?: PublicClient<Transport, Chain>;
 };
 
+type RegistrationInfo = {
+    available: boolean;
+    price: bigint;
+    isFreebie: boolean;
+    hasClaimed: boolean;
+    duration: bigint;
+    label: string;
+};
+
+/**
+ * Hook to get registration info (price, availability, freebie status).
+ * Use this to build a registration UI before the user submits.
+ *
+ * @example
+ * ```tsx
+ * function RegisterPage() {
+ *   const [name, setName] = useState('')
+ *   const { address } = useAccount()
+ *   const { info, loading, error } = useRegistrationInfo(name, address)
+ *
+ *   return (
+ *     <div>
+ *       <input value={name} onChange={(e) => setName(e.target.value)} />
+ *       {info?.available && (
+ *         <p>{info.isFreebie ? 'FREE!' : `${formatEther(info.price)} MON`}</p>
+ *       )}
+ *     </div>
+ *   )
+ * }
+ * ```
+ */
+declare function useRegistrationInfo(label: string | undefined, userAddress: string | undefined, durationYears?: number, config?: MNSClientConfig): {
+    info: RegistrationInfo | null;
+    loading: boolean;
+    error: string | null;
+};
+/**
+ * Hook to register a .mon name.
+ * Returns a prepare function that gives you tx params for wagmi's writeContract.
+ *
+ * @example
+ * ```tsx
+ * const { prepare, loading, error } = useMNSRegister()
+ * const { writeContract, data: hash } = useWriteContract()
+ *
+ * const handleRegister = async () => {
+ *   const tx = await prepare('alice', address)
+ *   if (tx) writeContract(tx)
+ * }
+ * ```
+ */
+declare function useMNSRegister(config?: MNSClientConfig): {
+    prepare: (label: string, ownerAddress: string, durationYears?: number) => Promise<{
+        address: "0x98866c55adbc73ec6c272bb3604ddbdee3f282a8";
+        abi: readonly [{
+            readonly name: "register";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "label";
+                readonly type: "string";
+            }, {
+                readonly name: "owner";
+                readonly type: "address";
+            }, {
+                readonly name: "duration";
+                readonly type: "uint256";
+            }];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "uint256";
+            }];
+            readonly stateMutability: "payable";
+        }];
+        functionName: "register";
+        args: readonly [string, `0x${string}`, bigint];
+        value: bigint;
+        gas: bigint;
+        _meta: {
+            label: string;
+            isFreebie: boolean;
+            price: bigint;
+            duration: bigint;
+        };
+    } | null>;
+    tx: {
+        address: "0x98866c55adbc73ec6c272bb3604ddbdee3f282a8";
+        abi: readonly [{
+            readonly name: "register";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "label";
+                readonly type: "string";
+            }, {
+                readonly name: "owner";
+                readonly type: "address";
+            }, {
+                readonly name: "duration";
+                readonly type: "uint256";
+            }];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "uint256";
+            }];
+            readonly stateMutability: "payable";
+        }];
+        functionName: "register";
+        args: readonly [string, `0x${string}`, bigint];
+        value: bigint;
+        gas: bigint;
+        _meta: {
+            label: string;
+            isFreebie: boolean;
+            price: bigint;
+            duration: bigint;
+        };
+    } | null;
+    loading: boolean;
+    error: string | null;
+};
+/**
+ * Hook to set text records (avatar, url, twitter, etc.)
+ *
+ * @example
+ * ```tsx
+ * const { setAvatar, setTwitter } = useMNSTextRecords()
+ * const { writeContract } = useWriteContract()
+ *
+ * writeContract(setAvatar('alice.mon', 'https://example.com/pic.png'))
+ * ```
+ */
+declare function useMNSTextRecords(): {
+    setTextRecord: (name: string, key: string, value: string) => {
+        address: "0xa2eb94c88e55d944aced2066c5cec9b759801f97";
+        abi: readonly [{
+            readonly name: "setText";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "key";
+                readonly type: "string";
+            }, {
+                readonly name: "value";
+                readonly type: "string";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly name: "setAddr";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "a";
+                readonly type: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }];
+        functionName: "setText";
+        args: readonly [`0x${string}`, string, string];
+    };
+    setAvatar: (name: string, url: string) => {
+        address: "0xa2eb94c88e55d944aced2066c5cec9b759801f97";
+        abi: readonly [{
+            readonly name: "setText";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "key";
+                readonly type: "string";
+            }, {
+                readonly name: "value";
+                readonly type: "string";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly name: "setAddr";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "a";
+                readonly type: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }];
+        functionName: "setText";
+        args: readonly [`0x${string}`, string, string];
+    };
+    setUrl: (name: string, url: string) => {
+        address: "0xa2eb94c88e55d944aced2066c5cec9b759801f97";
+        abi: readonly [{
+            readonly name: "setText";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "key";
+                readonly type: "string";
+            }, {
+                readonly name: "value";
+                readonly type: "string";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly name: "setAddr";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "a";
+                readonly type: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }];
+        functionName: "setText";
+        args: readonly [`0x${string}`, string, string];
+    };
+    setTwitter: (name: string, handle: string) => {
+        address: "0xa2eb94c88e55d944aced2066c5cec9b759801f97";
+        abi: readonly [{
+            readonly name: "setText";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "key";
+                readonly type: "string";
+            }, {
+                readonly name: "value";
+                readonly type: "string";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly name: "setAddr";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "a";
+                readonly type: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }];
+        functionName: "setText";
+        args: readonly [`0x${string}`, string, string];
+    };
+    setGithub: (name: string, handle: string) => {
+        address: "0xa2eb94c88e55d944aced2066c5cec9b759801f97";
+        abi: readonly [{
+            readonly name: "setText";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "key";
+                readonly type: "string";
+            }, {
+                readonly name: "value";
+                readonly type: "string";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly name: "setAddr";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "a";
+                readonly type: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }];
+        functionName: "setText";
+        args: readonly [`0x${string}`, string, string];
+    };
+    setDiscord: (name: string, handle: string) => {
+        address: "0xa2eb94c88e55d944aced2066c5cec9b759801f97";
+        abi: readonly [{
+            readonly name: "setText";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "key";
+                readonly type: "string";
+            }, {
+                readonly name: "value";
+                readonly type: "string";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly name: "setAddr";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "a";
+                readonly type: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }];
+        functionName: "setText";
+        args: readonly [`0x${string}`, string, string];
+    };
+    setDescription: (name: string, desc: string) => {
+        address: "0xa2eb94c88e55d944aced2066c5cec9b759801f97";
+        abi: readonly [{
+            readonly name: "setText";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "key";
+                readonly type: "string";
+            }, {
+                readonly name: "value";
+                readonly type: "string";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly name: "setAddr";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "a";
+                readonly type: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }];
+        functionName: "setText";
+        args: readonly [`0x${string}`, string, string];
+    };
+    textRecordKeys: {
+        readonly avatar: "avatar";
+        readonly url: "url";
+        readonly description: "description";
+        readonly email: "email";
+        readonly twitter: "com.twitter";
+        readonly github: "com.github";
+        readonly discord: "com.discord";
+        readonly telegram: "org.telegram";
+    };
+};
+/**
+ * Hook to update the address a name points to.
+ *
+ * @example
+ * ```tsx
+ * const { setAddr } = useMNSAddr()
+ * const { writeContract } = useWriteContract()
+ *
+ * writeContract(setAddr('alice.mon', '0xnewaddress...'))
+ * ```
+ */
+declare function useMNSAddr(): {
+    setAddr: (name: string, addr: string) => {
+        address: "0xa2eb94c88e55d944aced2066c5cec9b759801f97";
+        abi: readonly [{
+            readonly name: "setText";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "key";
+                readonly type: "string";
+            }, {
+                readonly name: "value";
+                readonly type: "string";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly name: "setAddr";
+            readonly type: "function";
+            readonly inputs: readonly [{
+                readonly name: "node";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "a";
+                readonly type: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }];
+        functionName: "setAddr";
+        args: readonly [`0x${string}`, `0x${string}`];
+    };
+};
+
 /**
  * Reverse resolution hook: address → .mon name
  *
@@ -67,16 +487,11 @@ declare function useMNSDisplay(address: string | undefined, config?: MNSClientCo
  * ```tsx
  * function SendForm() {
  *   const { resolve, address, name, loading, error } = useMNSResolve()
- *
  *   return (
  *     <div>
- *       <input
- *         placeholder="Address or .mon name"
- *         onChange={(e) => resolve(e.target.value)}
- *       />
+ *       <input placeholder="Address or .mon name" onChange={(e) => resolve(e.target.value)} />
  *       {loading && <span>Resolving...</span>}
- *       {error && <span className="text-red-500">{error}</span>}
- *       {address && <span className="text-green-500">→ {address}</span>}
+ *       {address && <span>→ {address}</span>}
  *     </div>
  *   )
  * }
@@ -105,5 +520,22 @@ declare function useMNSText(name: string | undefined, key: string, config?: MNSC
     loading: boolean;
     error: string | null;
 };
+/**
+ * Avatar URL hook: resolves avatar from text record, handling IPFS and NFT formats
+ *
+ * @example
+ * ```tsx
+ * function Avatar({ name }: { name: string }) {
+ *   const { url, loading } = useMNSAvatar(name)
+ *   if (loading) return <div className="animate-pulse w-10 h-10 rounded-full bg-gray-700" />
+ *   return url ? <img src={url} className="w-10 h-10 rounded-full" /> : null
+ * }
+ * ```
+ */
+declare function useMNSAvatar(name: string | undefined, config?: MNSClientConfig): {
+    url: string | null;
+    loading: boolean;
+    error: string | null;
+};
 
-export { type MNSClientConfig, useMNSAddress, useMNSDisplay, useMNSName, useMNSResolve, useMNSText };
+export { type MNSClientConfig, useMNSAddr, useMNSAddress, useMNSAvatar, useMNSDisplay, useMNSName, useMNSRegister, useMNSResolve, useMNSText, useMNSTextRecords, useRegistrationInfo };