starknet 2.3.0 → 2.6.0

package/dist/provider/default.js

@@ -61,7 +61,7 @@ function wait(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 +80,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';
         }
@@ -109,16 +109,17 @@ 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#L17-L25)
      *
-     * @param invokeTx - transaction to be invoked
-     * @param blockId
+     * @param invokeTransaction - transaction to be invoked
+     * @param blockNumber
      * @returns the result of the function on the smart contract.
      */
-    Provider.prototype.callContract = function (invokeTx, blockId) {
+    Provider.prototype.callContract = function (invokeTransaction, blockNumber) {
+        if (blockNumber === void 0) { blockNumber = null; }
         return __awaiter(this, void 0, void 0, function () {
             var 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: return [4 /*yield*/, axios_1.default.post((0, url_join_1.default)(this.feederGatewayUrl, 'call_contract', "?blockNumber=" + blockNumber), __assign({ signature: [], calldata: [] }, invokeTransaction))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -131,15 +132,16 @@ 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#L27-L31)
      *
-     * @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 () {
             var 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: return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_block', "?blockNumber=" + blockNumber))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -153,15 +155,16 @@ 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#L33-L36)
      *
      * @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 () {
             var 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: return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_code', "?contractAddress=" + contractAddress + "&blockNumber=" + blockNumber))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -177,15 +180,16 @@ var Provider = /** @class */ (function () {
      *
      * @param contractAddress
      * @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 () {
             var 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: 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:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -199,7 +203,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 +226,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 +248,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];
@@ -308,20 +312,21 @@ var Provider = /** @class */ (function () {
                 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') {
@@ -330,8 +335,8 @@ var Provider = /** @class */ (function () {
                         else if (res.tx_status === 'NOT_RECEIVED') {
                             throw Error('NOT_RECEIVED');
                         }
-                        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;
@@ -16,30 +16,30 @@ 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#L17-L25)
      *
-     * @param invokeTx - transaction to be invoked
-     * @param blockId
+     * @param invokeTransaction - transaction to be invoked
+     * @param blockNumber
      * @returns the result of the function on the smart contract.
      */
-    abstract callContract(invokeTx: CallContractTransaction, blockId?: number): Promise<CallContractResponse>;
+    abstract callContract(invokeTransaction: CallContractTransaction, blockNumber?: BlockNumber): Promise<CallContractResponse>;
     /**
      * Gets the block information from a block ID.
      *
      * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L27-L31)
      *
-     * @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>;
     /**
      * 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)
      *
      * @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>;
     /**
      * Gets the contract's storage variable at a specific key.
      *
@@ -47,17 +47,17 @@ export declare abstract class ProviderInterface {
      *
      * @param contractAddress
      * @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>;
     /**
      * 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 +66,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 +74,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 +95,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/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>;
 }

package/dist/types.d.ts

@@ -1,13 +1,13 @@
 import type { ec as EC } from 'elliptic';
 import type { BigNumberish } from './utils/number';
 export declare type KeyPair = EC.KeyPair;
-export declare type Signature = EC.Signature;
+export declare type Signature = BigNumberish[];
 export declare type GetContractAddressesResponse = {
     Starknet: string;
     GpsStatementVerifier: string;
 };
-export declare type Status = 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'REJECTED' | 'ACCEPTED_ONCHAIN';
-export declare type TxStatus = 'TRANSACTION_RECEIVED';
+export declare type Status = 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
+export declare type TransactionStatus = 'TRANSACTION_RECEIVED';
 export declare type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
 export declare type EntryPointType = 'EXTERNAL';
 export declare type CompressedProgram = string;
@@ -33,6 +33,7 @@ export declare type StructAbi = {
 export declare type Abi = FunctionAbi | StructAbi;
 export declare type EntryPointsByType = object;
 export declare type Program = object;
+export declare type BlockNumber = 'pending' | null | number;
 export declare type CompiledContract = {
     abi: Abi[];
     entry_points_by_type: EntryPointsByType;
@@ -44,14 +45,16 @@ export declare type DeployTransaction = {
     contract_definition: CompressedCompiledContract;
     contract_address_salt: BigNumberish;
     constructor_calldata: string[];
+    nonce?: BigNumberish;
 };
 export declare type InvokeFunctionTransaction = {
     type: 'INVOKE_FUNCTION';
     contract_address: string;
-    signature?: [BigNumberish, BigNumberish];
+    signature?: Signature;
     entry_point_type?: EntryPointType;
     entry_point_selector: string;
     calldata?: string[];
+    nonce?: BigNumberish;
 };
 export declare type CallContractTransaction = Omit<InvokeFunctionTransaction, 'type'>;
 export declare type Transaction = DeployTransaction | InvokeFunctionTransaction;
@@ -75,7 +78,7 @@ export declare type GetBlockResponse = {
                 payload: string[];
                 from_address: string;
             }[];
-            block_number: number;
+            block_number: BlockNumber;
             status: Status;
             transaction_index: number;
         };
@@ -95,12 +98,12 @@ export declare type GetTransactionResponse = {
     status: Status;
     transaction: Transaction;
     block_hash: string;
-    block_number: number;
+    block_number: BlockNumber;
     transaction_index: number;
     transaction_hash: string;
 };
 export declare type AddTransactionResponse = {
-    code: TxStatus;
+    code: TransactionStatus;
     transaction_hash: string;
     address?: string;
 };

package/dist/utils/ellipticCurve.d.ts

@@ -5,5 +5,12 @@ export declare const ec: EC;
 export declare const genKeyPair: (options?: EC.GenKeyPairOptions | undefined) => EC.KeyPair;
 export declare function getKeyPair(pk: BigNumberish): KeyPair;
 export declare function getStarkKey(keyPair: KeyPair): string;
+/**
+ * Takes a public key and casts it into `elliptic` KeyPair format.
+ *
+ * @param publicKey - public key which should get casted to a KeyPair
+ * @returns keyPair with public key only, which can be used to verify signatures, but cant sign anything
+ */
+export declare function getKeyPairFromPublicKey(publicKey: BigNumberish): KeyPair;
 export declare function sign(keyPair: KeyPair, msgHash: string): Signature;
-export declare function verify(keyPair: KeyPair, msgHash: string, sig: Signature): boolean;
+export declare function verify(keyPair: KeyPair | KeyPair[], msgHash: string, sig: Signature): boolean;

package/dist/utils/ellipticCurve.js

@@ -1,9 +1,25 @@
 "use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verify = exports.sign = exports.getStarkKey = exports.getKeyPair = exports.genKeyPair = exports.ec = void 0;
+exports.verify = exports.sign = exports.getKeyPairFromPublicKey = exports.getStarkKey = exports.getKeyPair = exports.genKeyPair = exports.ec = void 0;
 var elliptic_1 = require("elliptic");
 var hash_js_1 = __importDefault(require("hash.js"));
 var minimalistic_assert_1 = __importDefault(require("minimalistic-assert"));
@@ -50,6 +66,17 @@ function getStarkKey(keyPair) {
     return (0, encode_1.addHexPrefix)((0, encode_1.sanitizeBytes)(keyPair.pub.getX().toString(16), 2));
 }
 exports.getStarkKey = getStarkKey;
+/**
+ * Takes a public key and casts it into `elliptic` KeyPair format.
+ *
+ * @param publicKey - public key which should get casted to a KeyPair
+ * @returns keyPair with public key only, which can be used to verify signatures, but cant sign anything
+ */
+function getKeyPairFromPublicKey(publicKey) {
+    var publicKeyBn = (0, number_1.toBN)(publicKey);
+    return exports.ec.keyFromPublic((0, encode_1.removeHexPrefix)((0, number_1.toHex)(publicKeyBn)), 'hex');
+}
+exports.getKeyPairFromPublicKey = getKeyPairFromPublicKey;
 /*
  Signs a message using the provided key.
  key should be an KeyPair with a valid private key.
@@ -66,9 +93,14 @@ function sign(keyPair, msgHash) {
     (0, number_1.assertInRange)(r, constants_1.ONE, (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.MAX_ECDSA_VAL)), 'r');
     (0, number_1.assertInRange)(s, constants_1.ONE, (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.EC_ORDER)), 's');
     (0, number_1.assertInRange)(w, constants_1.ONE, (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.MAX_ECDSA_VAL)), 'w');
-    return msgSignature;
+    return [r, s];
 }
 exports.sign = sign;
+function chunkArray(arr, n) {
+    return Array(Math.ceil(arr.length / n))
+        .fill('')
+        .map(function (_, i) { return arr.slice(i * n, i * n + n); });
+}
 /*
    Verifies a message using the provided key.
    key should be an KeyPair with a valid public key.
@@ -76,14 +108,21 @@ exports.sign = sign;
    Returns a boolean true if the verification succeeds.
   */
 function verify(keyPair, msgHash, sig) {
+    var keyPairArray = Array.isArray(keyPair) ? keyPair : [keyPair];
     var msgHashBN = (0, number_1.toBN)((0, encode_1.addHexPrefix)(msgHash));
+    (0, minimalistic_assert_1.default)(sig.length % 2 === 0, 'Signature must be an array of length dividable by 2');
     (0, number_1.assertInRange)(msgHashBN, constants_1.ZERO, (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.MAX_ECDSA_VAL)), 'msgHash');
-    var r = sig.r, s = sig.s;
-    var w = s.invm(exports.ec.n);
-    // Verify signature has valid length.
-    (0, number_1.assertInRange)(r, constants_1.ONE, (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.MAX_ECDSA_VAL)), 'r');
-    (0, number_1.assertInRange)(s, constants_1.ONE, (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.EC_ORDER)), 's');
-    (0, number_1.assertInRange)(w, constants_1.ONE, (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.MAX_ECDSA_VAL)), 'w');
-    return keyPair.verify(fixMessage(msgHash), sig);
+    (0, minimalistic_assert_1.default)(keyPairArray.length === sig.length / 2, 'Signature and keyPair length must be equal');
+    return chunkArray(sig, 2).every(function (_a, i) {
+        var _b;
+        var _c = __read(_a, 2), r = _c[0], s = _c[1];
+        var rBN = (0, number_1.toBN)(r);
+        var sBN = (0, number_1.toBN)(s);
+        var w = sBN.invm(exports.ec.n);
+        (0, number_1.assertInRange)(rBN, constants_1.ONE, (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.MAX_ECDSA_VAL)), 'r');
+        (0, number_1.assertInRange)(sBN, constants_1.ONE, (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.EC_ORDER)), 's');
+        (0, number_1.assertInRange)(w, constants_1.ONE, (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.MAX_ECDSA_VAL)), 'w');
+        return (_b = exports.ec.verify(fixMessage(msgHash), { r: rBN, s: sBN }, keyPairArray[i])) !== null && _b !== void 0 ? _b : false;
+    });
 }
 exports.verify = verify;