@latticexyz/common 2.2.18-9fa07c8489f1fbf167d0db01cd9aaa645a29c8e2 → 2.2.18-c2ad22c7feb566e1731ff16e8be291746bdffb3e

package/dist/index.cjs

@@ -1,597 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  LruMap: () => LruMap,
-  createBenchmark: () => createBenchmark,
-  createBurnerAccount: () => createBurnerAccount,
-  createContract: () => createContract,
-  createNonceManager: () => createNonceManager,
-  findCause: () => findCause,
-  getBurnerPrivateKey: () => getBurnerPrivateKey,
-  getContract: () => getContract,
-  getNonceManager: () => getNonceManager,
-  getNonceManagerId: () => getNonceManagerId,
-  hexToResource: () => hexToResource,
-  hexToResourceId: () => hexToResourceId,
-  isError: () => isError,
-  isOk: () => isOk,
-  logSort: () => logSort,
-  readHex: () => readHex,
-  resourceIdToHex: () => resourceIdToHex,
-  resourceToHex: () => resourceToHex,
-  resourceToLabel: () => resourceToLabel,
-  resourceTypeIds: () => resourceTypeIds,
-  resourceTypes: () => resourceTypes,
-  sendTransaction: () => sendTransaction,
-  spliceHex: () => spliceHex,
-  transportObserver: () => transportObserver,
-  unwrap: () => unwrap,
-  writeContract: () => writeContract
-});
-module.exports = __toCommonJS(src_exports);
-
-// src/createBenchmark.ts
-var import_debug = __toESM(require("debug"), 1);
-var parentDebug = (0, import_debug.default)("mud:benchmark");
-parentDebug.log = console.info.bind(console);
-function createBenchmark(namespace) {
-  const debug6 = parentDebug.extend(namespace);
-  let lastStep = performance.now();
-  return (stepName) => {
-    const secondsSinceLastStep = (performance.now() - lastStep) / 1e3;
-    debug6("%s: +%ds", stepName, secondsSinceLastStep);
-    lastStep = performance.now();
-  };
-}
-
-// src/createBurnerAccount.ts
-var import_accounts = require("viem/accounts");
-function createBurnerAccount(privateKey) {
-  const account = (0, import_accounts.privateKeyToAccount)(privateKey);
-  return {
-    ...account
-  };
-}
-
-// src/debug.ts
-var import_debug2 = __toESM(require("debug"), 1);
-var debug = (0, import_debug2.default)("mud:common");
-var error = (0, import_debug2.default)("mud:common");
-debug.log = console.debug.bind(console);
-error.log = console.error.bind(console);
-
-// src/getNonceManagerId.ts
-var import_viem = require("viem");
-var import_actions = require("viem/actions");
-var import_utils = require("viem/utils");
-async function getNonceManagerId({
-  client,
-  address,
-  blockTag
-}) {
-  const chainId = client.chain?.id ?? await (0, import_utils.getAction)(client, import_actions.getChainId, "getChainId")({});
-  return `mud:createNonceManager:${chainId}:${(0, import_viem.getAddress)(address)}:${blockTag}`;
-}
-
-// src/createNonceManager.ts
-var import_actions2 = require("viem/actions");
-var import_p_queue = __toESM(require("p-queue"), 1);
-var import_utils2 = require("viem/utils");
-
-// src/findCause.ts
-function findCause(error2, fn) {
-  if (fn?.(error2)) return error2;
-  if (error2.cause instanceof Error) return findCause(error2.cause, fn);
-  return fn ? null : error2;
-}
-
-// src/createNonceManager.ts
-var debug2 = debug.extend("createNonceManager");
-function createNonceManager({
-  client,
-  address,
-  // TODO: rename to account?
-  blockTag = "latest",
-  broadcastChannelName,
-  queueConcurrency = 1
-}) {
-  const ref = { nonce: -1, noncePromise: null };
-  let channel = null;
-  if (typeof BroadcastChannel !== "undefined") {
-    const channelName = broadcastChannelName ? Promise.resolve(broadcastChannelName) : getNonceManagerId({ client, address, blockTag });
-    channelName.then((name) => {
-      channel = new BroadcastChannel(name);
-      channel.addEventListener("message", (event) => {
-        const nonce = JSON.parse(event.data);
-        debug2("got nonce from broadcast channel", nonce);
-        ref.nonce = nonce;
-      });
-    });
-  }
-  function hasNonce() {
-    return ref.nonce >= 0;
-  }
-  function getNonce() {
-    if (!hasNonce()) throw new Error("call resetNonce before using getNonce");
-    return ref.nonce;
-  }
-  function nextNonce() {
-    if (!hasNonce()) throw new Error("call resetNonce before using nextNonce");
-    const nonce = ref.nonce++;
-    channel?.postMessage(JSON.stringify(ref.nonce));
-    return nonce;
-  }
-  async function resetNonce() {
-    ref.noncePromise ??= (async () => {
-      ref.nonce = await (0, import_utils2.getAction)(client, import_actions2.getTransactionCount, "getTransactionCount")({ address, blockTag });
-      ref.noncePromise = null;
-      channel?.postMessage(JSON.stringify(ref.nonce));
-      debug2("reset nonce to", ref.nonce);
-    })();
-    await ref.noncePromise;
-  }
-  function shouldResetNonce(error2) {
-    const nonceError = findCause(error2, ({ name }) => name === "NonceTooLowError" || name === "NonceTooHighError");
-    return nonceError != null;
-  }
-  const mempoolQueue = new import_p_queue.default({ concurrency: queueConcurrency });
-  return {
-    hasNonce,
-    getNonce,
-    nextNonce,
-    resetNonce,
-    shouldResetNonce,
-    mempoolQueue
-  };
-}
-
-// src/getBurnerPrivateKey.ts
-var import_accounts2 = require("viem/accounts");
-var import_viem2 = require("viem");
-function assertPrivateKey(privateKey, cacheKey) {
-  if (!(0, import_viem2.isHex)(privateKey)) {
-    console.error("Private key found in cache is not valid hex", { privateKey, cacheKey });
-    throw new Error(`Private key found in cache (${cacheKey}) is not valid hex`);
-  }
-  (0, import_accounts2.privateKeyToAccount)(privateKey);
-}
-function getBurnerPrivateKey(cacheKey = "mud:burnerWallet") {
-  const cachedPrivateKey = localStorage.getItem(cacheKey);
-  if (cachedPrivateKey != null) {
-    assertPrivateKey(cachedPrivateKey, cacheKey);
-    return cachedPrivateKey;
-  }
-  const privateKey = (0, import_accounts2.generatePrivateKey)();
-  console.log("New burner wallet created:", (0, import_accounts2.privateKeyToAccount)(privateKey));
-  localStorage.setItem(cacheKey, privateKey);
-  return privateKey;
-}
-
-// src/getContract.ts
-var import_viem3 = require("viem");
-
-// src/writeContract.ts
-var import_actions5 = require("viem/actions");
-var import_p_retry = __toESM(require("p-retry"), 1);
-
-// src/getNonceManager.ts
-var nonceManagers = /* @__PURE__ */ new Map();
-async function getNonceManager({
-  client,
-  address,
-  // TODO: rename to account?
-  blockTag = "latest",
-  ...opts
-}) {
-  const id = await getNonceManagerId({ client, address, blockTag });
-  const nonceManager = nonceManagers.get(id) ?? createNonceManager({ client, address, blockTag, ...opts });
-  if (!nonceManagers.has(id)) {
-    nonceManagers.set(id, nonceManager);
-  }
-  if (!nonceManager.hasNonce()) {
-    await nonceManager.resetNonce();
-  }
-  return nonceManager;
-}
-
-// src/writeContract.ts
-var import_accounts3 = require("viem/accounts");
-
-// src/getFeeRef.ts
-var import_actions4 = require("viem/actions");
-
-// src/createFeeRef.ts
-var import_actions3 = require("viem/actions");
-var import_utils3 = require("viem/utils");
-async function createFeeRef({ client, args, refreshInterval }) {
-  const feeRef = { fees: {}, lastUpdatedTimestamp: 0 };
-  async function updateFees() {
-    const fees = await (0, import_utils3.getAction)(client, import_actions3.estimateFeesPerGas, "estimateFeesPerGas")(args);
-    feeRef.fees = fees;
-    feeRef.lastUpdatedTimestamp = Date.now();
-  }
-  setInterval(updateFees, refreshInterval);
-  await updateFees();
-  return feeRef;
-}
-
-// src/getFeeRef.ts
-var import_utils4 = require("viem/utils");
-var feeRefs = /* @__PURE__ */ new Map();
-async function getFeeRef(opts) {
-  const chainId = opts.args?.chain?.id ?? opts.client.chain?.id ?? await (0, import_utils4.getAction)(opts.client, import_actions4.getChainId, "getChainId")({});
-  const existingFeeRef = feeRefs.get(chainId);
-  if (existingFeeRef) {
-    return existingFeeRef;
-  }
-  const feeRef = await createFeeRef(opts);
-  feeRefs.set(chainId, feeRef);
-  return feeRef;
-}
-
-// src/writeContract.ts
-var import_utils5 = require("viem/utils");
-var debug3 = debug.extend("writeContract");
-async function writeContract(client, request, opts = {}) {
-  const rawAccount = request.account ?? client.account;
-  if (!rawAccount) {
-    throw new Error("No account provided");
-  }
-  const account = (0, import_accounts3.parseAccount)(rawAccount);
-  const chain = client.chain;
-  const nonceManager = await getNonceManager({
-    client: opts.publicClient ?? client,
-    address: account.address,
-    queueConcurrency: opts.queueConcurrency
-  });
-  const feeRef = await getFeeRef({
-    client: opts.publicClient ?? client,
-    refreshInterval: 1e4,
-    args: { chain }
-  });
-  return nonceManager.mempoolQueue.add(
-    () => (0, import_p_retry.default)(
-      async () => {
-        const nonce = nonceManager.nextNonce();
-        const params = {
-          // viem_writeContract internally estimates gas, which we want to happen on the pending block
-          blockTag: "pending",
-          ...feeRef.fees,
-          ...request,
-          nonce
-        };
-        debug3("calling", params.functionName, "at", params.address, "with nonce", nonce);
-        return await (0, import_utils5.getAction)(client, import_actions5.writeContract, "writeContract")(params);
-      },
-      {
-        retries: 3,
-        onFailedAttempt: async (error2) => {
-          debug3("failed, resetting nonce");
-          await nonceManager.resetNonce();
-          if (nonceManager.shouldResetNonce(error2)) {
-            debug3("got nonce error, retrying", error2.message);
-            return;
-          }
-          if (String(error2).includes("transaction underpriced")) {
-            debug3("got transaction underpriced error, retrying", error2.message);
-            return;
-          }
-          throw error2;
-        }
-      }
-    ),
-    { throwOnTimeout: true }
-  );
-}
-
-// src/getContract.ts
-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 };
-}
-function getContract({
-  abi,
-  address,
-  client: { public: publicClient, wallet: walletClient },
-  onWrite
-}) {
-  const contract = (0, import_viem3.getContract)({
-    abi,
-    address,
-    client: {
-      public: publicClient,
-      wallet: walletClient
-    }
-  });
-  if (contract.write) {
-    let nextWriteId = 0;
-    contract.write = new Proxy(
-      {},
-      {
-        get(_, functionName) {
-          return (...parameters) => {
-            const { args, options } = getFunctionParameters(parameters);
-            const request = {
-              abi,
-              address,
-              functionName,
-              args,
-              ...options,
-              onWrite
-            };
-            const result = writeContract(walletClient, request, { publicClient });
-            const id = `${walletClient.chain.id}:${walletClient.account.address}:${nextWriteId++}`;
-            onWrite?.({
-              id,
-              request,
-              result
-            });
-            return result;
-          };
-        }
-      }
-    );
-  }
-  return contract;
-}
-
-// src/hexToResource.ts
-var import_viem5 = require("viem");
-
-// src/resourceTypes.ts
-var resourceTypes = ["table", "offchainTable", "namespace", "system"];
-
-// src/resourceToHex.ts
-var import_viem4 = require("viem");
-var resourceTypeIds = {
-  // keep these in sync with storeResourceTypes.sol
-  table: "tb",
-  offchainTable: "ot",
-  // keep these in sync with worldResourceTypes.sol
-  namespace: "ns",
-  system: "sy"
-};
-function resourceToHex(resource) {
-  const typeId = resourceTypeIds[resource.type];
-  if (resource.namespace.length > 14) {
-    throw new Error(`Namespaces must fit into \`bytes14\`, but "${resource.namespace}" is too long.`);
-  }
-  return (0, import_viem4.concatHex)([
-    (0, import_viem4.stringToHex)(typeId, { size: 2 }),
-    (0, import_viem4.stringToHex)(resource.namespace, { size: 14 }),
-    (0, import_viem4.stringToHex)(resource.name.slice(0, 16), { size: 16 })
-  ]);
-}
-
-// src/resourceToLabel.ts
-var rootNamespace = "";
-function resourceToLabel({
-  namespace,
-  name
-}) {
-  return namespace === rootNamespace ? name : `${namespace}__${name}`;
-}
-
-// src/hexToResource.ts
-var resourceTypeIdToType = Object.fromEntries(
-  Object.entries(resourceTypeIds).map(([key, value]) => [value, key])
-);
-function getResourceType(resourceTypeId) {
-  const type = resourceTypeIdToType[resourceTypeId];
-  if (resourceTypes.includes(type)) {
-    return type;
-  }
-}
-function hexToResource(hex) {
-  const resourceTypeId = (0, import_viem5.hexToString)((0, import_viem5.sliceHex)(hex, 0, 2)).replace(/\0+$/, "");
-  const type = getResourceType(resourceTypeId);
-  const namespace = (0, import_viem5.hexToString)((0, import_viem5.sliceHex)(hex, 2, 16)).replace(/\0+$/, "");
-  const name = (0, import_viem5.hexToString)((0, import_viem5.sliceHex)(hex, 16, 32)).replace(/\0+$/, "");
-  if (!type) {
-    throw new Error(`Unknown type (${resourceTypeId}) for resource (${resourceToLabel({ namespace, name })})`);
-  }
-  return { resourceId: hex, type, namespace, name };
-}
-
-// src/logSort.ts
-function logSort(a, b) {
-  if (a.blockNumber === b.blockNumber) {
-    if (a.logIndex === b.logIndex) return 0;
-    if (a.logIndex == null) return 1;
-    if (b.logIndex == null) return -1;
-    return a.logIndex - b.logIndex;
-  }
-  if (a.blockNumber == null) return 1;
-  if (b.blockNumber == null) return -1;
-  if (a.blockNumber > b.blockNumber) return 1;
-  if (a.blockNumber < b.blockNumber) return -1;
-  return 0;
-}
-
-// src/LruMap.ts
-var LruMap = class extends Map {
-  constructor(size) {
-    super();
-    this.maxSize = size;
-  }
-  set(key, value) {
-    super.set(key, value);
-    if (this.maxSize && this.size > this.maxSize) {
-      this.delete(this.keys().next().value);
-    }
-    return this;
-  }
-};
-
-// src/readHex.ts
-function readHex(data, start, end) {
-  return `0x${data.replace(/^0x/, "").slice(start * 2, end != null ? end * 2 : void 0).padEnd(((end ?? start) - start) * 2, "0")}`;
-}
-
-// src/result.ts
-function isOk(result) {
-  return "ok" in result;
-}
-function isError(result) {
-  return "error" in result;
-}
-function unwrap(result) {
-  if (isError(result)) {
-    throw result.error;
-  }
-  return result.ok;
-}
-
-// src/sendTransaction.ts
-var import_actions6 = require("viem/actions");
-var import_p_retry2 = __toESM(require("p-retry"), 1);
-var import_accounts4 = require("viem/accounts");
-var import_utils6 = require("viem/utils");
-var debug4 = debug.extend("sendTransaction");
-async function sendTransaction(client, request, opts = {}) {
-  const rawAccount = request.account ?? client.account;
-  if (!rawAccount) {
-    throw new Error("No account provided");
-  }
-  const account = (0, import_accounts4.parseAccount)(rawAccount);
-  const chain = client.chain;
-  const nonceManager = await getNonceManager({
-    client: opts.publicClient ?? client,
-    address: account.address,
-    queueConcurrency: opts.queueConcurrency
-  });
-  const feeRef = await getFeeRef({
-    client: opts.publicClient ?? client,
-    refreshInterval: 1e4,
-    args: { chain }
-  });
-  return await nonceManager.mempoolQueue.add(
-    () => (0, import_p_retry2.default)(
-      async () => {
-        const nonce = nonceManager.nextNonce();
-        const params = {
-          // viem_sendTransaction internally estimates gas, which we want to happen on the pending block
-          blockTag: "pending",
-          ...feeRef.fees,
-          ...request,
-          nonce
-        };
-        debug4("sending tx to", request.to, "with nonce", nonce);
-        return await (0, import_utils6.getAction)(client, import_actions6.sendTransaction, "sendTransaction")(params);
-      },
-      {
-        retries: 3,
-        onFailedAttempt: async (error2) => {
-          debug4("failed, resetting nonce");
-          await nonceManager.resetNonce();
-          if (nonceManager.shouldResetNonce(error2)) {
-            debug4("got nonce error, retrying", error2.message);
-            return;
-          }
-          if (String(error2).includes("transaction underpriced")) {
-            debug4("got transaction underpriced error, retrying", error2.message);
-            return;
-          }
-          throw error2;
-        }
-      }
-    ),
-    { throwOnTimeout: true }
-  );
-}
-
-// src/spliceHex.ts
-var import_viem6 = require("viem");
-function spliceHex(data, start, deleteCount = 0, newData = "0x") {
-  return (0, import_viem6.concatHex)([readHex(data, 0, start), newData, readHex(data, start + deleteCount)]);
-}
-
-// src/transportObserver.ts
-var import_viem7 = require("viem");
-var debug5 = debug.extend("transportObserver");
-function transportObserver(transport) {
-  return (opts) => {
-    const result = transport(opts);
-    const request = async (req) => {
-      if (req.method === "eth_sendRawTransaction" && req.params instanceof Array) {
-        const txs = req.params.map((data) => (0, import_viem7.keccak256)(data));
-        debug5("saw txs", txs);
-      }
-      return result.request(req);
-    };
-    return {
-      ...result,
-      request
-    };
-  };
-}
-
-// src/deprecated/createContract.ts
-var createContract = getContract;
-
-// src/deprecated/resourceIdToHex.ts
-var resourceIdToHex = resourceToHex;
-
-// src/deprecated/hexToResourceId.ts
-var hexToResourceId = hexToResource;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  LruMap,
-  createBenchmark,
-  createBurnerAccount,
-  createContract,
-  createNonceManager,
-  findCause,
-  getBurnerPrivateKey,
-  getContract,
-  getNonceManager,
-  getNonceManagerId,
-  hexToResource,
-  hexToResourceId,
-  isError,
-  isOk,
-  logSort,
-  readHex,
-  resourceIdToHex,
-  resourceToHex,
-  resourceToLabel,
-  resourceTypeIds,
-  resourceTypes,
-  sendTransaction,
-  spliceHex,
-  transportObserver,
-  unwrap,
-  writeContract
-});
-//# sourceMappingURL=index.cjs.map