starknet 2.3.1 → 2.7.0

package/provider/default.d.ts

@@ -1,5 +1,6 @@
 import {
   AddTransactionResponse,
+  BlockNumber,
   CallContractResponse,
   CallContractTransaction,
   CompiledContract,
@@ -8,11 +9,12 @@ import {
   GetContractAddressesResponse,
   GetTransactionResponse,
   GetTransactionStatusResponse,
+  Signature,
   Transaction,
 } from '../types';
 import { BigNumberish } from '../utils/number';
 import { ProviderInterface } from './interface';
-declare type NetworkName = 'mainnet-alpha' | 'georli-alpha';
+declare type NetworkName = 'mainnet-alpha' | 'goerli-alpha';
 declare type ProviderOptions =
   | {
       network: NetworkName;
@@ -38,50 +40,67 @@ export declare class Provider implements ProviderInterface {
   /**
    * Calls a function on the StarkNet contract.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L17-L25)
+   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L25-L39)
    *
-   * @param invokeTx - transaction to be invoked
-   * @param blockId
+   * @param invokeTransaction - transaction to be invoked
+   * @param blockHash
+   * @param blockNumber
    * @returns the result of the function on the smart contract.
    */
-  callContract(invokeTx: CallContractTransaction, blockId?: number): Promise<CallContractResponse>;
+  callContract(
+    invokeTransaction: CallContractTransaction,
+    blockHash?: BigNumberish,
+    blockNumber?: BlockNumber
+  ): Promise<CallContractResponse>;
   /**
-   * Gets the block information from a block ID.
+   * Gets the block information
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L27-L31)
+   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L41-L53)
    *
-   * @param blockId
-   * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+   * @param blockHash
+   * @param blockNumber
+   * @returns the block object { block_number, previous_block_number, state_root, status, timestamp, transaction_receipts, transactions }
    */
-  getBlock(blockId?: number): Promise<GetBlockResponse>;
+  getBlock(blockHash?: BigNumberish, blockNumber?: BlockNumber): Promise<GetBlockResponse>;
   /**
    * Gets the code of the deployed contract.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L33-L36)
+   * [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
-   * @param blockId
+   * @param blockHash
+   * @param blockNumber
    * @returns Bytecode and ABI of compiled contract
    */
-  getCode(contractAddress: string, blockId?: number): Promise<GetCodeResponse>;
+  getCode(
+    contractAddress: string,
+    blockHash?: BigNumberish,
+    blockNumber?: BlockNumber
+  ): Promise<GetCodeResponse>;
   /**
    * Gets the contract's storage variable at a specific key.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L38-L46)
+   * [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 blockId
+   * @param blockHash
+   * @param blockNumber
    * @returns the value of the storage variable
    */
-  getStorageAt(contractAddress: string, key: number, blockId?: number): Promise<object>;
+  getStorageAt(
+    contractAddress: string,
+    key: number,
+    blockHash?: BigNumberish,
+    blockNumber?: BlockNumber
+  ): 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_id, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
+   * @returns the transaction status object { block_number, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
    */
   getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse>;
   /**
@@ -90,7 +109,7 @@ export declare class Provider implements ProviderInterface {
    * [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_id?, block_number?, transaction_index?, transaction_failure_reason? }
+   * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
    */
   getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
   /**
@@ -98,10 +117,10 @@ export declare class Provider implements ProviderInterface {
    *
    * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/gateway/gateway_client.py#L13-L17)
    *
-   * @param tx - transaction to be invoked
+   * @param transaction - transaction to be invoked
    * @returns a confirmation of invoking a function on the starknet contract
    */
-  addTransaction(tx: Transaction): Promise<AddTransactionResponse>;
+  addTransaction(transaction: Transaction): Promise<AddTransactionResponse>;
   /**
    * Deploys a given compiled contract (json) to starknet
    *
@@ -127,7 +146,7 @@ export declare class Provider implements ProviderInterface {
     contractAddress: string,
     entrypointSelector: string,
     calldata?: string[],
-    signature?: [BigNumberish, BigNumberish]
+    signature?: Signature
   ): Promise<AddTransactionResponse>;
   waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }

package/provider/default.js

@@ -156,6 +156,7 @@ var url_join_1 = __importDefault(require('url-join'));
 var json_1 = require('../utils/json');
 var number_1 = require('../utils/number');
 var stark_1 = require('../utils/stark');
+var utils_1 = require('./utils');
 function wait(delay) {
   return new Promise(function (res) {
     return setTimeout(res, delay);
@@ -164,7 +165,7 @@ function wait(delay) {
 var Provider = /** @class */ (function () {
   function Provider(optionsOrProvider) {
     if (optionsOrProvider === void 0) {
-      optionsOrProvider = { network: 'georli-alpha' };
+      optionsOrProvider = { network: 'goerli-alpha' };
     }
     if (optionsOrProvider instanceof Provider) {
       this.baseUrl = optionsOrProvider.baseUrl;
@@ -184,7 +185,7 @@ var Provider = /** @class */ (function () {
     switch (name) {
       case 'mainnet-alpha':
         return 'https://alpha-mainnet.starknet.io';
-      case 'georli-alpha':
+      case 'goerli-alpha':
       default:
         return 'https://alpha4.starknet.io';
     }
@@ -217,27 +218,35 @@ var Provider = /** @class */ (function () {
   /**
    * Calls a function on the StarkNet contract.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L17-L25)
+   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L25-L39)
    *
-   * @param invokeTx - transaction to be invoked
-   * @param blockId
+   * @param invokeTransaction - transaction to be invoked
+   * @param blockHash
+   * @param blockNumber
    * @returns the result of the function on the smart contract.
    */
-  Provider.prototype.callContract = function (invokeTx, blockId) {
+  Provider.prototype.callContract = function (invokeTransaction, blockHash, blockNumber) {
+    if (blockNumber === void 0) {
+      blockNumber = null;
+    }
     return __awaiter(this, void 0, void 0, function () {
-      var data;
+      var formattedBlockIdentifier, data;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
+            formattedBlockIdentifier = (0, utils_1.getFormattedBlockIdentifier)(
+              blockHash,
+              blockNumber
+            );
             return [
               4 /*yield*/,
               axios_1.default.post(
                 (0, url_join_1.default)(
                   this.feederGatewayUrl,
                   'call_contract',
-                  '?blockId=' + (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                  formattedBlockIdentifier
                 ),
-                __assign({ signature: [], calldata: [] }, invokeTx)
+                __assign({ signature: [], calldata: [] }, invokeTransaction)
               ),
             ];
           case 1:
@@ -248,26 +257,34 @@ var Provider = /** @class */ (function () {
     });
   };
   /**
-   * Gets the block information from a block ID.
+   * Gets the block information
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L27-L31)
+   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L41-L53)
    *
-   * @param blockId
-   * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+   * @param blockHash
+   * @param blockNumber
+   * @returns the block object { block_number, previous_block_number, state_root, status, timestamp, transaction_receipts, transactions }
    */
-  Provider.prototype.getBlock = function (blockId) {
+  Provider.prototype.getBlock = function (blockHash, blockNumber) {
+    if (blockNumber === void 0) {
+      blockNumber = null;
+    }
     return __awaiter(this, void 0, void 0, function () {
-      var data;
+      var formattedBlockIdentifier, data;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
+            formattedBlockIdentifier = (0, utils_1.getFormattedBlockIdentifier)(
+              blockHash,
+              blockNumber
+            );
             return [
               4 /*yield*/,
               axios_1.default.get(
                 (0, url_join_1.default)(
                   this.feederGatewayUrl,
                   'get_block',
-                  '?blockId=' + (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                  formattedBlockIdentifier
                 )
               ),
             ];
@@ -281,28 +298,33 @@ var Provider = /** @class */ (function () {
   /**
    * Gets the code of the deployed contract.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L33-L36)
+   * [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
-   * @param blockId
+   * @param blockHash
+   * @param blockNumber
    * @returns Bytecode and ABI of compiled contract
    */
-  Provider.prototype.getCode = function (contractAddress, blockId) {
+  Provider.prototype.getCode = function (contractAddress, blockHash, blockNumber) {
+    if (blockNumber === void 0) {
+      blockNumber = null;
+    }
     return __awaiter(this, void 0, void 0, function () {
-      var data;
+      var formattedBlockIdentifier, data;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
+            formattedBlockIdentifier = (0, utils_1.getFormattedBlockIdentifier)(
+              blockHash,
+              blockNumber
+            );
             return [
               4 /*yield*/,
               axios_1.default.get(
                 (0, url_join_1.default)(
                   this.feederGatewayUrl,
                   'get_code',
-                  '?contractAddress=' +
-                    contractAddress +
-                    '&blockId=' +
-                    (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                  '?contractAddress=' + contractAddress + '&' + formattedBlockIdentifier
                 )
               ),
             ];
@@ -317,19 +339,27 @@ var Provider = /** @class */ (function () {
   /**
    * Gets the contract's storage variable at a specific key.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L38-L46)
+   * [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 blockId
+   * @param blockHash
+   * @param blockNumber
    * @returns the value of the storage variable
    */
-  Provider.prototype.getStorageAt = function (contractAddress, key, blockId) {
+  Provider.prototype.getStorageAt = function (contractAddress, key, blockHash, blockNumber) {
+    if (blockNumber === void 0) {
+      blockNumber = null;
+    }
     return __awaiter(this, void 0, void 0, function () {
-      var data;
+      var formattedBlockIdentifier, data;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
+            formattedBlockIdentifier = (0, utils_1.getFormattedBlockIdentifier)(
+              blockHash,
+              blockNumber
+            );
             return [
               4 /*yield*/,
               axios_1.default.get(
@@ -340,8 +370,8 @@ var Provider = /** @class */ (function () {
                     contractAddress +
                     '&key=' +
                     key +
-                    '&blockId=' +
-                    (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                    '&' +
+                    formattedBlockIdentifier
                 )
               ),
             ];
@@ -358,7 +388,7 @@ var Provider = /** @class */ (function () {
    * [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_id, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
+   * @returns the transaction status object { block_number, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
    */
   Provider.prototype.getTransactionStatus = function (txHash) {
     return __awaiter(this, void 0, void 0, function () {
@@ -390,7 +420,7 @@ var Provider = /** @class */ (function () {
    * [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_id?, block_number?, transaction_index?, transaction_failure_reason? }
+   * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
    */
   Provider.prototype.getTransaction = function (txHash) {
     return __awaiter(this, void 0, void 0, function () {
@@ -421,19 +451,21 @@ var Provider = /** @class */ (function () {
    *
    * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/gateway/gateway_client.py#L13-L17)
    *
-   * @param tx - transaction to be invoked
+   * @param transaction - transaction to be invoked
    * @returns a confirmation of invoking a function on the starknet contract
    */
-  Provider.prototype.addTransaction = function (tx) {
+  Provider.prototype.addTransaction = function (transaction) {
     return __awaiter(this, void 0, void 0, function () {
       var signature, contract_address_salt, data;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
-            signature = tx.type === 'INVOKE_FUNCTION' && (0, stark_1.formatSignature)(tx.signature);
+            signature =
+              transaction.type === 'INVOKE_FUNCTION' &&
+              (0, stark_1.formatSignature)(transaction.signature);
             contract_address_salt =
-              tx.type === 'DEPLOY' &&
-              (0, number_1.toHex)((0, number_1.toBN)(tx.contract_address_salt));
+              transaction.type === 'DEPLOY' &&
+              (0, number_1.toHex)((0, number_1.toBN)(transaction.contract_address_salt));
             return [
               4 /*yield*/,
               axios_1.default.post(
@@ -441,7 +473,7 @@ var Provider = /** @class */ (function () {
                 (0, json_1.stringify)(
                   __assign(
                     __assign(
-                      __assign({}, tx),
+                      __assign({}, transaction),
                       Array.isArray(signature) && { signature: signature }
                     ),
                     contract_address_salt && { contract_address_salt: contract_address_salt }
@@ -510,34 +542,34 @@ var Provider = /** @class */ (function () {
       retryInterval = 8000;
     }
     return __awaiter(this, void 0, void 0, function () {
-      var onchain, res;
+      var onchain, res, error;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
             onchain = false;
-            _a.label = 1;
+            return [4 /*yield*/, wait(retryInterval)];
           case 1:
-            if (!!onchain) return [3 /*break*/, 4];
+            _a.sent();
+            _a.label = 2;
+          case 2:
+            if (!!onchain) return [3 /*break*/, 5];
             // eslint-disable-next-line no-await-in-loop
             return [4 /*yield*/, wait(retryInterval)];
-          case 2:
+          case 3:
             // eslint-disable-next-line no-await-in-loop
             _a.sent();
             return [4 /*yield*/, this.getTransactionStatus(txHash)];
-          case 3:
+          case 4:
             res = _a.sent();
-            if (
-              res.tx_status === 'ACCEPTED_ONCHAIN' ||
-              (res.tx_status === 'PENDING' && res.block_hash !== 'pending') // This is needed as of today. In the future there will be a different status for pending transactions.
-            ) {
+            if (res.tx_status === 'ACCEPTED_ON_L1' || res.tx_status === 'ACCEPTED_ON_L2') {
               onchain = true;
-            } else if (res.tx_status === 'REJECTED') {
-              throw Error('REJECTED');
-            } else if (res.tx_status === 'NOT_RECEIVED') {
-              throw Error('NOT_RECEIVED');
+            } else if (res.tx_status === 'REJECTED' || res.tx_status === 'NOT_RECEIVED') {
+              error = Error(res.tx_status);
+              error.response = res;
+              throw error;
             }
-            return [3 /*break*/, 1];
-          case 4:
+            return [3 /*break*/, 2];
+          case 5:
             return [2 /*return*/];
         }
       });

package/provider/interface.d.ts

@@ -1,5 +1,6 @@
 import type {
   AddTransactionResponse,
+  BlockNumber,
   CallContractResponse,
   CallContractTransaction,
   CompiledContract,
@@ -8,6 +9,7 @@ import type {
   GetContractAddressesResponse,
   GetTransactionResponse,
   GetTransactionStatusResponse,
+  Signature,
   Transaction,
 } from '../types';
 import type { BigNumberish } from '../utils/number';
@@ -25,53 +27,67 @@ export declare abstract class ProviderInterface {
   /**
    * Calls a function on the StarkNet contract.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L17-L25)
+   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L25-L39)
    *
-   * @param invokeTx - transaction to be invoked
-   * @param blockId
+   * @param invokeTransaction - transaction to be invoked
+   * @param blockHash
+   * @param blockNumber
    * @returns the result of the function on the smart contract.
    */
   abstract callContract(
-    invokeTx: CallContractTransaction,
-    blockId?: number
+    invokeTransaction: CallContractTransaction,
+    blockHash?: BigNumberish,
+    blockNumber?: BlockNumber
   ): Promise<CallContractResponse>;
   /**
-   * Gets the block information from a block ID.
+   * Gets the block information
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L27-L31)
+   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L41-L53)
    *
-   * @param blockId
-   * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+   * @param blockHash
+   * @param blockNumber
+   * @returns the block object { block_number, previous_block_number, state_root, status, timestamp, transaction_receipts, transactions }
    */
-  abstract getBlock(blockId?: number): Promise<GetBlockResponse>;
+  abstract getBlock(blockHash?: BigNumberish, blockNumber?: BlockNumber): Promise<GetBlockResponse>;
   /**
    * Gets the code of the deployed contract.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L33-L36)
+   * [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
-   * @param blockId
+   * @param blockHash
+   * @param blockNumber
    * @returns Bytecode and ABI of compiled contract
    */
-  abstract getCode(contractAddress: string, blockId?: number): Promise<GetCodeResponse>;
+  abstract getCode(
+    contractAddress: string,
+    blockHash?: BigNumberish,
+    blockNumber?: BlockNumber
+  ): Promise<GetCodeResponse>;
   /**
    * Gets the contract's storage variable at a specific key.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L38-L46)
+   * [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 blockId
+   * @param blockHash
+   * @param blockNumber
    * @returns the value of the storage variable
    */
-  abstract getStorageAt(contractAddress: string, key: number, blockId?: number): Promise<object>;
+  abstract getStorageAt(
+    contractAddress: string,
+    key: number,
+    blockHash?: BigNumberish,
+    blockNumber?: BlockNumber
+  ): 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_id, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
+   * @returns the transaction status object { block_number, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
    */
   abstract getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse>;
   /**
@@ -80,7 +96,7 @@ export declare abstract class ProviderInterface {
    * [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_id?, block_number?, transaction_index?, transaction_failure_reason? }
+   * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
    */
   abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
   /**
@@ -88,10 +104,10 @@ export declare abstract class ProviderInterface {
    *
    * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/gateway/gateway_client.py#L13-L17)
    *
-   * @param tx - transaction to be invoked
+   * @param transaction - transaction to be invoked
    * @returns a confirmation of invoking a function on the starknet contract
    */
-  abstract addTransaction(tx: Transaction): Promise<AddTransactionResponse>;
+  abstract addTransaction(transaction: Transaction): Promise<AddTransactionResponse>;
   /**
    * Deploys a given compiled contract (json) to starknet
    *
@@ -117,7 +133,7 @@ export declare abstract class ProviderInterface {
     contractAddress: string,
     entrypointSelector: string,
     calldata?: string[],
-    signature?: [BigNumberish, BigNumberish]
+    signature?: Signature
   ): Promise<AddTransactionResponse>;
   abstract waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }

package/provider/utils.d.ts

@@ -0,0 +1,30 @@
+import type { BlockNumber } from '../types';
+import { BigNumberish } from '../utils/number';
+/**
+ * TODO
+ * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L148-L153)
+ *
+ * @param hashValue
+ * @param hashField
+ */
+export declare function formatHash(): void;
+/**
+ * TODO
+ * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L156-L161)
+ * @param txHash
+ * @param txId
+ */
+export declare function txIdentifier(): void;
+/**
+ * Gets the block identifier for API request
+ *
+ * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L164-L173)
+ *
+ * @param blockNumber
+ * @param blockHash
+ * @returns block identifier for API request
+ */
+export declare function getFormattedBlockIdentifier(
+  blockHash?: BigNumberish,
+  blockNumber?: BlockNumber
+): string;

package/provider/utils.js

@@ -0,0 +1,39 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.getFormattedBlockIdentifier = exports.txIdentifier = exports.formatHash = void 0;
+/**
+ * TODO
+ * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L148-L153)
+ *
+ * @param hashValue
+ * @param hashField
+ */
+function formatHash() {}
+exports.formatHash = formatHash;
+/**
+ * TODO
+ * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L156-L161)
+ * @param txHash
+ * @param txId
+ */
+function txIdentifier() {}
+exports.txIdentifier = txIdentifier;
+/**
+ * Gets the block identifier for API request
+ *
+ * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L164-L173)
+ *
+ * @param blockNumber
+ * @param blockHash
+ * @returns block identifier for API request
+ */
+function getFormattedBlockIdentifier(blockHash, blockNumber) {
+  if (blockNumber === void 0) {
+    blockNumber = null;
+  }
+  if (blockHash) {
+    return '?blockHash=' + blockHash;
+  }
+  return '?blockNumber=' + blockNumber;
+}
+exports.getFormattedBlockIdentifier = getFormattedBlockIdentifier;