starknet 4.4.2 → 4.6.0

package/dist/provider/rpc.js

@@ -58,54 +58,45 @@ var RpcProvider = /** @class */ (function () {
             _this.chainId = chainId;
         });
     }
+    RpcProvider.prototype.fetch = function (method, params) {
+        return (0, fetchPonyfill_1.default)(this.nodeUrl, {
+            method: 'POST',
+            body: (0, json_1.stringify)({ method: method, jsonrpc: '2.0', params: params, id: 0 }),
+            headers: { 'Content-Type': 'application/json' },
+        });
+    };
+    RpcProvider.prototype.errorHandler = function (error) {
+        if (error) {
+            var code = error.code, message = error.message;
+            throw new Error("".concat(code, ": ").concat(message));
+        }
+    };
     RpcProvider.prototype.fetchEndpoint = function (method, request) {
         var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var requestData, rawResult, _b, error, result, code, message, error_1, data;
+            var rawResult, _b, error, result, error_1;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
-                        requestData = {
-                            method: method,
-                            jsonrpc: '2.0',
-                            params: request,
-                            id: 0,
-                        };
-                        _c.label = 1;
+                        _c.trys.push([0, 3, , 4]);
+                        return [4 /*yield*/, this.fetch(method, request)];
                     case 1:
-                        _c.trys.push([1, 4, , 5]);
-                        return [4 /*yield*/, (0, fetchPonyfill_1.default)(this.nodeUrl, {
-                                method: 'POST',
-                                body: (0, json_1.stringify)(requestData),
-                                headers: {
-                                    'Content-Type': 'application/json',
-                                },
-                            })];
-                    case 2:
                         rawResult = _c.sent();
                         return [4 /*yield*/, rawResult.json()];
-                    case 3:
+                    case 2:
                         _b = _c.sent(), error = _b.error, result = _b.result;
-                        if (error) {
-                            code = error.code, message = error.message;
-                            throw new Error("".concat(code, ": ").concat(message));
-                        }
-                        else {
-                            return [2 /*return*/, result];
-                        }
-                        return [3 /*break*/, 5];
-                    case 4:
+                        this.errorHandler(error);
+                        return [2 /*return*/, result];
+                    case 3:
                         error_1 = _c.sent();
-                        data = (_a = error_1 === null || error_1 === void 0 ? void 0 : error_1.response) === null || _a === void 0 ? void 0 : _a.data;
-                        if (data === null || data === void 0 ? void 0 : data.message) {
-                            throw new Error("".concat(data.code, ": ").concat(data.message));
-                        }
+                        this.errorHandler((_a = error_1 === null || error_1 === void 0 ? void 0 : error_1.response) === null || _a === void 0 ? void 0 : _a.data);
                         throw error_1;
-                    case 5: return [2 /*return*/];
+                    case 4: return [2 /*return*/];
                 }
             });
         });
     };
+    // Methods from Interface
     RpcProvider.prototype.getChainId = function () {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -113,7 +104,7 @@ var RpcProvider = /** @class */ (function () {
             });
         });
     };
-    // Common Interface
+    // Methods from Interface
     RpcProvider.prototype.getBlock = function (blockIdentifier) {
         if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
         return __awaiter(this, void 0, void 0, function () {
@@ -122,25 +113,39 @@ var RpcProvider = /** @class */ (function () {
             });
         });
     };
+    RpcProvider.prototype.getBlockHashAndNumber = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.fetchEndpoint('starknet_blockHashAndNumber')];
+            });
+        });
+    };
     RpcProvider.prototype.getBlockWithTxHashes = function (blockIdentifier) {
         if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
         return __awaiter(this, void 0, void 0, function () {
-            var blockIdentifierGetter;
+            var block;
             return __generator(this, function (_a) {
-                blockIdentifierGetter = new utils_1.BlockIdentifierClass(blockIdentifier);
-                return [2 /*return*/, this.fetchEndpoint('starknet_getBlockWithTxHashes', [
-                        blockIdentifierGetter.getIdentifier(),
-                    ])];
+                block = new utils_1.Block(blockIdentifier);
+                return [2 /*return*/, this.fetchEndpoint('starknet_getBlockWithTxHashes', [block.identifier])];
             });
         });
     };
     RpcProvider.prototype.getBlockWithTxs = function (blockIdentifier) {
         if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
         return __awaiter(this, void 0, void 0, function () {
-            var blockIdentifierGetter;
+            var block;
+            return __generator(this, function (_a) {
+                block = new utils_1.Block(blockIdentifier);
+                return [2 /*return*/, this.fetchEndpoint('starknet_getBlockWithTxs', [block.identifier])];
+            });
+        });
+    };
+    RpcProvider.prototype.getClassHashAt = function (blockIdentifier, contractAddress) {
+        return __awaiter(this, void 0, void 0, function () {
+            var block;
             return __generator(this, function (_a) {
-                blockIdentifierGetter = new utils_1.BlockIdentifierClass(blockIdentifier);
-                return [2 /*return*/, this.fetchEndpoint('starknet_getBlockWithTxs', [blockIdentifierGetter.getIdentifier()])];
+                block = new utils_1.Block(blockIdentifier);
+                return [2 /*return*/, this.fetchEndpoint('starknet_getClassHashAt', [block.identifier, contractAddress])];
             });
         });
     };
