starknet 6.9.0 → 6.10.1

package/dist/channel/rpc_0_6.mjs

@@ -0,0 +1,543 @@
+import { NetworkName } from "../constants.mjs";
+import { LibraryError } from "../provider/errors.mjs";
+import {
+  BlockTag,
+  TransactionType
+} from "../types/index.mjs";
+import { RPCSPEC06 as RPC } from "../types/api/index.mjs";
+import { CallData } from "../utils/calldata/index.mjs";
+import { isSierra } from "../utils/contract.mjs";
+import { validateAndParseEthAddress } from "../utils/eth.mjs";
+import fetch from "../utils/fetchPonyfill.mjs";
+import { getSelector, getSelectorFromName } from "../utils/hash/index.mjs";
+import { stringify } from "../utils/json.mjs";
+import { getHexStringArray, toHex, toStorageKey } from "../utils/num.mjs";
+import { Block, getDefaultNodeUrl, isV3Tx, isVersion, wait } from "../utils/provider.mjs";
+import { decompressProgram, signatureToHexArray } from "../utils/stark.mjs";
+import { getVersionsByType } from "../utils/transaction.mjs";
+const defaultOptions = {
+  headers: { "Content-Type": "application/json" },
+  blockIdentifier: BlockTag.PENDING,
+  retries: 200
+};
+export class RpcChannel {
+  nodeUrl;
+  headers;
+  retries;
+  requestId;
+  blockIdentifier;
+  chainId;
+  specVersion;
+  waitMode;
+  // behave like web2 rpc and return when tx is processed
+  constructor(optionsOrProvider) {
+    const { nodeUrl, retries, headers, blockIdentifier, chainId, specVersion, waitMode } = optionsOrProvider || {};
+    if (Object.values(NetworkName).includes(nodeUrl)) {
+      this.nodeUrl = getDefaultNodeUrl(nodeUrl, optionsOrProvider?.default);
+    } else if (nodeUrl) {
+      this.nodeUrl = nodeUrl;
+    } else {
+      this.nodeUrl = getDefaultNodeUrl(void 0, optionsOrProvider?.default);
+    }
+    this.retries = retries || defaultOptions.retries;
+    this.headers = { ...defaultOptions.headers, ...headers };
+    this.blockIdentifier = blockIdentifier || defaultOptions.blockIdentifier;
+    this.chainId = chainId;
+    this.specVersion = specVersion;
+    this.waitMode = waitMode || false;
+    this.requestId = 0;
+  }
+  setChainId(chainId) {
+    this.chainId = chainId;
+  }
+  fetch(method, params, id = 0) {
+    const rpcRequestBody = {
+      id,
+      jsonrpc: "2.0",
+      method,
+      ...params && { params }
+    };
+    return fetch(this.nodeUrl, {
+      method: "POST",
+      body: stringify(rpcRequestBody),
+      headers: this.headers
+    });
+  }
+  errorHandler(method, params, rpcError, otherError) {
+    if (rpcError) {
+      const { code, message, data } = rpcError;
+      throw new LibraryError(
+        `RPC: ${method} with params ${stringify(params, null, 2)}
+
+        ${code}: ${message}: ${stringify(data)}`
+      );
+    }
+    if (otherError instanceof LibraryError) {
+      throw otherError;
+    }
+    if (otherError) {
+      throw Error(otherError.message);
+    }
+  }
+  async fetchEndpoint(method, params) {
+    try {
+      const rawResult = await this.fetch(method, params, this.requestId += 1);
+      const { error, result } = await rawResult.json();
+      this.errorHandler(method, params, error);
+      return result;
+    } catch (error) {
+      this.errorHandler(method, params, error?.response?.data, error);
+      throw error;
+    }
+  }
+  async getChainId() {
+    this.chainId ??= await this.fetchEndpoint("starknet_chainId");
+    return this.chainId;
+  }
+  async getSpecVersion() {
+    this.specVersion ??= await this.fetchEndpoint("starknet_specVersion");
+    return this.specVersion;
+  }
+  getNonceForAddress(contractAddress, blockIdentifier = this.blockIdentifier) {
+    const contract_address = toHex(contractAddress);
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_getNonce", {
+      contract_address,
+      block_id
+    });
+  }
+  /**
+   * Get the most recent accepted block hash and number
+   */
+  getBlockLatestAccepted() {
+    return this.fetchEndpoint("starknet_blockHashAndNumber");
+  }
+  /**
+   * Get the most recent accepted block number
+   * redundant use getBlockLatestAccepted();
+   * @returns Number of the latest block
+   */
+  getBlockNumber() {
+    return this.fetchEndpoint("starknet_blockNumber");
+  }
+  getBlockWithTxHashes(blockIdentifier = this.blockIdentifier) {
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_getBlockWithTxHashes", { block_id });
+  }
+  getBlockWithTxs(blockIdentifier = this.blockIdentifier) {
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_getBlockWithTxs", { block_id });
+  }
+  getBlockStateUpdate(blockIdentifier = this.blockIdentifier) {
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_getStateUpdate", { block_id });
+  }
+  getBlockTransactionsTraces(blockIdentifier = this.blockIdentifier) {
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_traceBlockTransactions", { block_id });
+  }
+  getBlockTransactionCount(blockIdentifier = this.blockIdentifier) {
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_getBlockTransactionCount", { block_id });
+  }
+  getTransactionByHash(txHash) {
+    const transaction_hash = toHex(txHash);
+    return this.fetchEndpoint("starknet_getTransactionByHash", {
+      transaction_hash
+    });
+  }
+  getTransactionByBlockIdAndIndex(blockIdentifier, index) {
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_getTransactionByBlockIdAndIndex", { block_id, index });
+  }
+  getTransactionReceipt(txHash) {
+    const transaction_hash = toHex(txHash);
+    return this.fetchEndpoint("starknet_getTransactionReceipt", { transaction_hash });
+  }
+  getTransactionTrace(txHash) {
+    const transaction_hash = toHex(txHash);
+    return this.fetchEndpoint("starknet_traceTransaction", { transaction_hash });
+  }
+  /**
+   * Get the status of a transaction
+   */
+  getTransactionStatus(transactionHash) {
+    const transaction_hash = toHex(transactionHash);
+    return this.fetchEndpoint("starknet_getTransactionStatus", { transaction_hash });
+  }
+  /**
+   * @param invocations AccountInvocations
+   * @param simulateTransactionOptions blockIdentifier and flags to skip validation and fee charge<br/>
+   * - blockIdentifier<br/>
+   * - skipValidate (default false)<br/>
+   * - skipFeeCharge (default true)<br/>
+   */
+  simulateTransaction(invocations, simulateTransactionOptions = {}) {
+    const {
+      blockIdentifier = this.blockIdentifier,
+      skipValidate = true,
+      skipFeeCharge = true
+    } = simulateTransactionOptions;
+    const block_id = new Block(blockIdentifier).identifier;
+    const simulationFlags = [];
+    if (skipValidate) simulationFlags.push(RPC.ESimulationFlag.SKIP_VALIDATE);
+    if (skipFeeCharge) simulationFlags.push(RPC.ESimulationFlag.SKIP_FEE_CHARGE);
+    return this.fetchEndpoint("starknet_simulateTransactions", {
+      block_id,
+      transactions: invocations.map((it) => this.buildTransaction(it)),
+      simulation_flags: simulationFlags
+    });
+  }
+  async waitForTransaction(txHash, options) {
+    const transactionHash = toHex(txHash);
+    let { retries } = this;
+    let onchain = false;
+    let isErrorState = false;
+    const retryInterval = options?.retryInterval ?? 5e3;
+    const errorStates = options?.errorStates ?? [
+      RPC.ETransactionStatus.REJECTED
+      // TODO: commented out to preserve the long-standing behavior of "reverted" not being treated as an error by default
+      // should decide which behavior to keep in the future
+      // RPC.ETransactionExecutionStatus.REVERTED,
+    ];
+    const successStates = options?.successStates ?? [
+      RPC.ETransactionExecutionStatus.SUCCEEDED,
+      RPC.ETransactionStatus.ACCEPTED_ON_L2,
+      RPC.ETransactionStatus.ACCEPTED_ON_L1
+    ];
+    let txStatus;
+    while (!onchain) {
+      await wait(retryInterval);
+      try {
+        txStatus = await this.getTransactionStatus(transactionHash);
+        const executionStatus = txStatus.execution_status;
+        const finalityStatus = txStatus.finality_status;
+        if (!finalityStatus) {
+          const error = new Error("waiting for transaction status");
+          throw error;
+        }
+        if (errorStates.includes(executionStatus) || errorStates.includes(finalityStatus)) {
+          const message = `${executionStatus}: ${finalityStatus}`;
+          const error = new Error(message);
+          error.response = txStatus;
+          isErrorState = true;
+          throw error;
+        } else if (successStates.includes(executionStatus) || successStates.includes(finalityStatus)) {
+          onchain = true;
+        }
+      } catch (error) {
+        if (error instanceof Error && isErrorState) {
+          throw error;
+        }
+        if (retries <= 0) {
+          throw new Error(`waitForTransaction timed-out with retries ${this.retries}`);
+        }
+      }
+      retries -= 1;
+    }
+    let txReceipt = null;
+    while (txReceipt === null) {
+      try {
+        txReceipt = await this.getTransactionReceipt(transactionHash);
+      } catch (error) {
+        if (retries <= 0) {
+          throw new Error(`waitForTransaction timed-out with retries ${this.retries}`);
+        }
+      }
+      retries -= 1;
+      await wait(retryInterval);
+    }
+    return txReceipt;
+  }
+  getStorageAt(contractAddress, key, blockIdentifier = this.blockIdentifier) {
+    const contract_address = toHex(contractAddress);
+    const parsedKey = toStorageKey(key);
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_getStorageAt", {
+      contract_address,
+      key: parsedKey,
+      block_id
+    });
+  }
+  getClassHashAt(contractAddress, blockIdentifier = this.blockIdentifier) {
+    const contract_address = toHex(contractAddress);
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_getClassHashAt", {
+      block_id,
+      contract_address
+    });
+  }
+  getClass(classHash, blockIdentifier = this.blockIdentifier) {
+    const class_hash = toHex(classHash);
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_getClass", {
+      class_hash,
+      block_id
+    });
+  }
+  getClassAt(contractAddress, blockIdentifier = this.blockIdentifier) {
+    const contract_address = toHex(contractAddress);
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_getClassAt", {
+      block_id,
+      contract_address
+    });
+  }
+  async getEstimateFee(invocations, { blockIdentifier = this.blockIdentifier, skipValidate = true }) {
+    const block_id = new Block(blockIdentifier).identifier;
+    let flags = {};
+    if (!isVersion("0.5", await this.getSpecVersion())) {
+      flags = {
+        simulation_flags: skipValidate ? [RPC.ESimulationFlag.SKIP_VALIDATE] : []
+      };
+    }
+    return this.fetchEndpoint("starknet_estimateFee", {
+      request: invocations.map((it) => this.buildTransaction(it, "fee")),
+      block_id,
+      ...flags
+    });
+  }
+  async invoke(functionInvocation, details) {
+    let promise;
+    if (!isV3Tx(details)) {
+      promise = this.fetchEndpoint("starknet_addInvokeTransaction", {
+        invoke_transaction: {
+          sender_address: functionInvocation.contractAddress,
+          calldata: CallData.toHex(functionInvocation.calldata),
+          type: RPC.ETransactionType.INVOKE,
+          max_fee: toHex(details.maxFee || 0),
+          version: RPC.ETransactionVersion.V1,
+          signature: signatureToHexArray(functionInvocation.signature),
+          nonce: toHex(details.nonce)
+        }
+      });
+    } else {
+      promise = this.fetchEndpoint("starknet_addInvokeTransaction", {
+        invoke_transaction: {
+          type: RPC.ETransactionType.INVOKE,
+          sender_address: functionInvocation.contractAddress,
+          calldata: CallData.toHex(functionInvocation.calldata),
+          version: RPC.ETransactionVersion.V3,
+          signature: signatureToHexArray(functionInvocation.signature),
+          nonce: toHex(details.nonce),
+          resource_bounds: details.resourceBounds,
+          tip: toHex(details.tip),
+          paymaster_data: details.paymasterData.map((it) => toHex(it)),
+          account_deployment_data: details.accountDeploymentData.map((it) => toHex(it)),
+          nonce_data_availability_mode: details.nonceDataAvailabilityMode,
+          fee_data_availability_mode: details.feeDataAvailabilityMode
+        }
+      });
+    }
+    return this.waitMode ? this.waitForTransaction((await promise).transaction_hash) : promise;
+  }
+  async declare({ contract, signature, senderAddress, compiledClassHash }, details) {
+    let promise;
+    if (!isSierra(contract) && !isV3Tx(details)) {
+      promise = this.fetchEndpoint("starknet_addDeclareTransaction", {
+        declare_transaction: {
+          type: RPC.ETransactionType.DECLARE,
+          contract_class: {
+            program: contract.program,
+            entry_points_by_type: contract.entry_points_by_type,
+            abi: contract.abi
+          },
+          version: RPC.ETransactionVersion.V1,
+          max_fee: toHex(details.maxFee || 0),
+          signature: signatureToHexArray(signature),
+          sender_address: senderAddress,
+          nonce: toHex(details.nonce)
+        }
+      });
+    } else if (isSierra(contract) && !isV3Tx(details)) {
+      promise = this.fetchEndpoint("starknet_addDeclareTransaction", {
+        declare_transaction: {
+          type: RPC.ETransactionType.DECLARE,
+          contract_class: {
+            sierra_program: decompressProgram(contract.sierra_program),
+            contract_class_version: contract.contract_class_version,
+            entry_points_by_type: contract.entry_points_by_type,
+            abi: contract.abi
+          },
+          compiled_class_hash: compiledClassHash || "",
+          version: RPC.ETransactionVersion.V2,
+          max_fee: toHex(details.maxFee || 0),
+          signature: signatureToHexArray(signature),
+          sender_address: senderAddress,
+          nonce: toHex(details.nonce)
+        }
+      });
+    } else if (isSierra(contract) && isV3Tx(details)) {
+      promise = this.fetchEndpoint("starknet_addDeclareTransaction", {
+        declare_transaction: {
+          type: RPC.ETransactionType.DECLARE,
+          sender_address: senderAddress,
+          compiled_class_hash: compiledClassHash || "",
+          version: RPC.ETransactionVersion.V3,
+          signature: signatureToHexArray(signature),
+          nonce: toHex(details.nonce),
+          contract_class: {
+            sierra_program: decompressProgram(contract.sierra_program),
+            contract_class_version: contract.contract_class_version,
+            entry_points_by_type: contract.entry_points_by_type,
+            abi: contract.abi
+          },
+          resource_bounds: details.resourceBounds,
+          tip: toHex(details.tip),
+          paymaster_data: details.paymasterData.map((it) => toHex(it)),
+          account_deployment_data: details.accountDeploymentData.map((it) => toHex(it)),
+          nonce_data_availability_mode: details.nonceDataAvailabilityMode,
+          fee_data_availability_mode: details.feeDataAvailabilityMode
+        }
+      });
+    } else {
+      throw Error("declare unspotted parameters");
+    }
+    return this.waitMode ? this.waitForTransaction((await promise).transaction_hash) : promise;
+  }
+  async deployAccount({ classHash, constructorCalldata, addressSalt, signature }, details) {
+    let promise;
+    if (!isV3Tx(details)) {
+      promise = this.fetchEndpoint("starknet_addDeployAccountTransaction", {
+        deploy_account_transaction: {
+          constructor_calldata: CallData.toHex(constructorCalldata || []),
+          class_hash: toHex(classHash),
+          contract_address_salt: toHex(addressSalt || 0),
+          type: RPC.ETransactionType.DEPLOY_ACCOUNT,
+          max_fee: toHex(details.maxFee || 0),
+          version: RPC.ETransactionVersion.V1,
+          signature: signatureToHexArray(signature),
+          nonce: toHex(details.nonce)
+        }
+      });
+    } else {
+      promise = this.fetchEndpoint("starknet_addDeployAccountTransaction", {
+        deploy_account_transaction: {
+          type: RPC.ETransactionType.DEPLOY_ACCOUNT,
+          version: RPC.ETransactionVersion.V3,
+          signature: signatureToHexArray(signature),
+          nonce: toHex(details.nonce),
+          contract_address_salt: toHex(addressSalt || 0),
+          constructor_calldata: CallData.toHex(constructorCalldata || []),
+          class_hash: toHex(classHash),
+          resource_bounds: details.resourceBounds,
+          tip: toHex(details.tip),
+          paymaster_data: details.paymasterData.map((it) => toHex(it)),
+          nonce_data_availability_mode: details.nonceDataAvailabilityMode,
+          fee_data_availability_mode: details.feeDataAvailabilityMode
+        }
+      });
+    }
+    return this.waitMode ? this.waitForTransaction((await promise).transaction_hash) : promise;
+  }
+  callContract(call, blockIdentifier = this.blockIdentifier) {
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_call", {
+      request: {
+        contract_address: call.contractAddress,
+        entry_point_selector: getSelectorFromName(call.entrypoint),
+        calldata: CallData.toHex(call.calldata)
+      },
+      block_id
+    });
+  }
+  /**
+   * NEW: Estimate the fee for a message from L1
+   * @param message Message From L1
+   */
+  estimateMessageFee(message, blockIdentifier = this.blockIdentifier) {
+    const { from_address, to_address, entry_point_selector, payload } = message;
+    const formattedMessage = {
+      from_address: validateAndParseEthAddress(from_address),
+      to_address: toHex(to_address),
+      entry_point_selector: getSelector(entry_point_selector),
+      payload: getHexStringArray(payload)
+    };
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint("starknet_estimateMessageFee", {
+      message: formattedMessage,
+      block_id
+    });
+  }
+  /**
+   * Returns an object about the sync status, or false if the node is not synching
+   * @returns Object with the stats data
+   */
+  getSyncingStats() {
+    return this.fetchEndpoint("starknet_syncing");
+  }
+  /**
+   * Returns all events matching the given filter
+   * @returns events and the pagination of the events
+   */
+  getEvents(eventFilter) {
+    return this.fetchEndpoint("starknet_getEvents", { filter: eventFilter });
+  }
+  buildTransaction(invocation, versionType) {
+    const defaultVersions = getVersionsByType(versionType);
+    let details;
+    if (!isV3Tx(invocation)) {
+      details = {
+        signature: signatureToHexArray(invocation.signature),
+        nonce: toHex(invocation.nonce),
+        max_fee: toHex(invocation.maxFee || 0)
+      };
+    } else {
+      details = {
+        signature: signatureToHexArray(invocation.signature),
+        nonce: toHex(invocation.nonce),
+        resource_bounds: invocation.resourceBounds,
+        tip: toHex(invocation.tip),
+        paymaster_data: invocation.paymasterData.map((it) => toHex(it)),
+        nonce_data_availability_mode: invocation.nonceDataAvailabilityMode,
+        fee_data_availability_mode: invocation.feeDataAvailabilityMode,
+        account_deployment_data: invocation.accountDeploymentData.map((it) => toHex(it))
+      };
+    }
+    if (invocation.type === TransactionType.INVOKE) {
+      return {
+        // v0 v1 v3
+        type: RPC.ETransactionType.INVOKE,
+        sender_address: invocation.contractAddress,
+        calldata: CallData.toHex(invocation.calldata),
+        version: toHex(invocation.version || defaultVersions.v3),
+        ...details
+      };
+    }
+    if (invocation.type === TransactionType.DECLARE) {
+      if (!isSierra(invocation.contract)) {
+        return {
+          type: invocation.type,
+          contract_class: invocation.contract,
+          sender_address: invocation.senderAddress,
+          version: toHex(invocation.version || defaultVersions.v1),
+          ...details
+        };
+      }
+      return {
+        // Cairo 1 - v2 v3
+        type: invocation.type,
+        contract_class: {
+          ...invocation.contract,
+          sierra_program: decompressProgram(invocation.contract.sierra_program)
+        },
+        compiled_class_hash: invocation.compiledClassHash || "",
+        sender_address: invocation.senderAddress,
+        version: toHex(invocation.version || defaultVersions.v3),
+        ...details
+      };
+    }
+    if (invocation.type === TransactionType.DEPLOY_ACCOUNT) {
+      const { account_deployment_data, ...restDetails } = details;
+      return {
+        type: invocation.type,
+        constructor_calldata: CallData.toHex(invocation.constructorCalldata || []),
+        class_hash: toHex(invocation.classHash),
+        contract_address_salt: toHex(invocation.addressSalt || 0),
+        version: toHex(invocation.version || defaultVersions.v3),
+        ...restDetails
+      };
+    }
+    throw Error("RPC buildTransaction received unknown TransactionType");
+  }
+}