@ensdomains/ensjs 4.1.2 → 5.0.0-alpha.0

package/dist/actions/wallet/setTextRecord.d.ts

@@ -0,0 +1,88 @@
+import type { Account, Address, Chain, Client, Transport, WriteContractErrorType, WriteContractReturnType } from 'viem';
+import { type NamehashErrorType } from 'viem';
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js';
+import { type ClientWithOverridesErrorType } from '../../utils/clientWithOverrides.js';
+import { type SetTextParametersErrorType } from '../../utils/coders/setText.js';
+export type SetTextRecordWriteParametersParameters = {
+    /** The name to set a text record for */
+    name?: string;
+    /** The text record key to set */
+    key: string;
+    /** The text record value to set */
+    value: string | null;
+    /** The resolver address to use */
+    resolverAddress: Address;
+};
+export type SetTextRecordWriteParametersReturnType = ReturnType<typeof setTextRecordWriteParameters>;
+export type SetTextRecordWriteParametersErrorType = SetTextParametersErrorType | NamehashErrorType;
+export declare const setTextRecordWriteParameters: <chain extends Chain, account extends Account>(client: Client<Transport, chain, account>, { name, key, value, resolverAddress }: SetTextRecordWriteParametersParameters) => {
+    readonly abi: readonly [{
+        readonly inputs: readonly [{
+            readonly name: "node";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "key";
+            readonly type: "string";
+        }, {
+            readonly name: "value";
+            readonly type: "string";
+        }];
+        readonly name: "setText";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+        readonly type: "function";
+    }];
+    readonly functionName: "setText";
+    readonly args: readonly [`0x${string}`, string, string];
+    readonly address: `0x${string}`;
+    readonly chain: chain;
+    readonly account: Account;
+} | {
+    readonly abi: readonly [{
+        readonly inputs: readonly [{
+            readonly name: "key";
+            readonly type: "string";
+        }, {
+            readonly name: "value";
+            readonly type: "string";
+        }];
+        readonly name: "setText";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+        readonly type: "function";
+    }];
+    readonly functionName: "setText";
+    readonly args: readonly [string, string];
+    readonly address: `0x${string}`;
+    readonly chain: chain;
+    readonly account: Account;
+};
+export type SetTextRecordParameters<chain extends Chain, account extends Account, chainOverride extends Chain> = Prettify<SetTextRecordWriteParametersParameters & WriteTransactionParameters<chain, account, chainOverride>>;
+export type SetTextRecordReturnType = WriteContractReturnType;
+export type SetTextRecordErrorType = SetTextRecordWriteParametersErrorType | ClientWithOverridesErrorType | WriteContractErrorType;
+/**
+ * Sets a text record for a name on a resolver.
+ * @param client - {@link Client}
+ * @param options - {@link SetTextRecordOptions}
+ * @returns Transaction hash. {@link SetTextRecordReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setTextRecord } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await setTextRecord(wallet, {
+ *   name: 'ens.eth',
+ *   key: 'foo',
+ *   value: 'bar',
+ *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+ * })
+ * // 0x...
+ */
+export declare function setTextRecord<chain extends Chain, account extends Account, chainOverride extends Chain>(client: Client<Transport, chain, account>, { name, key, value, resolverAddress, ...txArgs }: SetTextRecordParameters<chain, account, chainOverride>): Promise<SetTextRecordReturnType>;
+//# sourceMappingURL=setTextRecord.d.ts.map

