starknet 3.18.2 → 4.0.1

package/provider/errors.d.ts

@@ -1,9 +1,9 @@
 import { CustomError } from 'ts-custom-error';
 export declare class GatewayError extends CustomError {
-  errorCode: string;
-  constructor(message: string, errorCode: string);
+    errorCode: string;
+    constructor(message: string, errorCode: string);
 }
 export declare class HttpError extends CustomError {
-  errorCode: number;
-  constructor(message: string, errorCode: number);
+    errorCode: number;
+    constructor(message: string, errorCode: number);
 }

package/provider/errors.js

@@ -1,50 +1,40 @@
-'use strict';
-var __extends =
-  (this && this.__extends) ||
-  (function () {
+"use strict";
+var __extends = (this && this.__extends) || (function () {
     var extendStatics = function (d, b) {
-      extendStatics =
-        Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array &&
-          function (d, b) {
-            d.__proto__ = b;
-          }) ||
-        function (d, b) {
-          for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p];
-        };
-      return extendStatics(d, b);
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
     };
     return function (d, b) {
-      if (typeof b !== 'function' && b !== null)
-        throw new TypeError('Class extends value ' + String(b) + ' is not a constructor or null');
-      extendStatics(d, b);
-      function __() {
-        this.constructor = d;
-      }
-      d.prototype = b === null ? Object.create(b) : ((__.prototype = b.prototype), new __());
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
-  })();
-Object.defineProperty(exports, '__esModule', { value: true });
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpError = exports.GatewayError = void 0;
 /* eslint-disable max-classes-per-file */
-var ts_custom_error_1 = require('ts-custom-error');
+var ts_custom_error_1 = require("ts-custom-error");
 var GatewayError = /** @class */ (function (_super) {
-  __extends(GatewayError, _super);
-  function GatewayError(message, errorCode) {
-    var _this = _super.call(this, message) || this;
-    _this.errorCode = errorCode;
-    return _this;
-  }
-  return GatewayError;
-})(ts_custom_error_1.CustomError);
+    __extends(GatewayError, _super);
+    function GatewayError(message, errorCode) {
+        var _this = _super.call(this, message) || this;
+        _this.errorCode = errorCode;
+        return _this;
+    }
+    return GatewayError;
+}(ts_custom_error_1.CustomError));
 exports.GatewayError = GatewayError;
 var HttpError = /** @class */ (function (_super) {
-  __extends(HttpError, _super);
-  function HttpError(message, errorCode) {
-    var _this = _super.call(this, message) || this;
-    _this.errorCode = errorCode;
-    return _this;
-  }
-  return HttpError;
-})(ts_custom_error_1.CustomError);
+    __extends(HttpError, _super);
+    function HttpError(message, errorCode) {
+        var _this = _super.call(this, message) || this;
+        _this.errorCode = errorCode;
+        return _this;
+    }
+    return HttpError;
+}(ts_custom_error_1.CustomError));
 exports.HttpError = HttpError;

package/provider/index.d.ts

@@ -1,5 +1,7 @@
 import { Provider } from './default';
 export * from './default';
 export * from './errors';
+export * from './sequencer';
 export * from './interface';
+export * from './rpc';
 export declare const defaultProvider: Provider;

package/provider/index.js

