starknet 2.3.1 → 2.7.0

package/dist/provider/default.js

@@ -56,12 +56,13 @@ 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); });
 }
 var Provider = /** @class */ (function () {
     function Provider(optionsOrProvider) {
-        if (optionsOrProvider === void 0) { optionsOrProvider = { network: 'georli-alpha' }; }
+        if (optionsOrProvider === void 0) { optionsOrProvider = { network: 'goerli-alpha' }; }
         if (optionsOrProvider instanceof Provider) {
             this.baseUrl = optionsOrProvider.baseUrl;
             this.feederGatewayUrl = optionsOrProvider.feederGatewayUrl;
@@ -80,7 +81,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';
         }
@@ -107,18 +108,22 @@ 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: 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: [] }, invokeTx))];
+                    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', formattedBlockIdentifier), __assign({ signature: [], calldata: [] }, invokeTransaction))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -127,19 +132,23 @@ 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: 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:
+                        formattedBlockIdentifier = (0, utils_1.getFormattedBlockIdentifier)(blockHash, blockNumber);
+                        return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_block', formattedBlockIdentifier))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -150,18 +159,22 @@ 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: 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:
+                        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 + "&" + formattedBlockIdentifier))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -173,19 +186,23 @@ 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: 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:
+                        formattedBlockIdentifier = (0, utils_1.getFormattedBlockIdentifier)(blockHash, blockNumber);
+                        return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_storage_at', "?contractAddress=" + contractAddress + "&key=" + key + "&" + formattedBlockIdentifier))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -199,7 +216,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 () {
@@ -222,7 +239,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 () {
@@ -244,18 +261,18 @@ 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);
-                        contract_address_salt = tx.type === 'DEPLOY' && (0, number_1.toHex)((0, number_1.toBN)(tx.contract_address_salt));
-                        return [4 /*yield*/, axios_1.default.post((0, url_join_1.default)(this.gatewayUrl, 'add_transaction'), (0, json_1.stringify)(__assign(__assign(__assign({}, tx), (Array.isArray(signature) && { signature: signature })), (contract_address_salt && { contract_address_salt: contract_address_salt }))), { headers: { 'Content-Type': 'application/json' } })];
+                        signature = transaction.type === 'INVOKE_FUNCTION' && (0, stark_1.formatSignature)(transaction.signature);
+                        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((0, url_join_1.default)(this.gatewayUrl, 'add_transaction'), (0, json_1.stringify)(__assign(__assign(__assign({}, transaction), (Array.isArray(signature) && { signature: signature })), (contract_address_salt && { contract_address_salt: contract_address_salt }))), { headers: { 'Content-Type': 'application/json' } })];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -303,35 +320,35 @@ var Provider = /** @class */ (function () {
     Provider.prototype.waitForTx = function (txHash, retryInterval) {
         if (retryInterval === void 0) { 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 [2 /*return*/];
+                        return [3 /*break*/, 2];
+                    case 5: return [2 /*return*/];
                 }
             });
         });

package/dist/provider/interface.d.ts

@@ -1,4 +1,4 @@
-import type { AddTransactionResponse, CallContractResponse, CallContractTransaction, CompiledContract, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, 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';
 export declare abstract class ProviderInterface {
     abstract baseUrl: string;
@@ -14,50 +14,54 @@ 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): Promise<CallContractResponse>;
+    abstract 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 }
      */
-    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>;
     /**
@@ -66,7 +70,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>;
     /**
@@ -74,10 +78,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
      *
@@ -95,6 +99,6 @@ export declare abstract class ProviderInterface {
      * @param signature - (optional) signature to send along
      * @returns response from addTransaction
      */
-    abstract invokeFunction(contractAddress: string, entrypointSelector: string, calldata?: string[], signature?: [BigNumberish, BigNumberish]): Promise<AddTransactionResponse>;
+    abstract invokeFunction(contractAddress: string, entrypointSelector: string, calldata?: string[], signature?: Signature): Promise<AddTransactionResponse>;
     abstract waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }

package/dist/provider/utils.d.ts

@@ -0,0 +1,27 @@
+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/dist/provider/utils.js

@@ -0,0 +1,37 @@
+"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;

package/dist/signer/default.d.ts

@@ -1,5 +1,6 @@
 import { Provider } from '../provider';
