starknet - npm Package Compare versions

Comparing version 2.5.0 to 2.6.0

__tests__/provider.test.ts

@@ -19,3 +19,3 @@ import fs from 'fs';
     });
-    test('getBlock(blockId=null)', () => {
+    test('getBlock(blockNumber=null)', () => {
       return expect(defaultProvider.getBlock()).resolves.not.toThrow();
@@ -31,3 +31,3 @@ });
     });
-    test('getCode(blockId=null)', () => {
+    test('getCode(blockNumber=null)', () => {
       return expect(
@@ -46,3 +46,3 @@ defaultProvider.getCode('0x163a1542a64402ffc93e39a4962eec51ce126f2e634631d3f1f6770a76e3a61')
     });
-    test('getStorageAt(blockId=null)', () => {
+    test('getStorageAt(blockNumber=null)', () => {
       return expect(
@@ -49,0 +49,0 @@ defaultProvider.getStorageAt(

CHANGELOG.md

@@ -0,1 +1,12 @@
+# [2.6.0](https://github.com/seanjameshan/starknet.js/compare/v2.5.0...v2.6.0) (2021-12-29)
+
+### Bug Fixes
+
+- correct network name ([66e14c9](https://github.com/seanjameshan/starknet.js/commit/66e14c926f015a2dfbd50d3e54ba4e008fb43aa8))
+- network name ([965f215](https://github.com/seanjameshan/starknet.js/commit/965f21580ef68bf84c105e93bfb3b98f75b31f93))
+
+### Features
+
+- introduce blockNumber ([657dac1](https://github.com/seanjameshan/starknet.js/commit/657dac1d77e840a7fc663d3a180515443a7e834f))
+
 # [2.5.0](https://github.com/seanjameshan/starknet.js/compare/v2.4.0...v2.5.0) (2021-12-13)
@@ -2,0 +13,0 @@

dist/provider/default.d.ts

@@ -1,5 +0,5 @@
-import { AddTransactionResponse, CallContractResponse, CallContractTransaction, CompiledContract, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, Signature, Transaction } from '../types';
+import { AddTransactionResponse, BlockNumber, CallContractResponse, CallContractTransaction, CompiledContract, GetBlockResponse, GetCodeResponse, 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 = {
@@ -29,6 +29,6 @@ network: NetworkName;
      * @param invokeTransaction - transaction to be invoked
-     * @param blockId
+     * @param blockNumber
      * @returns the result of the function on the smart contract.
      */
-    callContract(invokeTransaction: CallContractTransaction, blockId?: number): Promise<CallContractResponse>;
+    callContract(invokeTransaction: CallContractTransaction, blockNumber?: BlockNumber): Promise<CallContractResponse>;
     /**
@@ -39,6 +39,6 @@ * Gets the block information from a block ID.
      *
-     * @param blockId
-     * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+     * @param blockNumber
+     * @returns the block object { block_number, previous_block_number, state_root, status, timestamp, transaction_receipts, transactions }
      */
-    getBlock(blockId?: number): Promise<GetBlockResponse>;
+    getBlock(blockNumber?: BlockNumber): Promise<GetBlockResponse>;
     /**
@@ -50,6 +50,6 @@ * Gets the code of the deployed contract.
      * @param contractAddress
-     * @param blockId
+     * @param blockNumber
      * @returns Bytecode and ABI of compiled contract
      */
-    getCode(contractAddress: string, blockId?: number): Promise<GetCodeResponse>;
+    getCode(contractAddress: string, blockNumber?: BlockNumber): Promise<GetCodeResponse>;
     /**
@@ -62,6 +62,6 @@ * Gets the contract's storage variable at a specific key.
      * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-     * @param blockId
+     * @param blockNumber
      * @returns the value of the storage variable
      */
-    getStorageAt(contractAddress: string, key: number, blockId?: number): Promise<object>;
+    getStorageAt(contractAddress: string, key: number, blockNumber?: BlockNumber): Promise<object>;
     /**
@@ -73,3 +73,3 @@ * Gets the status of a transaction.
      * @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 }
      */
@@ -83,3 +83,3 @@ getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse>;
      * @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? }
      */
@@ -86,0 +86,0 @@ getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;

dist/provider/default.js

@@ -64,3 +64,3 @@ "use strict";
     function Provider(optionsOrProvider) {
-        if (optionsOrProvider === void 0) { optionsOrProvider = { network: 'georli-alpha' }; }
+        if (optionsOrProvider === void 0) { optionsOrProvider = { network: 'goerli-alpha' }; }
         if (optionsOrProvider instanceof Provider) {
@@ -84,3 +84,3 @@ this.baseUrl = optionsOrProvider.baseUrl;
                 return 'https://alpha-mainnet.starknet.io';
-            case 'georli-alpha':
+            case 'goerli-alpha':
             default:
@@ -115,6 +115,7 @@ return 'https://alpha4.starknet.io';
      * @param invokeTransaction - transaction to be invoked
-     * @param blockId
+     * @param blockNumber
      * @returns the result of the function on the smart contract.
      */
-    Provider.prototype.callContract = function (invokeTransaction, blockId) {
+    Provider.prototype.callContract = function (invokeTransaction, blockNumber) {
+        if (blockNumber === void 0) { blockNumber = null; }
         return __awaiter(this, void 0, void 0, function () {
@@ -124,3 +125,3 @@ var data;
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, axios_1.default.post((0, url_join_1.default)(this.feederGatewayUrl, 'call_contract', "?blockId=" + (blockId !== null && blockId !== void 0 ? blockId : 'null')), __assign({ signature: [], calldata: [] }, invokeTransaction))];
+                    case 0: return [4 /*yield*/, axios_1.default.post((0, url_join_1.default)(this.feederGatewayUrl, 'call_contract', "?blockNumber=" + blockNumber), __assign({ signature: [], calldata: [] }, invokeTransaction))];
                     case 1:
@@ -138,6 +139,7 @@ data = (_a.sent()).data;
      *
-     * @param blockId
-     * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+     * @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 (blockNumber) {
+        if (blockNumber === void 0) { blockNumber = null; }
         return __awaiter(this, void 0, void 0, function () {
@@ -147,3 +149,3 @@ var data;
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_block', "?blockId=" + (blockId !== null && blockId !== void 0 ? blockId : 'null')))];
+                    case 0: return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_block', "?blockNumber=" + blockNumber))];
                     case 1:
@@ -162,6 +164,7 @@ data = (_a.sent()).data;
      * @param contractAddress
-     * @param blockId
+     * @param blockNumber
      * @returns Bytecode and ABI of compiled contract
      */
-    Provider.prototype.getCode = function (contractAddress, blockId) {
+    Provider.prototype.getCode = function (contractAddress, blockNumber) {
+        if (blockNumber === void 0) { blockNumber = null; }
         return __awaiter(this, void 0, void 0, function () {
@@ -171,3 +174,3 @@ var data;
                 switch (_a.label) {
-                    case 0: 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')))];
+                    case 0: return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_code', "?contractAddress=" + contractAddress + "&blockNumber=" + blockNumber))];
                     case 1:
@@ -188,6 +191,7 @@ data = (_a.sent()).data;
      * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-     * @param blockId
+     * @param blockNumber
      * @returns the value of the storage variable
      */
-    Provider.prototype.getStorageAt = function (contractAddress, key, blockId) {
+    Provider.prototype.getStorageAt = function (contractAddress, key, blockNumber) {
+        if (blockNumber === void 0) { blockNumber = null; }
         return __awaiter(this, void 0, void 0, function () {
@@ -197,3 +201,3 @@ var data;
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_storage_at', "?contractAddress=" + contractAddress + "&key=" + key + "&blockId=" + (blockId !== null && blockId !== void 0 ? blockId : 'null')))];
+                    case 0: return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_storage_at', "?contractAddress=" + contractAddress + "&key=" + key + "&blockNumber=" + blockNumber))];
                     case 1:
@@ -212,3 +216,3 @@ data = (_a.sent()).data;
      * @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 }
      */
@@ -236,3 +240,3 @@ Provider.prototype.getTransactionStatus = function (txHash) {
      * @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? }
      */
@@ -239,0 +243,0 @@ Provider.prototype.getTransaction = function (txHash) {

dist/provider/interface.d.ts

@@ -1,2 +0,2 @@
-import type { AddTransactionResponse, CallContractResponse, CallContractTransaction, CompiledContract, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, Signature, Transaction } from '../types';
+import type { AddTransactionResponse, BlockNumber, CallContractResponse, CallContractTransaction, CompiledContract, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, Signature, Transaction } from '../types';
 import type { BigNumberish } from '../utils/number';
@@ -20,6 +20,6 @@ export declare abstract class ProviderInterface {
      * @param invokeTransaction - transaction to be invoked
-     * @param blockId
+     * @param blockNumber
      * @returns the result of the function on the smart contract.
      */
-    abstract callContract(invokeTransaction: CallContractTransaction, blockId?: number): Promise<CallContractResponse>;
+    abstract callContract(invokeTransaction: CallContractTransaction, blockNumber?: BlockNumber): Promise<CallContractResponse>;
     /**
@@ -30,6 +30,6 @@ * Gets the block information from a block ID.
      *
-     * @param blockId
-     * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+     * @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(blockNumber?: BlockNumber): Promise<GetBlockResponse>;
     /**
@@ -41,6 +41,6 @@ * Gets the code of the deployed contract.
      * @param contractAddress
-     * @param blockId
+     * @param blockNumber
      * @returns Bytecode and ABI of compiled contract
      */
-    abstract getCode(contractAddress: string, blockId?: number): Promise<GetCodeResponse>;
+    abstract getCode(contractAddress: string, blockNumber?: BlockNumber): Promise<GetCodeResponse>;
     /**
@@ -53,6 +53,6 @@ * Gets the contract's storage variable at a specific key.
      * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-     * @param blockId
+     * @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, blockNumber?: BlockNumber): Promise<object>;
     /**
@@ -64,3 +64,3 @@ * Gets the status of a transaction.
      * @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 }
      */
@@ -74,3 +74,3 @@ abstract getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse>;
      * @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? }
      */
@@ -77,0 +77,0 @@ abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;

dist/types.d.ts

@@ -36,2 +36,3 @@ import type { ec as EC } from 'elliptic';
 export declare type Program = object;
+export declare type BlockNumber = 'pending' | null | number;
 export declare type CompiledContract = {
@@ -81,3 +82,3 @@ abi: Abi[];
             }[];
-            block_number: number;
+            block_number: BlockNumber;
             status: Status;
@@ -102,3 +103,3 @@ transaction_index: number;
     block_hash: string;
-    block_number: number;
+    block_number: BlockNumber;
     transaction_index: number;
@@ -105,0 +106,0 @@ transaction_hash: string;

package.json

 {
   "name": "starknet",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "JavaScript library for StarkNet",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

provider/default.d.ts

 import {
   AddTransactionResponse,
+  BlockNumber,
   CallContractResponse,
@@ -16,3 +17,3 @@ CallContractTransaction,
 import { ProviderInterface } from './interface';
-declare type NetworkName = 'mainnet-alpha' | 'georli-alpha';
+declare type NetworkName = 'mainnet-alpha' | 'goerli-alpha';
 declare type ProviderOptions =
@@ -46,3 +47,3 @@ | {
    * @param invokeTransaction - transaction to be invoked
-   * @param blockId
+   * @param blockNumber
    * @returns the result of the function on the smart contract.
@@ -52,3 +53,3 @@ */
     invokeTransaction: CallContractTransaction,
-    blockId?: number
+    blockNumber?: BlockNumber
   ): Promise<CallContractResponse>;
@@ -60,6 +61,6 @@ /**
    *
-   * @param blockId
-   * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+   * @param blockNumber
+   * @returns the block object { block_number, previous_block_number, state_root, status, timestamp, transaction_receipts, transactions }
    */
-  getBlock(blockId?: number): Promise<GetBlockResponse>;
+  getBlock(blockNumber?: BlockNumber): Promise<GetBlockResponse>;
   /**
@@ -71,6 +72,6 @@ * Gets the code of the deployed contract.
    * @param contractAddress
-   * @param blockId
+   * @param blockNumber
    * @returns Bytecode and ABI of compiled contract
    */
-  getCode(contractAddress: string, blockId?: number): Promise<GetCodeResponse>;
+  getCode(contractAddress: string, blockNumber?: BlockNumber): Promise<GetCodeResponse>;
   /**
@@ -83,6 +84,6 @@ * Gets the contract's storage variable at a specific key.
    * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-   * @param blockId
+   * @param blockNumber
    * @returns the value of the storage variable
    */
-  getStorageAt(contractAddress: string, key: number, blockId?: number): Promise<object>;
+  getStorageAt(contractAddress: string, key: number, blockNumber?: BlockNumber): Promise<object>;
   /**
@@ -94,3 +95,3 @@ * Gets the status of a transaction.
    * @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 }
    */
@@ -104,3 +105,3 @@ getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse>;
    * @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? }
    */
@@ -107,0 +108,0 @@ getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;

provider/default.js

@@ -167,3 +167,3 @@ 'use strict';
     if (optionsOrProvider === void 0) {
-      optionsOrProvider = { network: 'georli-alpha' };
+      optionsOrProvider = { network: 'goerli-alpha' };
     }
@@ -188,3 +188,3 @@ if (optionsOrProvider instanceof Provider) {
         return 'https://alpha-mainnet.starknet.io';
-      case 'georli-alpha':
+      case 'goerli-alpha':
       default:
@@ -225,6 +225,9 @@ return 'https://alpha4.starknet.io';
    * @param invokeTransaction - transaction to be invoked
-   * @param blockId
+   * @param blockNumber
    * @returns the result of the function on the smart contract.
    */
-  Provider.prototype.callContract = function (invokeTransaction, blockId) {
+  Provider.prototype.callContract = function (invokeTransaction, blockNumber) {
+    if (blockNumber === void 0) {
+      blockNumber = null;
+    }
     return __awaiter(this, void 0, void 0, function () {
@@ -241,3 +244,3 @@ var data;
                   'call_contract',
-                  '?blockId=' + (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                  '?blockNumber=' + blockNumber
                 ),
@@ -259,6 +262,9 @@ __assign({ signature: [], calldata: [] }, invokeTransaction)
    *
-   * @param blockId
-   * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+   * @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 (blockNumber) {
+    if (blockNumber === void 0) {
+      blockNumber = null;
+    }
     return __awaiter(this, void 0, void 0, function () {
@@ -275,3 +281,3 @@ var data;
                   'get_block',
-                  '?blockId=' + (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                  '?blockNumber=' + blockNumber
                 )
@@ -293,6 +299,9 @@ ),
    * @param contractAddress
-   * @param blockId
+   * @param blockNumber
    * @returns Bytecode and ABI of compiled contract
    */
-  Provider.prototype.getCode = function (contractAddress, blockId) {
+  Provider.prototype.getCode = function (contractAddress, blockNumber) {
+    if (blockNumber === void 0) {
+      blockNumber = null;
+    }
     return __awaiter(this, void 0, void 0, function () {
@@ -309,6 +318,3 @@ var data;
                   'get_code',
-                  '?contractAddress=' +
-                    contractAddress +
-                    '&blockId=' +
-                    (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                  '?contractAddress=' + contractAddress + '&blockNumber=' + blockNumber
                 )
@@ -332,6 +338,9 @@ ),
    * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-   * @param blockId
+   * @param blockNumber
    * @returns the value of the storage variable
    */
-  Provider.prototype.getStorageAt = function (contractAddress, key, blockId) {
+  Provider.prototype.getStorageAt = function (contractAddress, key, blockNumber) {
+    if (blockNumber === void 0) {
+      blockNumber = null;
+    }
     return __awaiter(this, void 0, void 0, function () {
@@ -352,4 +361,4 @@ var data;
                     key +
-                    '&blockId=' +
-                    (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                    '&blockNumber=' +
+                    blockNumber
                 )
@@ -371,3 +380,3 @@ ),
    * @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 }
    */
@@ -404,3 +413,3 @@ Provider.prototype.getTransactionStatus = function (txHash) {
    * @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? }
    */
@@ -407,0 +416,0 @@ Provider.prototype.getTransaction = function (txHash) {

provider/interface.d.ts

 import type {
   AddTransactionResponse,
+  BlockNumber,
   CallContractResponse,
@@ -32,3 +33,3 @@ CallContractTransaction,
    * @param invokeTransaction - transaction to be invoked
-   * @param blockId
+   * @param blockNumber
    * @returns the result of the function on the smart contract.
@@ -38,3 +39,3 @@ */
     invokeTransaction: CallContractTransaction,
-    blockId?: number
+    blockNumber?: BlockNumber
   ): Promise<CallContractResponse>;
@@ -46,6 +47,6 @@ /**
    *
-   * @param blockId
-   * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+   * @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(blockNumber?: BlockNumber): Promise<GetBlockResponse>;
   /**
@@ -57,6 +58,6 @@ * Gets the code of the deployed contract.
    * @param contractAddress
-   * @param blockId
+   * @param blockNumber
    * @returns Bytecode and ABI of compiled contract
    */
-  abstract getCode(contractAddress: string, blockId?: number): Promise<GetCodeResponse>;
+  abstract getCode(contractAddress: string, blockNumber?: BlockNumber): Promise<GetCodeResponse>;
   /**
@@ -69,6 +70,10 @@ * Gets the contract's storage variable at a specific key.
    * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-   * @param blockId
+   * @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,
+    blockNumber?: BlockNumber
+  ): Promise<object>;
   /**
@@ -80,3 +85,3 @@ * Gets the status of a transaction.
    * @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 }
    */
@@ -90,3 +95,3 @@ abstract getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse>;
    * @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? }
    */
@@ -93,0 +98,0 @@ abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;

src/provider/default.ts

@@ -6,2 +6,3 @@ import axios from 'axios';
   AddTransactionResponse,
+  BlockNumber,
   CallContractResponse,
@@ -23,3 +24,3 @@ CallContractTransaction,
 
-type NetworkName = 'mainnet-alpha' | 'georli-alpha';
+type NetworkName = 'mainnet-alpha' | 'goerli-alpha';
 
@@ -45,3 +46,3 @@ type ProviderOptions =
 
-  constructor(optionsOrProvider: ProviderOptions | Provider = { network: 'georli-alpha' }) {
+  constructor(optionsOrProvider: ProviderOptions | Provider = { network: 'goerli-alpha' }) {
     if (optionsOrProvider instanceof Provider) {
@@ -66,3 +67,3 @@ this.baseUrl = optionsOrProvider.baseUrl;
         return 'https://alpha-mainnet.starknet.io';
-      case 'georli-alpha':
+      case 'goerli-alpha':
       default:
@@ -92,3 +93,3 @@ return 'https://alpha4.starknet.io';
    * @param invokeTransaction - transaction to be invoked
-   * @param blockId
+   * @param blockNumber
    * @returns the result of the function on the smart contract.
@@ -98,6 +99,6 @@ */
     invokeTransaction: CallContractTransaction,
-    blockId?: number
+    blockNumber: BlockNumber = null
   ): Promise<CallContractResponse> {
     const { data } = await axios.post<CallContractResponse>(
-      urljoin(this.feederGatewayUrl, 'call_contract', `?blockId=${blockId ?? 'null'}`),
+      urljoin(this.feederGatewayUrl, 'call_contract', `?blockNumber=${blockNumber}`),
       {
@@ -117,8 +118,8 @@ signature: [],
    *
-   * @param blockId
-   * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+   * @param blockNumber
+   * @returns the block object { block_number, previous_block_number, state_root, status, timestamp, transaction_receipts, transactions }
    */
-  public async getBlock(blockId?: number): Promise<GetBlockResponse> {
+  public async getBlock(blockNumber: BlockNumber = null): Promise<GetBlockResponse> {
     const { data } = await axios.get<GetBlockResponse>(
-      urljoin(this.feederGatewayUrl, 'get_block', `?blockId=${blockId ?? 'null'}`)
+      urljoin(this.feederGatewayUrl, 'get_block', `?blockNumber=${blockNumber}`)
     );
@@ -134,6 +135,9 @@ return data;
    * @param contractAddress
-   * @param blockId
+   * @param blockNumber
    * @returns Bytecode and ABI of compiled contract
    */
-  public async getCode(contractAddress: string, blockId?: number): Promise<GetCodeResponse> {
+  public async getCode(
+    contractAddress: string,
+    blockNumber: BlockNumber = null
+  ): Promise<GetCodeResponse> {
     const { data } = await axios.get<GetCodeResponse>(
@@ -143,3 +147,3 @@ urljoin(
         'get_code',
-        `?contractAddress=${contractAddress}&blockId=${blockId ?? 'null'}`
+        `?contractAddress=${contractAddress}&blockNumber=${blockNumber}`
       )
@@ -158,3 +162,3 @@ );
    * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-   * @param blockId
+   * @param blockNumber
    * @returns the value of the storage variable
@@ -165,3 +169,3 @@ */
     key: number,
-    blockId?: number
+    blockNumber: BlockNumber = null
   ): Promise<object> {
@@ -172,3 +176,3 @@ const { data } = await axios.get<object>(
         'get_storage_at',
-        `?contractAddress=${contractAddress}&key=${key}&blockId=${blockId ?? 'null'}`
+        `?contractAddress=${contractAddress}&key=${key}&blockNumber=${blockNumber}`
       )
@@ -185,3 +189,3 @@ );
    * @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 }
    */
@@ -206,3 +210,3 @@ public async getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse> {
    * @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? }
    */
@@ -209,0 +213,0 @@ public async getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse> {

src/provider/interface.ts

 import type {
   AddTransactionResponse,
+  BlockNumber,
   CallContractResponse,
@@ -37,3 +38,3 @@ CallContractTransaction,
    * @param invokeTransaction - transaction to be invoked
-   * @param blockId
+   * @param blockNumber
    * @returns the result of the function on the smart contract.
@@ -43,3 +44,3 @@ */
     invokeTransaction: CallContractTransaction,
-    blockId?: number
+    blockNumber?: BlockNumber
   ): Promise<CallContractResponse>;
@@ -52,6 +53,6 @@
    *
-   * @param blockId
-   * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+   * @param blockNumber
+   * @returns the block object { block_number, previous_block_number, state_root, status, timestamp, transaction_receipts, transactions }
    */
-  public abstract getBlock(blockId?: number): Promise<GetBlockResponse>;
+  public abstract getBlock(blockNumber?: BlockNumber): Promise<GetBlockResponse>;
 
@@ -64,6 +65,9 @@ /**
    * @param contractAddress
-   * @param blockId
+   * @param blockNumber
    * @returns Bytecode and ABI of compiled contract
    */
-  public abstract getCode(contractAddress: string, blockId?: number): Promise<GetCodeResponse>;
+  public abstract getCode(
+    contractAddress: string,
+    blockNumber?: BlockNumber
+  ): Promise<GetCodeResponse>;
 
@@ -78,3 +82,3 @@ // TODO: add proper type
    * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-   * @param blockId
+   * @param blockNumber
    * @returns the value of the storage variable
@@ -85,3 +89,3 @@ */
     key: number,
-    blockId?: number
+    blockNumber?: BlockNumber
   ): Promise<object>;
@@ -95,3 +99,3 @@
    * @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 }
    */
@@ -106,3 +110,3 @@ public abstract getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse>;
    * @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? }
    */
@@ -109,0 +113,0 @@ public abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;

src/types.ts

@@ -46,2 +46,3 @@ import type { ec as EC } from 'elliptic';
 export type Program = object;
+export type BlockNumber = 'pending' | null | number;
 
@@ -99,3 +100,3 @@ export type CompiledContract = {
       }[];
-      block_number: number;
+      block_number: BlockNumber;
       status: Status;
@@ -123,3 +124,3 @@ transaction_index: number;
   block_hash: string;
-  block_number: number;
+  block_number: BlockNumber;
   transaction_index: number;
@@ -126,0 +127,0 @@ transaction_hash: string;

types.d.ts

@@ -43,2 +43,3 @@ import type { ec as EC } from 'elliptic';
 export declare type Program = object;
+export declare type BlockNumber = 'pending' | null | number;
 export declare type CompiledContract = {
@@ -88,3 +89,3 @@ abi: Abi[];
       }[];
-      block_number: number;
+      block_number: BlockNumber;
       status: Status;
@@ -109,3 +110,3 @@ transaction_index: number;
   block_hash: string;
-  block_number: number;
+  block_number: BlockNumber;
   transaction_index: number;
@@ -112,0 +113,0 @@ transaction_hash: string;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5431188

increased by0.03%

Lines of code

141150

increased by0.02%

No dependency changes