@@ -1,35 +1,24 @@
-'use strict';
-var __createBinding =
-  (this && this.__createBinding) ||
-  (Object.create
-    ? function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        var desc = Object.getOwnPropertyDescriptor(m, k);
-        if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-          desc = {
-            enumerable: true,
-            get: function () {
-              return m[k];
-            },
-          };
-        }
-        Object.defineProperty(o, k2, desc);
-      }
-    : function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        o[k2] = m[k];
-      });
-var __exportStar =
-  (this && this.__exportStar) ||
-  function (m, exports) {
-    for (var p in m)
-      if (p !== 'default' && !Object.prototype.hasOwnProperty.call(exports, p))
-        __createBinding(exports, m, p);
-  };
-Object.defineProperty(exports, '__esModule', { value: true });
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultProvider = void 0;
-var default_1 = require('./default');
-__exportStar(require('./default'), exports);
-__exportStar(require('./errors'), exports);
-__exportStar(require('./interface'), exports);
+var default_1 = require("./default");
+__exportStar(require("./default"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./sequencer"), exports);
+__exportStar(require("./interface"), exports);
+__exportStar(require("./rpc"), exports);
 exports.defaultProvider = new default_1.Provider();

package/provider/interface.d.ts

@@ -1,136 +1,109 @@
 import { StarknetChainId } from '../constants';
-import type {
-  AddTransactionResponse,
-  Call,
-  CallContractResponse,
-  DeployContractPayload,
-  GetBlockResponse,
-  GetCodeResponse,
-  GetContractAddressesResponse,
-  GetTransactionResponse,
-  GetTransactionStatusResponse,
-  Invocation,
-  TransactionReceiptResponse,
-} from '../types';
+import type { BlockTag, Call, CallContractResponse, ContractClass, DeclareContractPayload, DeclareContractResponse, DeployContractPayload, DeployContractResponse, EstimateFeeResponse, GetBlockResponse, GetTransactionReceiptResponse, GetTransactionResponse, Invocation, InvocationsDetails, InvokeFunctionResponse } from '../types';
 import type { BigNumberish } from '../utils/number';
 import { BlockIdentifier } from './utils';
 export declare abstract class ProviderInterface {
-  abstract baseUrl: string;
-  abstract feederGatewayUrl: string;
-  abstract gatewayUrl: string;
-  abstract chainId: StarknetChainId;
-  /**
-   * Gets the smart contract address on the goerli testnet.
-   *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L13-L15)
-   * @returns starknet smart contract addresses
-   */
-  abstract getContractAddresses(): Promise<GetContractAddressesResponse>;
-  /**
-   * Calls a function on the StarkNet contract.
-   *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L25-L39)
-   *
-   * @param invokeTransaction transaction to be invoked
-   * @param blockIdentifier block identifier
-   * @returns the result of the function on the smart contract.
-   */
-  abstract callContract(
-    invokeTransaction: Call,
-    options: {
-      blockIdentifier: BlockIdentifier;
-    }
-  ): Promise<CallContractResponse>;
-  /**
-   * Gets the block information
-   *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L41-L53)
-   *
-   * @param blockIdentifier block identifier
-   * @returns the block object { block_number, previous_block_number, state_root, status, timestamp, transaction_receipts, transactions }
-   */
-  abstract getBlock(blockIdentifier?: BlockIdentifier): Promise<GetBlockResponse>;
-  /**
-   * Gets the code of the deployed contract.
-   *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L55-L68)
-   *
-   * @param contractAddress - contract address
-   * @param blockIdentifier - block identifier
-   * @returns Bytecode and ABI of compiled contract
-   */
-  abstract getCode(
-    contractAddress: string,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<GetCodeResponse>;
-  /**
-   * Gets the contract's storage variable at a specific key.
-   *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L70-L85)
-   *
-   * @param contractAddress
-   * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-   * @param blockIdentifier - block identifier
-   * @returns the value of the storage variable
-   */
-  abstract getStorageAt(
-    contractAddress: string,
-    key: BigNumberish,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<object>;
-  /**
-   * Gets the status of a transaction.
-   *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L48-L52)
-   *
-   * @param txHash
-   * @returns the transaction status object { block_number, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
-   */
-  abstract getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse>;
-  /**
-   * Gets the transaction information from a tx id.
-   *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L54-L58)
-   *
-   * @param txHash
-   * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
-   */
-  abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
-  /**
-   * Gets the transaction receipt from a tx hash.
-   *
-   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/167b28bcd940fd25ea3816204fa882a0b0a49603/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L183)
-   *
-   * @param txHash
-   * @returns the transaction receipt object
-   */
-  abstract getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse>;
-  /**
-   * Deploys a given compiled contract (json) to starknet
-   *
-   * @param payload payload to be deployed containing:
-   * - compiled contract code
-   * - constructor calldata
-   * - address salt
-   * @returns a confirmation of sending a transaction on the starknet contract
-   */
-  abstract deployContract(payload: DeployContractPayload): Promise<AddTransactionResponse>;
-  /**
-   * Invokes a function on starknet
-   * @deprecated This method wont be supported as soon as fees are mandatory
-   *
-   * @param invocation the invocation object containing:
-   * - contractAddress - the address of the contract
-   * - entrypoint - the entrypoint of the contract
-   * - calldata - (defaults to []) the calldata
-   * - signature - (defaults to []) the signature
-   *
-   * @returns response from addTransaction
-   */
-  abstract invokeFunction(invocation: Invocation): Promise<AddTransactionResponse>;
-  abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
-  /**
-   * @deprecated use `waitForTransaction` instead
-   */
-  abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+    abstract chainId: StarknetChainId;
+    /**
+     * Calls a function on the StarkNet contract.
+     *
+     * @param call transaction to be called
+     * @param blockIdentifier block identifier
+     * @returns the result of the function on the smart contract.
+     */
+    abstract callContract(call: Call, blockIdentifier?: BlockIdentifier): Promise<CallContractResponse>;
+    /**
+     * Gets the block information
+     *
+     * @param blockIdentifier block identifier
+     * @returns the block object
+     */
+    abstract getBlock(blockIdentifier: BlockIdentifier): Promise<GetBlockResponse>;
+    /**
+     * Gets the contract class of the deployed contract.
+     *
+     * @param contractAddress - contract address
+     * @param blockIdentifier - block identifier
+     * @returns Contract class of compiled contract
+     */
+    abstract getClassAt(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<ContractClass>;
+    /**
+     * Gets the contract's storage variable at a specific key.
+     *
+     * @param contractAddress
+     * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
+     * @param blockHashOrTag - block hash or tag (pending, latest)
+     * @returns the value of the storage variable
+     */
+    abstract getStorageAt(contractAddress: string, key: BigNumberish, blockHashOrTag?: BlockTag | BigNumberish): Promise<BigNumberish>;
+    /**
+     * Gets the transaction information from a tx id.
+     *
+     * @param txHash
+     * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
+     */
+    abstract getTransaction(transactionHash: BigNumberish): Promise<GetTransactionResponse>;
+    /**
+     * Gets the transaction receipt from a tx hash.
+     *
+     * @param txHash
+     * @returns the transaction receipt object
+     */
+    abstract getTransactionReceipt(transactionHash: BigNumberish): Promise<GetTransactionReceiptResponse>;
+    /**
+     * Deploys a given compiled contract (json) to starknet
+     *
+     * @param payload payload to be deployed containing:
+     * - compiled contract code
+     * - constructor calldata
+     * - address salt
+     * @returns a confirmation of sending a transaction on the starknet contract
+     */
+    abstract deployContract(payload: DeployContractPayload): Promise<DeployContractResponse>;
+    /**
+     * Declares a given compiled contract (json) to starknet
+     *
+     * @param payload payload to be deployed containing:
+     * - compiled contract code
+     * - optional version
+     * @returns a confirmation of sending a transaction on the starknet contract
+     */
+    abstract declareContract(payload: DeclareContractPayload): Promise<DeclareContractResponse>;
+    /**
+     * Invokes a function on starknet
+     * @deprecated This method wont be supported as soon as fees are mandatory
+     *
+     * @param invocation the invocation object containing:
+     * - contractAddress - the address of the contract
+     * - entrypoint - the entrypoint of the contract
+     * - calldata - (defaults to []) the calldata
+     * - signature - (defaults to []) the signature
+     * @param details - optional details containing:
+     * - nonce - optional nonce
+     * - version - optional version
+     * - maxFee - optional maxFee
+     * @returns response from addTransaction
+     */
+    abstract invokeFunction(invocation: Invocation, details?: InvocationsDetails): Promise<InvokeFunctionResponse>;
+    /**
+     * Estimates the fee for a given transaction
+     *
+     * @param invocation the invocation object containing:
+     * - contractAddress - the address of the contract
+     * - entrypoint - the entrypoint of the contract
+     * - calldata - (defaults to []) the calldata
+     * - signature - (defaults to []) the signature
+     * @param blockIdentifier - block identifier
+     * @param details - optional details containing:
+     * - nonce - optional nonce
+     * - version - optional version
+     * @returns the estimated fee
+     */
+    abstract getEstimateFee(invocation: Invocation, blockIdentifier: BlockIdentifier, details?: InvocationsDetails): Promise<EstimateFeeResponse>;
+    /**
+     * Wait for the transaction to be accepted
+     * @param txHash - transaction hash
+     * @param retryInterval - retry interval
+     */
+    abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }

package/provider/interface.js

@@ -1,8 +1,9 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProviderInterface = void 0;
 var ProviderInterface = /** @class */ (function () {
-  function ProviderInterface() {}
-  return ProviderInterface;
-})();
+    function ProviderInterface() {
+    }
+    return ProviderInterface;
+}());
 exports.ProviderInterface = ProviderInterface;

package/provider/rpc.d.ts

@@ -0,0 +1,57 @@
+import { StarknetChainId } from '../constants';
+import { BlockTag, Call, CallContractResponse, DeclareContractPayload, DeclareContractResponse, DeployContractPayload, DeployContractResponse, EstimateFeeResponse, GetBlockResponse, GetTransactionReceiptResponse, GetTransactionResponse, Invocation, InvocationsDetails, InvokeFunctionResponse } from '../types';
+import { RPC } from '../types/api';
+import { BigNumberish } from '../utils/number';
+import { ProviderInterface } from './interface';
+import { BlockIdentifier } from './utils';
+export declare type RpcProviderOptions = {
+    nodeUrl: string;
+};
+export declare class RpcProvider implements ProviderInterface {
+    nodeUrl: string;
+    chainId: StarknetChainId;
+    private responseParser;
+    constructor(optionsOrProvider: RpcProviderOptions);
+    protected fetchEndpoint<T extends keyof RPC.Methods>(method: T, request?: RPC.Methods[T]['REQUEST']): Promise<RPC.Methods[T]['RESPONSE']>;
+    getChainId(): Promise<StarknetChainId>;
+    getBlock(blockIdentifier?: BlockIdentifier): Promise<GetBlockResponse>;
+    getStorageAt(contractAddress: string, key: BigNumberish, blockHashOrTag?: BlockTag | BigNumberish): Promise<BigNumberish>;
+    getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
+    getTransactionReceipt(txHash: BigNumberish): Promise<GetTransactionReceiptResponse>;
+    getClassAt(contractAddress: string, _blockIdentifier?: BlockIdentifier): Promise<any>;
+    getEstimateFee(invocation: Invocation, blockIdentifier?: BlockIdentifier, invocationDetails?: InvocationsDetails): Promise<EstimateFeeResponse>;
+    declareContract({ contract, version, }: DeclareContractPayload): Promise<DeclareContractResponse>;
+    deployContract({ contract, constructorCalldata, addressSalt, }: DeployContractPayload): Promise<DeployContractResponse>;
+    invokeFunction(functionInvocation: Invocation, details: InvocationsDetails): Promise<InvokeFunctionResponse>;
+    callContract(call: Call, blockIdentifier?: BlockIdentifier): Promise<CallContractResponse>;
+    waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+    /**
+     * Gets the transaction count from a block.
+     *
+     *
+     * @param blockIdentifier
+     * @returns Number of transactions
+     */
+    getTransactionCount(blockIdentifier: BlockIdentifier): Promise<RPC.GetTransactionCountResponse>;
+    /**
+     * Gets the latest block number
+     *
+     *
+     * @returns Number of the latest block
+     */
+    getBlockNumber(): Promise<RPC.GetBlockNumberResponse>;
+    /**
+     * Gets syncing status of the node
+     *
+     *
+     * @returns Object with the stats data
+     */
+    getSyncingStats(): Promise<RPC.GetSyncingStatsResponse>;
+    /**
+     * Gets all the events filtered
+     *
+     *
+     * @returns events and the pagination of the events
+     */
+    getEvents(eventFilter: RPC.EventFilter): Promise<RPC.GetEventsResponse>;
+}