package/dist/actions/wallet/setTextRecord.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setTextRecord.d.ts","sourceRoot":"","sources":["../../../src/actions/wallet/setTextRecord.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,OAAO,EACP,KAAK,EACL,MAAM,EACN,SAAS,EACT,sBAAsB,EAEtB,uBAAuB,EACxB,MAAM,MAAM,CAAA;AACb,OAAO,EAAE,KAAK,iBAAiB,EAAY,MAAM,MAAM,CAAA;AAGvD,OAAO,KAAK,EAAE,QAAQ,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAA;AAChF,OAAO,EACL,KAAK,4BAA4B,EAElC,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EACL,KAAK,0BAA0B,EAGhC,MAAM,+BAA+B,CAAA;AAEtC,MAAM,MAAM,sCAAsC,GAAG;IACnD,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,iCAAiC;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,mCAAmC;IACnC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,kCAAkC;IAClC,eAAe,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,sCAAsC,GAAG,UAAU,CAC7D,OAAO,4BAA4B,CACpC,CAAA;AAED,MAAM,MAAM,qCAAqC,GAC7C,0BAA0B,GAC1B,iBAAiB,CAAA;AAErB,eAAO,MAAM,4BAA4B,GACvC,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,EAEvB,QAAQ,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EACzC,uCAAuC,sCAAsC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAc9E,CAAA;AAMD,MAAM,MAAM,uBAAuB,CACjC,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,EACvB,aAAa,SAAS,KAAK,IACzB,QAAQ,CACV,sCAAsC,GACpC,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,CAC5D,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,uBAAuB,CAAA;AAE7D,MAAM,MAAM,sBAAsB,GAC9B,qCAAqC,GACrC,4BAA4B,GAC5B,sBAAsB,CAAA;AAE1B;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,aAAa,CACjC,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,EACvB,aAAa,SAAS,KAAK,EAE3B,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EACzC,EACE,IAAI,EACJ,GAAG,EACH,KAAK,EACL,eAAe,EACf,GAAG,MAAM,EACV,EAAE,uBAAuB,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,GACxD,OAAO,CAAC,uBAAuB,CAAC,CAelC"}

package/dist/actions/wallet/setTextRecord.js

@@ -0,0 +1,53 @@
+import { namehash } from 'viem';
+import { writeContract } from 'viem/actions';
+import { getAction } from 'viem/utils';
+import { clientWithOverrides, } from '../../utils/clientWithOverrides.js';
+import { setTextParameters, } from '../../utils/coders/setText.js';
+export const setTextRecordWriteParameters = (client, { name, key, value, resolverAddress }) => {
+    return {
+        address: resolverAddress,
+        chain: client.chain,
+        account: client.account,
+        ...setTextParameters(typeof name === 'string'
+            ? { namehash: namehash(name), key, value }
+            : { key, value }),
+    };
+};
+/**
+ * Sets a text record for a name on a resolver.
+ * @param client - {@link Client}
+ * @param options - {@link SetTextRecordOptions}
+ * @returns Transaction hash. {@link SetTextRecordReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setTextRecord } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await setTextRecord(wallet, {
+ *   name: 'ens.eth',
+ *   key: 'foo',
+ *   value: 'bar',
+ *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+ * })
+ * // 0x...
+ */
+export async function setTextRecord(client, { name, key, value, resolverAddress, ...txArgs }) {
+    const writeParameters = setTextRecordWriteParameters(clientWithOverrides(client, txArgs), {
+        name,
+        key,
+        value,
+        resolverAddress,
+    });
+    const writeContractAction = getAction(client, writeContract, 'writeContract');
+    return writeContractAction({
+        ...writeParameters,
+        ...txArgs,
+    });
+}
+//# sourceMappingURL=setTextRecord.js.map

package/dist/actions/wallet/setTextRecord.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setTextRecord.js","sourceRoot":"","sources":["../../../src/actions/wallet/setTextRecord.ts"],"names":[],"mappings":"AAUA,OAAO,EAA0B,QAAQ,EAAE,MAAM,MAAM,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,OAAO,EAEL,mBAAmB,GACpB,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EAGL,iBAAiB,GAClB,MAAM,+BAA+B,CAAA;AAqBtC,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAI1C,MAAyC,EACzC,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,eAAe,EAA0C,EAC7E,EAAE;IACF,OAAO;QACL,OAAO,EAAE,eAAe;QACxB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,GAAG,iBAAiB,CAClB,OAAO,IAAI,KAAK,QAAQ;YACtB,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE;YAC1C,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CACnB;KAGF,CAAA;AACH,CAAC,CAAA;AAsBD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAKjC,MAAyC,EACzC,EACE,IAAI,EACJ,GAAG,EACH,KAAK,EACL,eAAe,EACf,GAAG,MAAM,EAC8C;IAEzD,MAAM,eAAe,GAAG,4BAA4B,CAClD,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC;QACE,IAAI;QACJ,GAAG;QACH,KAAK;QACL,eAAe;KAChB,CACF,CAAA;IACD,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,EAAE,aAAa,EAAE,eAAe,CAAC,CAAA;IAC7E,OAAO,mBAAmB,CAAC;QACzB,GAAG,eAAe;QAClB,GAAG,MAAM;KACiB,CAAC,CAAA;AAC/B,CAAC"}