viem 0.0.0-portable-types-20230522163654 → 0.0.0-tmm-sign-typed-data-types.20230619T221425

package/dist/esm/accounts/generateMnemonic.js

@@ -1,4 +1,11 @@
 import { generateMnemonic as generateMnemonic_ } from '@scure/bip39';
+/**
+ * @description Generates a random mnemonic phrase with a given wordlist.
+ *
+ * @param wordlist The wordlist to use for generating the mnemonic phrase.
+ *
+ * @returns A randomly generated mnemonic phrase.
+ */
 export function generateMnemonic(wordlist) {
     return generateMnemonic_(wordlist);
 }

package/dist/esm/accounts/generateMnemonic.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateMnemonic.js","sourceRoot":"","sources":["../../../src/accounts/generateMnemonic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,IAAI,iBAAiB,EAAE,MAAM,cAAc,CAAA;AASpE,MAAM,UAAU,gBAAgB,CAAC,QAAkB;IACjD,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAA;AACpC,CAAC"}
+{"version":3,"file":"generateMnemonic.js","sourceRoot":"","sources":["../../../src/accounts/generateMnemonic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,IAAI,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEpE;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAkB;IACjD,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAA;AACpC,CAAC"}

package/dist/esm/accounts/generatePrivateKey.js

@@ -1,5 +1,10 @@
 import { secp256k1 } from '@noble/curves/secp256k1';
 import { toHex } from '../utils/encoding/toHex.js';
+/**
+ * @description Generates a random private key.
+ *
+ * @returns A randomly generated private key.
+ */
 export function generatePrivateKey() {
     return toHex(secp256k1.utils.randomPrivateKey());
 }

package/dist/esm/accounts/generatePrivateKey.js.map

@@ -1 +1 @@
-{"version":3,"file":"generatePrivateKey.js","sourceRoot":"","sources":["../../../src/accounts/generatePrivateKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGnD,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAOlD,MAAM,UAAU,kBAAkB;IAChC,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAA;AAClD,CAAC"}
+{"version":3,"file":"generatePrivateKey.js","sourceRoot":"","sources":["../../../src/accounts/generatePrivateKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGnD,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAElD;;;;GAIG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAA;AAClD,CAAC"}

package/dist/esm/accounts/hdKeyToAccount.js

@@ -1,5 +1,10 @@
 import { toHex } from '../utils/encoding/toHex.js';
 import { privateKeyToAccount } from './privateKeyToAccount.js';
+/**
+ * @description Creates an Account from a HD Key.
+ *
+ * @returns A HD Account.
+ */
 export function hdKeyToAccount(hdKey_, { accountIndex = 0, addressIndex = 0, changeIndex = 0, path } = {}) {
     const hdKey = hdKey_.derive(path || `m/44'/60'/${accountIndex}'/${changeIndex}/${addressIndex}`);
     const account = privateKeyToAccount(toHex(hdKey.privateKey));

package/dist/esm/accounts/hdKeyToAccount.js.map

@@ -1 +1 @@
-{"version":3,"file":"hdKeyToAccount.js","sourceRoot":"","sources":["../../../src/accounts/hdKeyToAccount.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAElD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAQ9D,MAAM,UAAU,cAAc,CAC5B,MAAa,EACb,EAAE,YAAY,GAAG,CAAC,EAAE,YAAY,GAAG,CAAC,EAAE,WAAW,GAAG,CAAC,EAAE,IAAI,KAAgB,EAAE;IAE7E,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CACzB,IAAI,IAAI,aAAa,YAAY,KAAK,WAAW,IAAI,YAAY,EAAE,CACpE,CAAA;IACD,MAAM,OAAO,GAAG,mBAAmB,CAAC,KAAK,CAAC,KAAK,CAAC,UAAW,CAAC,CAAC,CAAA;IAC7D,OAAO;QACL,GAAG,OAAO;QACV,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK;QACrB,MAAM,EAAE,IAAI;KACb,CAAA;AACH,CAAC"}
+{"version":3,"file":"hdKeyToAccount.js","sourceRoot":"","sources":["../../../src/accounts/hdKeyToAccount.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAElD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAG9D;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAa,EACb,EAAE,YAAY,GAAG,CAAC,EAAE,YAAY,GAAG,CAAC,EAAE,WAAW,GAAG,CAAC,EAAE,IAAI,KAAgB,EAAE;IAE7E,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CACzB,IAAI,IAAI,aAAa,YAAY,KAAK,WAAW,IAAI,YAAY,EAAE,CACpE,CAAA;IACD,MAAM,OAAO,GAAG,mBAAmB,CAAC,KAAK,CAAC,KAAK,CAAC,UAAW,CAAC,CAAC,CAAA;IAC7D,OAAO;QACL,GAAG,OAAO;QACV,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK;QACrB,MAAM,EAAE,IAAI;KACb,CAAA;AACH,CAAC"}

package/dist/esm/accounts/mnemonicToAccount.js

@@ -1,6 +1,11 @@
 import { HDKey } from '@scure/bip32';
 import { mnemonicToSeedSync } from '@scure/bip39';
 import { hdKeyToAccount } from './hdKeyToAccount.js';
+/**
+ * @description Creates an Account from a mnemonic phrase.
+ *
+ * @returns A HD Account.
+ */
 export function mnemonicToAccount(mnemonic, opts = {}) {
     const seed = mnemonicToSeedSync(mnemonic);
     return hdKeyToAccount(HDKey.fromMasterSeed(seed), opts);

package/dist/esm/accounts/mnemonicToAccount.js.map

@@ -1 +1 @@
-{"version":3,"file":"mnemonicToAccount.js","sourceRoot":"","sources":["../../../src/accounts/mnemonicToAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAEjD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAQpD,MAAM,UAAU,iBAAiB,CAC/B,QAAgB,EAChB,OAAkB,EAAE;IAEpB,MAAM,IAAI,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAA;IACzC,OAAO,cAAc,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAA;AACzD,CAAC"}
+{"version":3,"file":"mnemonicToAccount.js","sourceRoot":"","sources":["../../../src/accounts/mnemonicToAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAEjD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAGpD;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,QAAgB,EAChB,OAAkB,EAAE;IAEpB,MAAM,IAAI,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAA;IACzC,OAAO,cAAc,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAA;AACzD,CAAC"}

package/dist/esm/accounts/privateKeyToAccount.js

@@ -5,6 +5,11 @@ import { publicKeyToAddress } from './utils/publicKeyToAddress.js';
 import { signMessage } from './utils/signMessage.js';
 import { signTransaction } from './utils/signTransaction.js';
 import { signTypedData } from './utils/signTypedData.js';
+/**
+ * @description Creates an Account from a private key.
+ *
+ * @returns A Private Key Account.
+ */
 export function privateKeyToAccount(privateKey) {
     const publicKey = toHex(secp256k1.getPublicKey(privateKey.slice(2), false));
     const address = publicKeyToAddress(publicKey);

package/dist/esm/accounts/privateKeyToAccount.js.map

@@ -1 +1 @@
-{"version":3,"file":"privateKeyToAccount.js","sourceRoot":"","sources":["../../../src/accounts/privateKeyToAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGnD,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAElD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAOxD,MAAM,UAAU,mBAAmB,CAAC,UAAe;IACjD,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;IAC3E,MAAM,OAAO,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAA;IAE7C,MAAM,OAAO,GAAG,SAAS,CAAC;QACxB,OAAO;QACP,KAAK,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE;YAC3B,OAAO,WAAW,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAA;QAC7C,CAAC;QACD,KAAK,CAAC,eAAe,CAAC,WAAW;YAC/B,OAAO,eAAe,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,CAAA;QACrD,CAAC;QACD,KAAK,CAAC,aAAa,CAAC,SAAS;YAC3B,OAAO,aAAa,CAAC,EAAE,GAAG,SAAS,EAAE,UAAU,EAAE,CAAC,CAAA;QACpD,CAAC;KACF,CAAC,CAAA;IAEF,OAAO;QACL,GAAG,OAAO;QACV,SAAS;QACT,MAAM,EAAE,YAAY;KACrB,CAAA;AACH,CAAC"}
+{"version":3,"file":"privateKeyToAccount.js","sourceRoot":"","sources":["../../../src/accounts/privateKeyToAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGnD,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAElD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAExD;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAAe;IACjD,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;IAC3E,MAAM,OAAO,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAA;IAE7C,MAAM,OAAO,GAAG,SAAS,CAAC;QACxB,OAAO;QACP,KAAK,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE;YAC3B,OAAO,WAAW,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAA;QAC7C,CAAC;QACD,KAAK,CAAC,eAAe,CAAC,WAAW;YAC/B,OAAO,eAAe,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,CAAA;QACrD,CAAC;QACD,KAAK,CAAC,aAAa,CAAC,SAAS;YAC3B,OAAO,aAAa,CAAC,EAAE,GAAG,SAAS,EAAE,UAAU,EAAE,CAAC,CAAA;QACpD,CAAC;KACF,CAAC,CAAA;IAEF,OAAO;QACL,GAAG,OAAO;QACV,SAAS;QACT,MAAM,EAAE,YAAY;KACrB,CAAA;AACH,CAAC"}

package/dist/esm/accounts/toAccount.js

@@ -1,5 +1,10 @@
 import { InvalidAddressError } from '../errors/address.js';
 import { isAddress } from '../utils/address/isAddress.js';
+/**
+ * @description Creates an Account from a custom signing implementation.
+ *
+ * @returns A Local Account.
+ */
 export function toAccount(source) {
     if (typeof source === 'string') {
         if (!isAddress(source))

package/dist/esm/accounts/toAccount.js.map

@@ -1 +1 @@
-{"version":3,"file":"toAccount.js","sourceRoot":"","sources":["../../../src/accounts/toAccount.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AAkBzD,MAAM,UAAU,SAAS,CACvB,MAAsB;IAEtB,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;YAAE,MAAM,IAAI,mBAAmB,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAA;QAC1E,OAAO;YACL,OAAO,EAAE,MAAM;YACf,IAAI,EAAE,UAAU;SACuB,CAAA;KAC1C;IAED,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC;QAC5B,MAAM,IAAI,mBAAmB,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;IAC5D,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,OAAO;KAC0B,CAAA;AAC3C,CAAC"}
+{"version":3,"file":"toAccount.js","sourceRoot":"","sources":["../../../src/accounts/toAccount.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AAazD;;;;GAIG;AACH,MAAM,UAAU,SAAS,CACvB,MAAsB;IAEtB,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;YAAE,MAAM,IAAI,mBAAmB,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAA;QAC1E,OAAO;YACL,OAAO,EAAE,MAAM;YACf,IAAI,EAAE,UAAU;SACuB,CAAA;KAC1C;IAED,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC;QAC5B,MAAM,IAAI,mBAAmB,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;IAC5D,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,OAAO;KAC0B,CAAA;AAC3C,CAAC"}

package/dist/esm/accounts/utils/publicKeyToAddress.js

@@ -1,5 +1,12 @@
 import { checksumAddress } from '../../utils/address/getAddress.js';
 import { keccak256 } from '../../utils/hash/keccak256.js';
+/**
+ * @description Converts an ECDSA public key to an address.
+ *
+ * @param publicKey The public key to convert.
+ *
+ * @returns The address.
+ */
 export function publicKeyToAddress(publicKey) {
     const address = keccak256(`0x${publicKey.substring(4)}`).substring(26);
     return checksumAddress(`0x${address}`);

package/dist/esm/accounts/utils/publicKeyToAddress.js.map

@@ -1 +1 @@
-{"version":3,"file":"publicKeyToAddress.js","sourceRoot":"","sources":["../../../../src/accounts/utils/publicKeyToAddress.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AASzD,MAAM,UAAU,kBAAkB,CAAC,SAAc;IAC/C,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;IACtE,OAAO,eAAe,CAAC,KAAK,OAAO,EAAE,CAAY,CAAA;AACnD,CAAC"}
+{"version":3,"file":"publicKeyToAddress.js","sourceRoot":"","sources":["../../../../src/accounts/utils/publicKeyToAddress.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AAEzD;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,SAAc;IAC/C,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;IACtE,OAAO,eAAe,CAAC,KAAK,OAAO,EAAE,CAAY,CAAA;AACnD,CAAC"}

package/dist/esm/accounts/utils/sign.js

@@ -1,5 +1,13 @@
 import { secp256k1 } from '@noble/curves/secp256k1';
 import { toHex } from '../../utils/encoding/toHex.js';
+/**
+ * @description Signs a hash with a given private key.
+ *
+ * @param hash The hash to sign.
+ * @param privateKey The private key to sign with.
+ *
+ * @returns The signature.
+ */
 export async function sign({ hash, privateKey, }) {
     const { r, s, recovery } = secp256k1.sign(hash.slice(2), privateKey.slice(2));
     return {

package/dist/esm/accounts/utils/sign.js.map

@@ -1 +1 @@
-{"version":3,"file":"sign.js","sourceRoot":"","sources":["../../../../src/accounts/utils/sign.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGnD,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AAgBrD,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,EACzB,IAAI,EACJ,UAAU,GACK;IACf,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAC7E,OAAO;QACL,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QACX,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QACX,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;KACxB,CAAA;AACH,CAAC"}
+{"version":3,"file":"sign.js","sourceRoot":"","sources":["../../../../src/accounts/utils/sign.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGnD,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AAQrD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,EACzB,IAAI,EACJ,UAAU,GACK;IACf,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAC7E,OAAO;QACL,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QACX,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QACX,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG;KACxB,CAAA;AACH,CAAC"}

package/dist/esm/accounts/utils/signMessage.js

@@ -1,6 +1,12 @@
 import { hashMessage } from '../../utils/signature/hashMessage.js';
 import { sign } from './sign.js';
 import { signatureToHex } from './signatureToHex.js';
+/**
+ * @description Calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191):
+ * `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`.
+ *
+ * @returns The signature.
+ */
 export async function signMessage({ message, privateKey, }) {
     const signature = await sign({ hash: hashMessage(message), privateKey });
     return signatureToHex(signature);

package/dist/esm/accounts/utils/signMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"signMessage.js","sourceRoot":"","sources":["../../../../src/accounts/utils/signMessage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAA;AAElE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAgBpD,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,EAChC,OAAO,EACP,UAAU,GACY;IACtB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC,CAAA;IACxE,OAAO,cAAc,CAAC,SAAS,CAAC,CAAA;AAClC,CAAC"}
+{"version":3,"file":"signMessage.js","sourceRoot":"","sources":["../../../../src/accounts/utils/signMessage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAA;AAElE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAUpD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,EAChC,OAAO,EACP,UAAU,GACY;IACtB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC,CAAA;IACxE,OAAO,cAAc,CAAC,SAAS,CAAC,CAAA;AAClC,CAAC"}

package/dist/esm/accounts/utils/signTypedData.js

@@ -1,6 +1,12 @@
 import { hashTypedData, } from '../../utils/signature/hashTypedData.js';
 import { sign } from './sign.js';
 import { signatureToHex } from './signatureToHex.js';
+/**
+ * @description Signs typed data and calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191):
+ * `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`.
+ *
+ * @returns The signature.
+ */
 export async function signTypedData({ privateKey, ...typedData }) {
     const signature = await sign({
         hash: hashTypedData(typedData),

package/dist/esm/accounts/utils/signTypedData.js.map

@@ -1 +1 @@
-{"version":3,"file":"signTypedData.js","sourceRoot":"","sources":["../../../../src/accounts/utils/signTypedData.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,aAAa,GACd,MAAM,wCAAwC,CAAA;AAE/C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAkBpD,MAAM,CAAC,KAAK,UAAU,aAAa,CAGjC,EACA,UAAU,EACV,GAAG,SAAS,EAIb;IACC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC;QAC3B,IAAI,EAAE,aAAa,CAAC,SAAoC,CAAC;QACzD,UAAU;KACX,CAAC,CAAA;IACF,OAAO,cAAc,CAAC,SAAS,CAAC,CAAA;AAClC,CAAC"}
+{"version":3,"file":"signTypedData.js","sourceRoot":"","sources":["../../../../src/accounts/utils/signTypedData.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,aAAa,GACd,MAAM,wCAAwC,CAAA;AAE/C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAYpD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAGjC,EACA,UAAU,EACV,GAAG,SAAS,EAIb;IACC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC;QAC3B,IAAI,EAAE,aAAa,CAAC,SAAoC,CAAC;QACzD,UAAU;KACX,CAAC,CAAA;IACF,OAAO,cAAc,CAAC,SAAS,CAAC,CAAA;AAClC,CAAC"}

package/dist/esm/actions/ens/getEnsAddress.js

@@ -1,4 +1,5 @@
 import { singleAddressResolverAbi, universalResolverAbi, } from '../../constants/abis.js';
+import { ContractFunctionExecutionError, ContractFunctionRevertedError, } from '../../errors/contract.js';
 import { decodeFunctionResult } from '../../utils/abi/decodeFunctionResult.js';
 import { encodeFunctionData } from '../../utils/abi/encodeFunctionData.js';
 import { getChainContractAddress } from '../../utils/chain.js';
@@ -7,6 +8,34 @@ import { toHex } from '../../utils/encoding/toHex.js';
 import { namehash } from '../../utils/ens/namehash.js';
 import { packetToBytes } from '../../utils/ens/packetToBytes.js';
 import { readContract, } from '../public/readContract.js';
+/**
+ * Gets address for ENS name.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsAddress.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
+ *
+ * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsAddressParameters}
+ * @returns Address for ENS name or `null` if not found. {@link GetEnsAddressReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsAddress, normalize } from 'viem/ens'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const ensAddress = await getEnsAddress(client, {
+ *   name: normalize('wagmi-dev.eth'),
+ * })
+ * // '0xd2135CfB216b74109775236E36d4b433F1DF507B'
+ */
 export async function getEnsAddress(client, { blockNumber, blockTag, name, universalResolverAddress: universalResolverAddress_, }) {
     let universalResolverAddress = universalResolverAddress_;
     if (!universalResolverAddress) {
@@ -18,28 +47,38 @@ export async function getEnsAddress(client, { blockNumber, blockTag, name, unive
             contract: 'ensUniversalResolver',
         });
     }
-    const res = await readContract(client, {
-        address: universalResolverAddress,
-        abi: universalResolverAbi,
-        functionName: 'resolve',
-        args: [
-            toHex(packetToBytes(name)),
-            encodeFunctionData({
-                abi: singleAddressResolverAbi,
-                functionName: 'addr',
-                args: [namehash(name)],
-            }),
-        ],
-        blockNumber,
-        blockTag,
-    });
-    if (res[0] === '0x')
-        return null;
-    const address = decodeFunctionResult({
-        abi: singleAddressResolverAbi,
-        functionName: 'addr',
-        data: res[0],
-    });
-    return trim(address) === '0x00' ? null : address;
+    try {
+        const res = await readContract(client, {
+            address: universalResolverAddress,
+            abi: universalResolverAbi,
+            functionName: 'resolve',
+            args: [
+                toHex(packetToBytes(name)),
+                encodeFunctionData({
+                    abi: singleAddressResolverAbi,
+                    functionName: 'addr',
+                    args: [namehash(name)],
+                }),
+            ],
+            blockNumber,
+            blockTag,
+        });
+        if (res[0] === '0x')
+            return null;
+        const address = decodeFunctionResult({
+            abi: singleAddressResolverAbi,
+            functionName: 'addr',
+            data: res[0],
+        });
+        return trim(address) === '0x00' ? null : address;
+    }
+    catch (err) {
+        if (err instanceof ContractFunctionExecutionError) {
+            const reason = err.cause?.reason;
+            if (reason?.includes('Wildcard on non-extended resolvers is not supported'))
+                return null;
+        }
+        throw err;
+    }
 }
 //# sourceMappingURL=getEnsAddress.js.map

package/dist/esm/actions/ens/getEnsAddress.js.map

@@ -1 +1 @@
-{"version":3,"file":"getEnsAddress.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsAddress.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,yBAAyB,CAAA;AAGhC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAA;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAA;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AAyClC,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAuC,EACvC,EACE,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,wBAAwB,EAAE,yBAAyB,GAC3B;IAE1B,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;QACrC,OAAO,EAAE,wBAAwB;QACjC,GAAG,EAAE,oBAAoB;QACzB,YAAY,EAAE,SAAS;QACvB,IAAI,EAAE;YACJ,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC1B,kBAAkB,CAAC;gBACjB,GAAG,EAAE,wBAAwB;gBAC7B,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;aACvB,CAAC;SACH;QACD,WAAW;QACX,QAAQ;KACT,CAAC,CAAA;IAEF,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAEhC,MAAM,OAAO,GAAG,oBAAoB,CAAC;QACnC,GAAG,EAAE,wBAAwB;QAC7B,YAAY,EAAE,MAAM;QACpB,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;KACb,CAAC,CAAA;IAEF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAA;AAClD,CAAC"}
+{"version":3,"file":"getEnsAddress.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsAddress.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,8BAA8B,EAC9B,6BAA6B,GAC9B,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAA;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAA;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AAalC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAuC,EACvC,EACE,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,wBAAwB,EAAE,yBAAyB,GAC3B;IAE1B,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,IAAI;QACF,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;YACrC,OAAO,EAAE,wBAAwB;YACjC,GAAG,EAAE,oBAAoB;YACzB,YAAY,EAAE,SAAS;YACvB,IAAI,EAAE;gBACJ,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;gBAC1B,kBAAkB,CAAC;oBACjB,GAAG,EAAE,wBAAwB;oBAC7B,YAAY,EAAE,MAAM;oBACpB,IAAI,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;iBACvB,CAAC;aACH;YACD,WAAW;YACX,QAAQ;SACT,CAAC,CAAA;QAEF,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI;YAAE,OAAO,IAAI,CAAA;QAEhC,MAAM,OAAO,GAAG,oBAAoB,CAAC;YACnC,GAAG,EAAE,wBAAwB;YAC7B,YAAY,EAAE,MAAM;YACpB,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;SACb,CAAC,CAAA;QAEF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAA;KACjD;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,GAAG,YAAY,8BAA8B,EAAE;YACjD,MAAM,MAAM,GAAI,GAAG,CAAC,KAAuC,EAAE,MAAM,CAAA;YACnE,IACE,MAAM,EAAE,QAAQ,CAAC,qDAAqD,CAAC;gBAEvE,OAAO,IAAI,CAAA;SACd;QACD,MAAM,GAAG,CAAA;KACV;AACH,CAAC"}

package/dist/esm/actions/ens/getEnsAvatar.js

@@ -1,5 +1,33 @@
 import { parseAvatarRecord } from '../../utils/ens/avatar/parseAvatarRecord.js';
 import { getEnsText } from './getEnsText.js';
+/**
+ * Gets the avatar of an ENS name.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsAvatar.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls [`getEnsText`](https://viem.sh/docs/ens/actions/getEnsText.html) with `key` set to `'avatar'`.
+ *
+ * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsAvatarParameters}
+ * @returns Avatar URI or `null` if not found. {@link GetEnsAvatarReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsAvatar, normalize } from 'viem/ens'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const ensAvatar = await getEnsAvatar(client, {
+ *   name: normalize('wagmi-dev.eth'),
+ * })
+ * // 'https://ipfs.io/ipfs/Qma8mnp6xV3J2cRNf3mTth5C8nV11CAnceVinc3y8jSbio'
+ */
 export async function getEnsAvatar(client, { blockNumber, blockTag, gatewayUrls, name, universalResolverAddress, }) {
     const record = await getEnsText(client, {
         blockNumber,

package/dist/esm/actions/ens/getEnsAvatar.js.map

@@ -1 +1 @@
-{"version":3,"file":"getEnsAvatar.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsAvatar.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAA;AAE/E,OAAO,EAA6B,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAuCvE,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAuC,EACvC,EACE,WAAW,EACX,QAAQ,EACR,WAAW,EACX,IAAI,EACJ,wBAAwB,GACD;IAEzB,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE;QACtC,WAAW;QACX,QAAQ;QACR,GAAG,EAAE,QAAQ;QACb,IAAI;QACJ,wBAAwB;KACzB,CAAC,CAAA;IACF,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAA;IACxB,IAAI;QACF,OAAO,MAAM,iBAAiB,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAA;KAChE;IAAC,MAAM;QACN,OAAO,IAAI,CAAA;KACZ;AACH,CAAC"}
+{"version":3,"file":"getEnsAvatar.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsAvatar.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAA;AAE/E,OAAO,EAA6B,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAWvE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAuC,EACvC,EACE,WAAW,EACX,QAAQ,EACR,WAAW,EACX,IAAI,EACJ,wBAAwB,GACD;IAEzB,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE;QACtC,WAAW;QACX,QAAQ;QACR,GAAG,EAAE,QAAQ;QACb,IAAI;QACJ,wBAAwB;KACzB,CAAC,CAAA;IACF,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAA;IACxB,IAAI;QACF,OAAO,MAAM,iBAAiB,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAA;KAChE;IAAC,MAAM;QACN,OAAO,IAAI,CAAA;KACZ;AACH,CAAC"}

package/dist/esm/actions/ens/getEnsName.js

@@ -4,6 +4,32 @@ import { getChainContractAddress } from '../../utils/chain.js';
 import { toHex } from '../../utils/encoding/toHex.js';
 import { packetToBytes } from '../../utils/ens/packetToBytes.js';
 import { readContract, } from '../public/readContract.js';
+/**
+ * Gets primary name for specified address.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsName.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls `reverse(bytes)` on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsNameParameters}
+ * @returns Name or `null` if not found. {@link GetEnsNameReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsName } from 'viem/ens'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const ensName = await getEnsName(client, {
+ *   address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
+ * })
+ * // 'wagmi-dev.eth'
+ */
 export async function getEnsName(client, { address, blockNumber, blockTag, universalResolverAddress: universalResolverAddress_, }) {
     let universalResolverAddress = universalResolverAddress_;
     if (!universalResolverAddress) {
@@ -43,6 +69,7 @@ export async function getEnsName(client, { address, blockNumber, blockTag, unive
     catch (error) {
         if (error instanceof ContractFunctionExecutionError &&
             error.cause.reason === panicReasons[50])
+            // No primary name set for address.
             return null;
         throw error;
     }

package/dist/esm/actions/ens/getEnsName.js.map

@@ -1 +1 @@
-{"version":3,"file":"getEnsName.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsName.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EACL,8BAA8B,GAE/B,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AAuClC,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAuC,EACvC,EACE,OAAO,EACP,WAAW,EACX,QAAQ,EACR,wBAAwB,EAAE,yBAAyB,GAC9B;IAEvB,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,WAAW,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,CAAA;IACxE,IAAI;QACF,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;YACrC,OAAO,EAAE,wBAAwB;YACjC,GAAG,EAAE;gBACH;oBACE,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,UAAU;oBAChB,eAAe,EAAE,MAAM;oBACvB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;oBAChD,OAAO,EAAE;wBACP,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,cAAc,EAAE;wBACxC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE;wBAC5C,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE;wBAC5C,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE;qBACtC;iBACF;aACF;YACD,YAAY,EAAE,SAAS;YACvB,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC;YACzC,WAAW;YACX,QAAQ;SACT,CAAC,CAAA;QACF,OAAO,GAAG,CAAC,CAAC,CAAC,CAAA;KACd;IAAC,OAAO,KAAK,EAAE;QACd,IACE,KAAK,YAAY,8BAA8B;YAC9C,KAAK,CAAC,KAAuC,CAAC,MAAM,KAAK,YAAY,CAAC,EAAE,CAAC;YAG1E,OAAO,IAAI,CAAA;QACb,MAAM,KAAK,CAAA;KACZ;AACH,CAAC"}
+{"version":3,"file":"getEnsName.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsName.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EACL,8BAA8B,GAE/B,MAAM,0BAA0B,CAAA;AAGjC,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AAalC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAuC,EACvC,EACE,OAAO,EACP,WAAW,EACX,QAAQ,EACR,wBAAwB,EAAE,yBAAyB,GAC9B;IAEvB,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,WAAW,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,CAAA;IACxE,IAAI;QACF,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;YACrC,OAAO,EAAE,wBAAwB;YACjC,GAAG,EAAE;gBACH;oBACE,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,UAAU;oBAChB,eAAe,EAAE,MAAM;oBACvB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;oBAChD,OAAO,EAAE;wBACP,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,cAAc,EAAE;wBACxC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE;wBAC5C,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE;wBAC5C,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE;qBACtC;iBACF;aACF;YACD,YAAY,EAAE,SAAS;YACvB,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC;YACzC,WAAW;YACX,QAAQ;SACT,CAAC,CAAA;QACF,OAAO,GAAG,CAAC,CAAC,CAAC,CAAA;KACd;IAAC,OAAO,KAAK,EAAE;QACd,IACE,KAAK,YAAY,8BAA8B;YAC9C,KAAK,CAAC,KAAuC,CAAC,MAAM,KAAK,YAAY,CAAC,EAAE,CAAC;YAE1E,mCAAmC;YACnC,OAAO,IAAI,CAAA;QACb,MAAM,KAAK,CAAA;KACZ;AACH,CAAC"}

package/dist/esm/actions/ens/getEnsResolver.js

@@ -2,6 +2,34 @@ import { getChainContractAddress } from '../../utils/chain.js';
 import { toHex } from '../../utils/encoding/toHex.js';
 import { packetToBytes } from '../../utils/ens/packetToBytes.js';
 import { readContract, } from '../public/readContract.js';
+/**
+ * Gets resolver for ENS name.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls `findResolver(bytes)` on ENS Universal Resolver Contract to retrieve the resolver of an ENS name.
+ *
+ * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsResolverParameters}
+ * @returns Address for ENS resolver. {@link GetEnsResolverReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsResolver, normalize } from 'viem/ens'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const resolverAddress = await getEnsResolver(client, {
+ *   name: normalize('wagmi-dev.eth'),
+ * })
+ * // '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41'
+ */
 export async function getEnsResolver(client, { blockNumber, blockTag, name, universalResolverAddress: universalResolverAddress_, }) {
     let universalResolverAddress = universalResolverAddress_;
     if (!universalResolverAddress) {

package/dist/esm/actions/ens/getEnsResolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"getEnsResolver.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsResolver.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AAyClC,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAuC,EACvC,EACE,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,wBAAwB,EAAE,yBAAyB,GAC1B;IAE3B,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,CAAC,eAAe,CAAC,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;QACnD,OAAO,EAAE,wBAAwB;QACjC,GAAG,EAAE;YACH;gBACE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;gBAC3B,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;gBACnD,eAAe,EAAE,MAAM;gBACvB,IAAI,EAAE,UAAU;aACjB;SACF;QACD,YAAY,EAAE,cAAc;QAC5B,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QAClC,WAAW;QACX,QAAQ;KACT,CAAC,CAAA;IACF,OAAO,eAAe,CAAA;AACxB,CAAC"}
+{"version":3,"file":"getEnsResolver.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsResolver.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AAalC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAuC,EACvC,EACE,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,wBAAwB,EAAE,yBAAyB,GAC1B;IAE3B,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,CAAC,eAAe,CAAC,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;QACnD,OAAO,EAAE,wBAAwB;QACjC,GAAG,EAAE;YACH;gBACE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;gBAC3B,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;gBACnD,eAAe,EAAE,MAAM;gBACvB,IAAI,EAAE,UAAU;aACjB;SACF;QACD,YAAY,EAAE,cAAc;QAC5B,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QAClC,WAAW;QACX,QAAQ;KACT,CAAC,CAAA;IACF,OAAO,eAAe,CAAA;AACxB,CAAC"}

package/dist/esm/actions/ens/getEnsText.js

@@ -6,6 +6,35 @@ import { toHex } from '../../utils/encoding/toHex.js';
 import { namehash } from '../../utils/ens/namehash.js';
 import { packetToBytes } from '../../utils/ens/packetToBytes.js';
 import { readContract, } from '../public/readContract.js';
+/**
+ * Gets a text record for specified ENS name.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
+ *
+ * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsTextParameters}
+ * @returns Address for ENS resolver. {@link GetEnsTextReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsText, normalize } from 'viem/ens'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const twitterRecord = await getEnsText(client, {
+ *   name: normalize('wagmi-dev.eth'),
+ *   key: 'com.twitter',
+ * })
+ * // 'wagmi_sh'
+ */
 export async function getEnsText(client, { blockNumber, blockTag, name, key, universalResolverAddress: universalResolverAddress_, }) {
     let universalResolverAddress = universalResolverAddress_;
     if (!universalResolverAddress) {

package/dist/esm/actions/ens/getEnsText.js.map

@@ -1 +1 @@
-{"version":3,"file":"getEnsText.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsText.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAG/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAA;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAA;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AA4ClC,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAuC,EACvC,EACE,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,wBAAwB,EAAE,yBAAyB,GAC9B;IAEvB,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;QACrC,OAAO,EAAE,wBAAwB;QACjC,GAAG,EAAE,oBAAoB;QACzB,YAAY,EAAE,SAAS;QACvB,IAAI,EAAE;YACJ,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC1B,kBAAkB,CAAC;gBACjB,GAAG,EAAE,eAAe;gBACpB,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;aAC5B,CAAC;SACH;QACD,WAAW;QACX,QAAQ;KACT,CAAC,CAAA;IAEF,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAEhC,MAAM,MAAM,GAAG,oBAAoB,CAAC;QAClC,GAAG,EAAE,eAAe;QACpB,YAAY,EAAE,MAAM;QACpB,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;KACb,CAAC,CAAA;IAEF,OAAO,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAA;AACtC,CAAC"}
+{"version":3,"file":"getEnsText.js","sourceRoot":"","sources":["../../../../src/actions/ens/getEnsText.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAG/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAA;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAA;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAA;AAChE,OAAO,EAEL,YAAY,GACb,MAAM,2BAA2B,CAAA;AAelC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,MAAuC,EACvC,EACE,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,wBAAwB,EAAE,yBAAyB,GAC9B;IAEvB,IAAI,wBAAwB,GAAG,yBAAyB,CAAA;IACxD,IAAI,CAAC,wBAAwB,EAAE;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK;YACf,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;QAEH,wBAAwB,GAAG,uBAAuB,CAAC;YACjD,WAAW;YACX,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,sBAAsB;SACjC,CAAC,CAAA;KACH;IAED,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE;QACrC,OAAO,EAAE,wBAAwB;QACjC,GAAG,EAAE,oBAAoB;QACzB,YAAY,EAAE,SAAS;QACvB,IAAI,EAAE;YACJ,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC1B,kBAAkB,CAAC;gBACjB,GAAG,EAAE,eAAe;gBACpB,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;aAC5B,CAAC;SACH;QACD,WAAW;QACX,QAAQ;KACT,CAAC,CAAA;IAEF,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI;QAAE,OAAO,IAAI,CAAA;IAEhC,MAAM,MAAM,GAAG,oBAAoB,CAAC;QAClC,GAAG,EAAE,eAAe;QACpB,YAAY,EAAE,MAAM;QACpB,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;KACb,CAAC,CAAA;IAEF,OAAO,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAA;AACtC,CAAC"}

package/dist/esm/actions/getContract.js

@@ -4,6 +4,31 @@ import { readContract, } from './public/readContract.js';
 import { simulateContract, } from './public/simulateContract.js';
 import { watchContractEvent, } from './public/watchContractEvent.js';
 import { writeContract, } from './wallet/writeContract.js';
+/**
+ * Gets type-safe interface for performing contract-related actions with a specific `abi` and `address`.
+ *
+ * - Docs https://viem.sh/docs/contract/getContract.html
+ *
+ * Using Contract Instances can make it easier to work with contracts if you don't want to pass the `abi` and `address` properites every time you perform contract actions, e.g. [`readContract`](https://viem.sh/docs/contract/readContract.html), [`writeContract`](https://viem.sh/docs/contract/writeContract.html), [`estimateContractGas`](https://viem.sh/docs/contract/estimateContractGas.html), etc.
+ *
+ * @example
+ * import { createPublicClient, getContract, http, parseAbi } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const publicClient = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const contract = getContract({
+ *   address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+ *   abi: parseAbi([
+ *     'function balanceOf(address owner) view returns (uint256)',
+ *     'function ownerOf(uint256 tokenId) view returns (address)',
+ *     'function totalSupply() view returns (uint256)',
+ *   ]),
+ *   publicClient,
+ * })
+ */
 export function getContract({ abi, address, publicClient, walletClient, }) {
     const hasPublicClient = publicClient !== undefined && publicClient !== null;
     const hasWalletClient = walletClient !== undefined && walletClient !== null;
@@ -19,6 +44,7 @@ export function getContract({ abi, address, publicClient, walletClient, }) {
                 hasWriteFunction = true;
         else if (item.type === 'event')
             hasEvent = true;
+        // Exit early if all flags are `true`
         if (hasReadFunction && hasWriteFunction && hasEvent)
             break;
     }
@@ -38,21 +64,7 @@ export function getContract({ abi, address, publicClient, walletClient, }) {
                     };
                 },
             });
-        if (hasWriteFunction) {
-            contract.estimateGas = new Proxy({}, {
-                get(_, functionName) {
-                    return (...parameters) => {
-                        const { args, options } = getFunctionParameters(parameters);
-                        return estimateContractGas(publicClient, {
-                            abi,
-                            address,
-                            functionName,
-                            args,
-                            ...options,
-                        });
-                    };
-                },
-            });
+        if (hasWriteFunction)
             contract.simulate = new Proxy({}, {
                 get(_, functionName) {
                     return (...parameters) => {
@@ -67,7 +79,6 @@ export function getContract({ abi, address, publicClient, walletClient, }) {
                     };
                 },
             });
-        }
         if (hasEvent) {
             contract.createEventFilter = new Proxy({}, {
                 get(_, eventName) {
@@ -118,20 +129,51 @@ export function getContract({ abi, address, publicClient, walletClient, }) {
                 },
             });
     }
+    if (hasPublicClient || hasWalletClient)
+        if (hasWriteFunction)
+            contract.estimateGas = new Proxy({}, {
+                get(_, functionName) {
+                    return (...parameters) => {
+                        const { args, options } = getFunctionParameters(parameters);
+                        const client = (publicClient ?? walletClient);
+                        return estimateContractGas(client, {
+                            abi,
+                            address,
+                            functionName,
+                            args,
+                            ...options,
+                            account: options.account ??
+                                walletClient.account,
+                        });
+                    };
+                },
+            });
+    contract.address = address;
+    contract.abi = abi;
     return contract;
 }
+/**
+ * @internal exporting for testing only
+ */
 export function getFunctionParameters(values) {
     const hasArgs = values.length && Array.isArray(values[0]);
     const args = hasArgs ? values[0] : [];
     const options = (hasArgs ? values[1] : values[0]) ?? {};
     return { args, options };
 }
+/**
+ * @internal exporting for testing only
+ */
 export function getEventParameters(values, abiEvent) {
     let hasArgs = false;
+    // If first item is array, must be `args`
     if (Array.isArray(values[0]))
         hasArgs = true;
+    // Check if first item is `args` or `options`
     else if (values.length === 1) {
+        // if event has indexed inputs, must have `args`
         hasArgs = abiEvent.inputs.some((x) => x.indexed);
+        // If there are two items in array, must have `args`
     }
     else if (values.length === 2) {
         hasArgs = true;