@@ -151,22 +156,45 @@ var RpcProvider = /** @class */ (function () {
             });
         });
     };
+    RpcProvider.prototype.getPendingTransactions = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.fetchEndpoint('starknet_pendingTransactions')];
+            });
+        });
+    };
+    RpcProvider.prototype.getProtocolVersion = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                throw new Error('Pathfinder does not implement this rpc 0.1.0 method');
+            });
+        });
+    };
+    RpcProvider.prototype.getStateUpdate = function (blockIdentifier) {
+        return __awaiter(this, void 0, void 0, function () {
+            var block;
+            return __generator(this, function (_a) {
+                block = new utils_1.Block(blockIdentifier);
+                return [2 /*return*/, this.fetchEndpoint('starknet_getStateUpdate', [block.identifier])];
+            });
+        });
+    };
     RpcProvider.prototype.getStorageAt = function (contractAddress, key, blockIdentifier) {
         if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
         return __awaiter(this, void 0, void 0, function () {
-            var parsedKey, blockIdentifierGetter;
+            var parsedKey, block;
             return __generator(this, function (_a) {
                 parsedKey = (0, number_1.toHex)((0, number_1.toBN)(key));
-                blockIdentifierGetter = new utils_1.BlockIdentifierClass(blockIdentifier);
+                block = new utils_1.Block(blockIdentifier);
                 return [2 /*return*/, this.fetchEndpoint('starknet_getStorageAt', [
                         contractAddress,
                         parsedKey,
-                        blockIdentifierGetter.getIdentifier(),
+                        block.identifier,
                     ])];
             });
         });
     };
-    // common interface
+    // Methods from Interface
     RpcProvider.prototype.getTransaction = function (txHash) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -183,8 +211,13 @@ var RpcProvider = /** @class */ (function () {
     };
     RpcProvider.prototype.getTransactionByBlockIdAndIndex = function (blockIdentifier, index) {
         return __awaiter(this, void 0, void 0, function () {
+            var block;
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.fetchEndpoint('starknet_getTransactionByHash', [blockIdentifier, index])];
+                block = new utils_1.Block(blockIdentifier);
+                return [2 /*return*/, this.fetchEndpoint('starknet_getTransactionByBlockIdAndIndex', [
+                        block.identifier,
+                        index,
+                    ])];
             });
         });
     };
@@ -195,15 +228,26 @@ var RpcProvider = /** @class */ (function () {
             });
         });
     };
+    RpcProvider.prototype.getClass = function (classHash) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.fetchEndpoint('starknet_getClass', [classHash])];
+            });
+        });
+    };
     RpcProvider.prototype.getClassAt = function (contractAddress, blockIdentifier) {
         return __awaiter(this, void 0, void 0, function () {
-            var blockIdentifierGetter;
+            var block;
             return __generator(this, function (_a) {
-                blockIdentifierGetter = new utils_1.BlockIdentifierClass(blockIdentifier);
-                return [2 /*return*/, this.fetchEndpoint('starknet_getClassAt', [
-                        blockIdentifierGetter.getIdentifier(),
-                        contractAddress,
-                    ])];
+                block = new utils_1.Block(blockIdentifier);
+                return [2 /*return*/, this.fetchEndpoint('starknet_getClassAt', [block.identifier, contractAddress])];
+            });
+        });
+    };
+    RpcProvider.prototype.getCode = function (_contractAddress, _blockIdentifier) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                throw new Error('RPC 0.1.0 does not implement getCode function');
             });
         });
     };