-import { AddTransactionResponse, KeyPair, Transaction } from '../types';
+import { AddTransactionResponse, KeyPair, Signature, Transaction } from '../types';
+import { TypedData } from '../utils/typedData';
 import { SignerInterface } from './interface';
 export declare class Signer extends Provider implements SignerInterface {
     address: string;
@@ -10,8 +11,24 @@ export declare class Signer extends Provider implements SignerInterface {
      *
      * [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>;
+    /**
+     * Sign an JSON object with the starknet private key and return the signature
+     *
+     * @param json - JSON object to be signed
+     * @returns the signature of the JSON object
+     * @throws {Error} if the JSON object is not a valid JSON
+     */
+    signMessage(typedData: TypedData): Promise<Signature>;
+    /**
+     * Hash a JSON object with pederson hash and return the hash
+     *
+     * @param json - JSON object to be hashed
+     * @returns the hash of the JSON object
+     * @throws {Error} if the JSON object is not a valid JSON
+     */
+    hashMessage(typedData: TypedData): Promise<string>;
 }

package/dist/signer/default.js

@@ -87,6 +87,7 @@ var encode_1 = require("../utils/encode");
 var hash_1 = require("../utils/hash");
 var number_1 = require("../utils/number");
 var stark_1 = require("../utils/stark");
+var typedData_1 = require("../utils/typedData");
 var Signer = /** @class */ (function (_super) {
     __extends(Signer, _super);
     function Signer(provider, address, keyPair) {
@@ -100,45 +101,85 @@ var Signer = /** @class */ (function (_super) {
      *
      * [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
      */
-    Signer.prototype.addTransaction = function (tx) {
+    Signer.prototype.addTransaction = function (transaction) {
         return __awaiter(this, void 0, void 0, function () {
-            var result, nonceBn, calldataDecimal, msgHash, _a, r, s;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var nonceBn, result, calldataDecimal, msgHash, signature;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
-                        if (tx.type === 'DEPLOY')
-                            return [2 /*return*/, _super.prototype.addTransaction.call(this, tx)];
-                        (0, minimalistic_assert_1.default)(!tx.signature, "Adding signatures to a signer tx currently isn't supported");
-                        return [4 /*yield*/, this.callContract({
-                                contract_address: this.address,
-                                entry_point_selector: (0, stark_1.getSelectorFromName)('get_nonce'),
-                            })];
-                    case 1:
-                        result = (_b.sent()).result;
+                        if (transaction.type === 'DEPLOY')
+                            return [2 /*return*/, _super.prototype.addTransaction.call(this, transaction)];
+                        (0, minimalistic_assert_1.default)(!transaction.signature, "Adding signatures to a signer transaction currently isn't supported");
+                        if (!transaction.nonce) return [3 /*break*/, 1];
+                        nonceBn = (0, number_1.toBN)(transaction.nonce);
+                        return [3 /*break*/, 3];
+                    case 1: return [4 /*yield*/, this.callContract({
+                            contract_address: this.address,
+                            entry_point_selector: (0, stark_1.getSelectorFromName)('get_nonce'),
+                        })];
+                    case 2:
+                        result = (_a.sent()).result;
                         nonceBn = (0, number_1.toBN)(result[0]);
-                        calldataDecimal = (tx.calldata || []).map(function (x) { return (0, number_1.toBN)(x).toString(); });
-                        msgHash = (0, encode_1.addHexPrefix)((0, hash_1.hashMessage)(this.address, tx.contract_address, tx.entry_point_selector, calldataDecimal, nonceBn.toString()));
-                        _a = (0, ellipticCurve_1.sign)(this.keyPair, msgHash), r = _a.r, s = _a.s;
+                        _a.label = 3;
+                    case 3:
+                        calldataDecimal = (transaction.calldata || []).map(function (x) { return (0, number_1.toBN)(x).toString(); });
+                        msgHash = (0, encode_1.addHexPrefix)((0, hash_1.hashMessage)(this.address, transaction.contract_address, transaction.entry_point_selector, calldataDecimal, nonceBn.toString()));
+                        signature = (0, ellipticCurve_1.sign)(this.keyPair, msgHash);
                         return [2 /*return*/, _super.prototype.addTransaction.call(this, {
                                 type: 'INVOKE_FUNCTION',
                                 entry_point_selector: (0, stark_1.getSelectorFromName)('execute'),
                                 calldata: __spreadArray(__spreadArray([
-                                    tx.contract_address,
-                                    tx.entry_point_selector,
+                                    transaction.contract_address,
+                                    transaction.entry_point_selector,
                                     calldataDecimal.length.toString()
                                 ], __read(calldataDecimal), false), [
                                     nonceBn.toString(),
                                 ], false).map(function (x) { return (0, number_1.toBN)(x).toString(); }),
                                 contract_address: this.address,
-                                signature: [r, s],
+                                signature: signature,
                             })];
                 }
             });
         });
     };
+    /**
+     * Sign an JSON object with the starknet private key and return the signature
+     *
+     * @param json - JSON object to be signed
+     * @returns the signature of the JSON object
+     * @throws {Error} if the JSON object is not a valid JSON
+     */
+    Signer.prototype.signMessage = function (typedData) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        _a = ellipticCurve_1.sign;
+                        _b = [this.keyPair];
+                        return [4 /*yield*/, this.hashMessage(typedData)];
+                    case 1: return [2 /*return*/, _a.apply(void 0, _b.concat([_c.sent()]))];
+                }
+            });
+        });
+    };
+    /**
+     * Hash a JSON object with pederson hash and return the hash
+     *
+     * @param json - JSON object to be hashed
+     * @returns the hash of the JSON object
+     * @throws {Error} if the JSON object is not a valid JSON
+     */
+    Signer.prototype.hashMessage = function (typedData) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, (0, typedData_1.getMessageHash)(typedData, this.address)];
+            });
+        });
+    };
     return Signer;
 }(provider_1.Provider));
 exports.Signer = Signer;

package/dist/signer/interface.d.ts

@@ -1,5 +1,6 @@
 import { Provider } from '../provider';
-import { AddTransactionResponse, Transaction } from '../types';
+import { AddTransactionResponse, Signature, Transaction } from '../types';
+import { TypedData } from '../utils/typedData/types';
 export declare abstract class SignerInterface extends Provider {
     abstract address: string;
     /**
@@ -7,8 +8,26 @@ export declare abstract class SignerInterface extends Provider {
      *
      * [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>;
+    /**
+     * Sign an JSON object for off-chain usage with the starknet private key and return the signature
+     * This adds a message prefix so it cant be interchanged with transactions
+     *
+     * @param json - JSON object to be signed
+     * @returns the signature of the JSON object
+     * @throws {Error} if the JSON object is not a valid JSON
+     */
+    abstract signMessage(typedData: TypedData): Promise<Signature>;
+    /**
+     * Hash a JSON object with pederson hash and return the hash
+     * This adds a message prefix so it cant be interchanged with transactions
+     *
+     * @param json - JSON object to be hashed
+     * @returns the hash of the JSON object
+     * @throws {Error} if the JSON object is not a valid JSON
+     */
+    abstract hashMessage(typedData: TypedData): Promise<string>;
 }