@@ -211,7 +255,9 @@ var RpcProvider = /** @class */ (function () {
         if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
         if (invocationDetails === void 0) { invocationDetails = {}; }
         return __awaiter(this, void 0, void 0, function () {
+            var block_id;
             return __generator(this, function (_a) {
+                block_id = new utils_1.Block(blockIdentifier).identifier;
                 return [2 /*return*/, this.fetchEndpoint('starknet_estimateFee', [
                         {
                             contract_address: invocation.contractAddress,
@@ -220,7 +266,7 @@ var RpcProvider = /** @class */ (function () {
                             signature: (0, number_1.bigNumberishArrayToHexadecimalStringArray)(invocation.signature || []),
                             version: (0, number_1.toHex)((0, number_1.toBN)((invocationDetails === null || invocationDetails === void 0 ? void 0 : invocationDetails.version) || 0)),
                         },
-                        blockIdentifier,
+                        block_id,
                     ]).then(this.responseParser.parseFeeEstimateResponse)];
             });
         });
@@ -235,6 +281,7 @@ var RpcProvider = /** @class */ (function () {
                         {
                             program: contractDefinition.program,
                             entry_points_by_type: contractDefinition.entry_points_by_type,
+                            abi: contractDefinition.abi, // rpc 2.0
                         },
                         (0, number_1.toHex)((0, number_1.toBN)(version || 0)),
                     ]).then(this.responseParser.parseDeclareContractResponse)];
@@ -253,6 +300,7 @@ var RpcProvider = /** @class */ (function () {
                         {
                             program: contractDefinition.program,
                             entry_points_by_type: contractDefinition.entry_points_by_type,
+                            abi: contractDefinition.abi, // rpc 2.0
                         },
                     ]).then(this.responseParser.parseDeployContractResponse)];
             });
@@ -274,20 +322,23 @@ var RpcProvider = /** @class */ (function () {
             });
         });
     };
+    // Methods from Interface
     RpcProvider.prototype.callContract = function (call, blockIdentifier) {
         if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
         return __awaiter(this, void 0, void 0, function () {
-            var result;
+            var block_id, result;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.fetchEndpoint('starknet_call', [
-                            {
-                                contract_address: call.contractAddress,
-                                entry_point_selector: (0, hash_1.getSelectorFromName)(call.entrypoint),
-                                calldata: (0, provider_1.parseCalldata)(call.calldata),
-                            },
-                            blockIdentifier,
-                        ])];
+                    case 0:
+                        block_id = new utils_1.Block(blockIdentifier).identifier;
+                        return [4 /*yield*/, this.fetchEndpoint('starknet_call', [
+                                {
+                                    contract_address: call.contractAddress,
+                                    entry_point_selector: (0, hash_1.getSelectorFromName)(call.entrypoint),
+                                    calldata: (0, provider_1.parseCalldata)(call.calldata),
+                                },
+                                block_id,
+                            ])];
                     case 1:
                         result = _a.sent();
                         return [2 /*return*/, this.responseParser.parseCallContractResponse(result)];
@@ -295,10 +346,17 @@ var RpcProvider = /** @class */ (function () {
             });
         });
     };
-    RpcProvider.prototype.getCode = function (_contractAddress, _blockIdentifier) {
+    RpcProvider.prototype.traceTransaction = function (transactionHash) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                throw new Error('RPC 0.1.0 does not implement getCode function');
+                return [2 /*return*/, this.fetchEndpoint('starknet_traceTransaction', [transactionHash])];
+            });
+        });
+    };
+    RpcProvider.prototype.traceBlockTransactions = function (blockHash) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.fetchEndpoint('starknet_traceBlockTransactions', [blockHash])];
             });
         });
     };
@@ -310,7 +368,7 @@ var RpcProvider = /** @class */ (function () {
                 switch (_a.label) {
                     case 0:
                         onchain = false;
-                        retries = 100;
+                        retries = 200;
                         _a.label = 1;
                     case 1:
                         if (!!onchain) return [3 /*break*/, 7];
@@ -366,12 +424,10 @@ var RpcProvider = /** @class */ (function () {
      */
     RpcProvider.prototype.getTransactionCount = function (blockIdentifier) {
         return __awaiter(this, void 0, void 0, function () {
-            var blockIdentifierGetter;
+            var block;
             return __generator(this, function (_a) {
-                blockIdentifierGetter = new utils_1.BlockIdentifierClass(blockIdentifier);
-                return [2 /*return*/, this.fetchEndpoint('starknet_getBlockTransactionCount', [
-                        blockIdentifierGetter.getIdentifier(),
-                    ])];
+                block = new utils_1.Block(blockIdentifier);
+                return [2 /*return*/, this.fetchEndpoint('starknet_getBlockTransactionCount', [block.identifier])];
             });
         });
     };

package/dist/provider/sequencer.d.ts

@@ -27,6 +27,7 @@ export declare class SequencerProvider implements ProviderInterface {
     private getQueryString;
     private getHeaders;
     protected fetchEndpoint<T extends keyof Sequencer.Endpoints>(endpoint: T, ...[query, request]: Sequencer.Endpoints[T]['QUERY'] extends never ? Sequencer.Endpoints[T]['REQUEST'] extends never ? [] : [undefined, Sequencer.Endpoints[T]['REQUEST']] : Sequencer.Endpoints[T]['REQUEST'] extends never ? [Sequencer.Endpoints[T]['QUERY']] : [Sequencer.Endpoints[T]['QUERY'], Sequencer.Endpoints[T]['REQUEST']]): Promise<Sequencer.Endpoints[T]['RESPONSE']>;
+    getChainId(): Promise<StarknetChainId>;
     callContract({ contractAddress, entrypoint: entryPointSelector, calldata }: Call, blockIdentifier?: BlockIdentifier): Promise<CallContractResponse>;
     getBlock(blockIdentifier?: BlockIdentifier): Promise<GetBlockResponse>;
     getStorageAt(contractAddress: string, key: BigNumberish, blockIdentifier?: BlockIdentifier): Promise<BigNumberish>;

package/dist/provider/sequencer.js

@@ -134,7 +134,8 @@ var SequencerProvider = /** @class */ (function () {
             .map(function (_a) {
             var _b = __read(_a, 2), key = _b[0], value = _b[1];
             if (key === 'blockIdentifier') {
-                return "".concat((0, utils_1.getFormattedBlockIdentifier)(value));
+                var block = new utils_1.Block(value);
+                return "".concat(block.queryIdentifier);
             }
             return "".concat(key, "=").concat(value);
         })
@@ -227,6 +228,13 @@ var SequencerProvider = /** @class */ (function () {
             });
         });
     };
+    SequencerProvider.prototype.getChainId = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, Promise.resolve(this.chainId)];
+            });
+        });
+    };
     SequencerProvider.prototype.callContract = function (_a, blockIdentifier) {
         var contractAddress = _a.contractAddress, entryPointSelector = _a.entrypoint, _b = _a.calldata, calldata = _b === void 0 ? [] : _b;
         if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }

package/dist/provider/utils.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="bn.js" />
 import type { BlockNumber } from '../types';
 import { BigNumberish } from '../utils/number';
 /**
@@ -17,38 +16,15 @@ export declare function formatHash(hashValue: BigNumberish): string;
  */
 export declare function txIdentifier(txHash?: BigNumberish, txId?: BigNumberish): string;
 export declare type BlockIdentifier = BlockNumber | BigNumberish;
-declare type BlockIdentifierObject = {
-    type: 'BLOCK_NUMBER';
-    data: BlockNumber;
-} | {
-    type: 'BLOCK_HASH';
-    data: BigNumberish;
-};
-export declare class BlockIdentifierClass {
-    blockIdentifier: BlockIdentifier;
-    constructor(blockIdentifier: BlockIdentifier);
-    getIdentifier(): string | import("bn.js") | {
-        block_hash: string;
-        block_number?: undefined;
-    } | {
-        block_number: number;
-        block_hash?: undefined;
-    } | null;
+export declare class Block {
+    hash: BlockIdentifier;
+    number: BlockIdentifier;
+    tag: BlockIdentifier;
+    private setIdentifier;
+    constructor(_identifier: BlockIdentifier);
+    get queryIdentifier(): any;
+    get identifier(): any;
+    set identifier(_identifier: BlockIdentifier);
+    valueOf: () => BlockIdentifier;
+    toString: () => BlockIdentifier;
 }
-/**
- * Identifies the block to be queried.
- *
- * @param blockIdentifier - block identifier
- * @returns block identifier object
- */
-export declare function getBlockIdentifier(blockIdentifier: BlockIdentifier): BlockIdentifierObject;
-/**
- * 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 blockIdentifier
- * @returns block identifier for API request
- */
-export declare function getFormattedBlockIdentifier(blockIdentifier?: BlockIdentifier): string;
-export {};

package/dist/provider/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFormattedBlockIdentifier = exports.getBlockIdentifier = exports.BlockIdentifierClass = exports.txIdentifier = exports.formatHash = void 0;
+exports.Block = exports.txIdentifier = exports.formatHash = void 0;
 var number_1 = require("../utils/number");
 /**
  *
@@ -29,67 +29,56 @@ function txIdentifier(txHash, txId) {
     return "transactionHash=".concat(hashString);
 }
 exports.txIdentifier = txIdentifier;
-var BlockIdentifierClass = /** @class */ (function () {
-    function BlockIdentifierClass(blockIdentifier) {
-        this.blockIdentifier = blockIdentifier;
+var Block = /** @class */ (function () {
+    function Block(_identifier) {
+        var _this = this;
+        this.hash = null;
+        this.number = null;
+        this.tag = null;
+        this.valueOf = function () { return _this.number; };
+        this.toString = function () { return _this.hash; };
+        this.setIdentifier = function (__identifier) {
+            if (typeof __identifier === 'string' && (0, number_1.isHex)(__identifier)) {
+                this.hash = __identifier;
+            }
+            else if (typeof __identifier === 'number') {
+                this.number = __identifier;
+            }
+            else {
+                this.tag = __identifier;
+            }
+        };
+        this.setIdentifier(_identifier);
     }
-    BlockIdentifierClass.prototype.getIdentifier = function () {
-        if (typeof this.blockIdentifier === 'string' && (0, number_1.isHex)(this.blockIdentifier)) {
-            return { block_hash: this.blockIdentifier };
-        }
-        if (typeof this.blockIdentifier === 'number') {
-            return { block_number: this.blockIdentifier };
-        }
-        return this.blockIdentifier;
-    };
-    return BlockIdentifierClass;
+    Object.defineProperty(Block.prototype, "queryIdentifier", {
+        get: function () {
+            if (this.number !== null) {
+                return "blockNumber=".concat(this.number);
+            }
+            if (this.hash !== null) {
+                return "blockHash=".concat(this.hash);
+            }
+            return "blockNumber=".concat(this.tag);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Block.prototype, "identifier", {
+        get: function () {
+            if (this.number !== null) {
+                return { block_number: this.number };
+            }
+            if (this.hash !== null) {
+                return { block_hash: this.hash };
+            }
+            return this.tag;
+        },
+        set: function (_identifier) {
+            this.setIdentifier(_identifier);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return Block;
 }());
-exports.BlockIdentifierClass = BlockIdentifierClass;
-/**
- * Identifies the block to be queried.
- *
- * @param blockIdentifier - block identifier
- * @returns block identifier object
- */
-function getBlockIdentifier(blockIdentifier) {
-    if (blockIdentifier === null || blockIdentifier === 'latest') {
-        return { type: 'BLOCK_NUMBER', data: 'latest' }; // default to latest block
-    }
-    if (blockIdentifier === 'pending') {
-        return { type: 'BLOCK_NUMBER', data: 'pending' };
-    }
-    if (typeof blockIdentifier === 'number' || typeof blockIdentifier === 'bigint') {
-        return { type: 'BLOCK_NUMBER', data: blockIdentifier };
-    }
-    if (typeof blockIdentifier === 'string' && blockIdentifier.startsWith('0x')) {
-        return { type: 'BLOCK_HASH', data: blockIdentifier };
-    }
-    if (typeof blockIdentifier === 'string' && !Number.isNaN(parseInt(blockIdentifier, 10))) {
-        return { type: 'BLOCK_NUMBER', data: parseInt(blockIdentifier, 10) };
-    }
-    if (typeof blockIdentifier === 'string') {
-        throw new Error("Invalid block identifier: ".concat(blockIdentifier));
-    }
-    return { type: 'BLOCK_HASH', data: blockIdentifier };
-}
-exports.getBlockIdentifier = getBlockIdentifier;
-/**
- * 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 blockIdentifier
- * @returns block identifier for API request
- */
-function getFormattedBlockIdentifier(blockIdentifier) {
-    if (blockIdentifier === void 0) { blockIdentifier = null; }
-    var blockIdentifierObject = getBlockIdentifier(blockIdentifier);
-    if (blockIdentifierObject.type === 'BLOCK_NUMBER' && blockIdentifierObject.data === null) {
-        return '';
-    }
-    if (blockIdentifierObject.type === 'BLOCK_NUMBER') {
-        return "blockNumber=".concat(blockIdentifierObject.data);
-    }
-    return "blockHash=".concat((0, number_1.toHex)((0, number_1.toBN)(blockIdentifierObject.data)));
-}
-exports.getFormattedBlockIdentifier = getFormattedBlockIdentifier;
+exports.Block = Block;