starknet 2.1.1 → 2.4.0

package/CHANGELOG.md

@@ -1,9 +1,54 @@
+# [2.4.0](https://github.com/seanjameshan/starknet.js/compare/v2.3.1...v2.4.0) (2021-12-09)
+
+### Features
+
+- allow custom nonce ([17666de](https://github.com/seanjameshan/starknet.js/commit/17666de94db6875bbf8e88555773b8862a4a32cf))
+
+## [2.3.1](https://github.com/seanjameshan/starknet.js/compare/v2.3.0...v2.3.1) (2021-12-01)
+
+### Bug Fixes
+
+- allow structs in calldata ([fd2bdc0](https://github.com/seanjameshan/starknet.js/commit/fd2bdc0a1756544e4162fa5baaa7d3aec6f97bee))
+- struct compiling ([84617ae](https://github.com/seanjameshan/starknet.js/commit/84617aefe1218f421ca446b2a3c9959252d326e6))
+- struct data ([313dff5](https://github.com/seanjameshan/starknet.js/commit/313dff57f54050747c65b32b3378762c349d9c8c))
+- uint256 type ([2e05902](https://github.com/seanjameshan/starknet.js/commit/2e05902268f76bda2ae9b4e75782fa78876c2f00))
+
+# [2.3.0](https://github.com/seanjameshan/starknet.js/compare/v2.2.0...v2.3.0) (2021-12-01)
+
+### Features
+
+- add compileStructToCalldata ([e5bdb18](https://github.com/seanjameshan/starknet.js/commit/e5bdb1890e0bc53b03d4b145069cf7fbc639e830))
+- **utils:** support shortstring and uint256 ([f7ff057](https://github.com/seanjameshan/starknet.js/commit/f7ff05753d9bc39b31bdd4e7f893ee04cab77823))
+
+# [2.2.0](https://github.com/seanjameshan/starknet.js/compare/v2.1.0...v2.2.0) (2021-11-30)
+
+### Bug Fixes
+
+- bump version ([02c8d07](https://github.com/seanjameshan/starknet.js/commit/02c8d0772e42c81e35a3a841169eb25cde68716e))
+- correctly parse structs in Starknet return types ([5a4a318](https://github.com/seanjameshan/starknet.js/commit/5a4a318dad4c78fe84540ad92063fc1879317ac1))
+- make Typescript compiler happy with constant types ([aedd895](https://github.com/seanjameshan/starknet.js/commit/aedd895a62e6018dd1d7330b004d54360007967f))
+- use urljoin ([4f1a040](https://github.com/seanjameshan/starknet.js/commit/4f1a04090f26f8e8565c516921d5d3332b6a4649))
+
+### Features
+
+- bump version ([fd22f41](https://github.com/seanjameshan/starknet.js/commit/fd22f41e39ec1c7f71c32019309f82ad0f4d66a9))
+
+## [2.1.1](https://github.com/seanjameshan/starknet.js/compare/v2.1.0...v2.1.1) (2021-11-30)
+
+### Bug Fixes
+
+- bump version ([02c8d07](https://github.com/seanjameshan/starknet.js/commit/02c8d0772e42c81e35a3a841169eb25cde68716e))
+- correctly parse structs in Starknet return types ([5a4a318](https://github.com/seanjameshan/starknet.js/commit/5a4a318dad4c78fe84540ad92063fc1879317ac1))
+- make Typescript compiler happy with constant types ([aedd895](https://github.com/seanjameshan/starknet.js/commit/aedd895a62e6018dd1d7330b004d54360007967f))
+- use urljoin ([4f1a040](https://github.com/seanjameshan/starknet.js/commit/4f1a04090f26f8e8565c516921d5d3332b6a4649))
+
 ## [2.1.1](https://github.com/seanjameshan/starknet.js/compare/v2.1.0...v2.1.1) (2021-11-30)
 
 ### Bug Fixes
 
 - correctly parse structs in Starknet return types ([5a4a318](https://github.com/seanjameshan/starknet.js/commit/5a4a318dad4c78fe84540ad92063fc1879317ac1))
 - make Typescript compiler happy with constant types ([aedd895](https://github.com/seanjameshan/starknet.js/commit/aedd895a62e6018dd1d7330b004d54360007967f))
+- use urljoin ([4f1a040](https://github.com/seanjameshan/starknet.js/commit/4f1a04090f26f8e8565c516921d5d3332b6a4649))
 
 # [2.1.0](https://github.com/seanjameshan/starknet.js/compare/v2.0.1...v2.1.0) (2021-11-30)
 

package/__tests__/signer.test.ts

@@ -99,4 +99,21 @@ describe('deploy and test Wallet', () => {
 
     expect(number.toBN(res as string).toString()).toStrictEqual(number.toBN(990).toString());
   });
+  test('execute with custom nonce', async () => {
+    const { result } = await signer.callContract({
+      contract_address: signer.address,
+      entry_point_selector: stark.getSelectorFromName('get_nonce'),
+    });
+    const nonce = parseInt(result[0], 10);
+    const { code, transaction_hash } = await signer.addTransaction({
+      type: 'INVOKE_FUNCTION',
+      contract_address: erc20Address,
+      entry_point_selector: stark.getSelectorFromName('transfer'),
+      calldata: [erc20Address, '10'],
+      nonce,
+    });
+
+    expect(code).toBe('TRANSACTION_RECEIVED');
+    await defaultProvider.waitForTx(transaction_hash);
+  });
 });

package/__tests__/utils/shortString.test.ts

@@ -0,0 +1,22 @@
+import { decodeShortString, encodeShortString } from '../../src/utils/shortString';
+
+describe('shortString', () => {
+  test('should convert string to number', () => {
+    expect(encodeShortString('hello')).toMatchInlineSnapshot(`"0x68656c6c6f"`);
+  });
+  test('should convert number to string', () => {
+    expect(decodeShortString('0x68656c6c6f')).toMatchInlineSnapshot(`"hello"`);
+  });
+  test('should throw if string is too long', () => {
+    expect(() =>
+      encodeShortString('hello world hello world hello world hello world hello world hello world')
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"hello world hello world hello world hello world hello world hello world is too long"`
+    );
+  });
+  test('should throw if string contains non ascii chars', () => {
+    expect(() => encodeShortString('hello\uD83D\uDE00')).toThrowErrorMatchingInlineSnapshot(
+      `"hello😀 is not an ASCII string"`
+    );
+  });
+});

package/__tests__/utils/uint256.test.ts

@@ -0,0 +1,32 @@
+import { ONE } from '../../src/constants';
+import { toBN } from '../../src/utils/number';
+import { UINT_128_MAX, UINT_256_MAX, bnToUint256, uint256ToBN } from '../../src/utils/uint256';
+
+describe('cairo uint256', () => {
+  test('should convert 0 from BN to uint256 struct', () => {
+    const uint256 = bnToUint256('0');
+    expect(uint256).toMatchInlineSnapshot(`
+      Object {
+        "high": "0x0",
+        "low": "0x0",
+      }
+    `);
+  });
+  test('should convert 0 from uint256 to BN', () => {
+    expect(uint256ToBN({ low: '0x0', high: '0x0' }).toString()).toMatchInlineSnapshot(`"0"`);
+  });
+  test('should convert BN over 2^128 to uint256 struct', () => {
+    const uint256 = bnToUint256(UINT_128_MAX.add(ONE));
+    expect(uint256).toMatchInlineSnapshot(`
+      Object {
+        "high": "0x1",
+        "low": "0x0",
+      }
+    `);
+  });
+  test('should throw if BN over uint256 range', () => {
+    expect(() => bnToUint256(UINT_256_MAX.add(toBN(1)))).toThrowErrorMatchingInlineSnapshot(
+      `"Number is too large"`
+    );
+  });
+});

package/constants.d.ts

@@ -1,9 +1,9 @@
-import BN from 'bn.js';
+/// <reference types="bn.js" />
 export { IS_BROWSER } from './utils/encode';
-export declare const ZERO: BN;
-export declare const ONE: BN;
-export declare const TWO: BN;
-export declare const MASK_250: BN;
+export declare const ZERO: import('bn.js');
+export declare const ONE: import('bn.js');
+export declare const TWO: import('bn.js');
+export declare const MASK_250: import('bn.js');
 /**
  * The following is taken from https://github.com/starkware-libs/starkex-resources/blob/master/crypto/starkware/crypto/signature/pedersen_params.json but converted to hex, because JS is very bad handling big integers by default
  * Please do not edit until the JSON changes.

package/contract.d.ts

@@ -2,7 +2,13 @@ import { Provider } from './provider';
 import { Abi, StructAbi } from './types';
 import { BigNumberish } from './utils/number';
 export declare type Args = {
-  [inputName: string]: string | string[];
+  [inputName: string]:
+    | string
+    | string[]
+    | {
+        type: 'struct';
+        [k: string]: BigNumberish;
+      };
 };
 export declare type Calldata = string[];
 export declare function compileCalldata(args: Args): Calldata;

package/contract.js

@@ -216,6 +216,18 @@ function compileCalldata(args) {
         ),
         false
       );
+    if (typeof value === 'object' && 'type' in value)
+      return Object.entries(value)
+        .filter(function (_a) {
+          var _b = __read(_a, 1),
+            k = _b[0];
+          return k !== 'type';
+        })
+        .map(function (_a) {
+          var _b = __read(_a, 2),
+            v = _b[1];
+          return (0, number_1.toBN)(v).toString();
+        });
     return (0, number_1.toBN)(value).toString();
   });
 }
@@ -274,22 +286,28 @@ var Contract = /** @class */ (function () {
       return abi.name === method && abi.type === 'function';
     });
     methodAbi.inputs.forEach(function (input) {
-      if (args[input.name] !== undefined) {
+      var arg = args[input.name];
+      if (arg !== undefined) {
         if (input.type === 'felt') {
           (0, minimalistic_assert_1.default)(
-            typeof args[input.name] === 'string',
+            typeof arg === 'string',
             'arg ' + input.name + ' should be a felt (string)'
           );
           (0, minimalistic_assert_1.default)(
-            isFelt(args[input.name]),
+            isFelt(arg),
             'arg ' + input.name + ' should be decimal or hexadecimal'
           );
+        } else if (typeof arg === 'object' && 'type' in arg) {
+          (0, minimalistic_assert_1.default)(
+            arg.type === 'struct',
+            'arg ' + input.name + ' should be a struct'
+          );
         } else {
           (0, minimalistic_assert_1.default)(
-            Array.isArray(args[input.name]),
+            Array.isArray(arg),
             'arg ' + input.name + ' should be a felt* (string[])'
           );
-          args[input.name].forEach(function (felt, i) {
+          arg.forEach(function (felt, i) {
             (0,
             minimalistic_assert_1.default)(typeof felt === 'string', 'arg ' + input.name + '[' + i + '] should be a felt (string) as part of a felt* (string[])');
             (0,

package/dist/constants.d.ts

@@ -1,9 +1,9 @@
-import BN from 'bn.js';
+/// <reference types="bn.js" />
 export { IS_BROWSER } from './utils/encode';
-export declare const ZERO: BN;
-export declare const ONE: BN;
-export declare const TWO: BN;
-export declare const MASK_250: BN;
+export declare const ZERO: import("bn.js");
+export declare const ONE: import("bn.js");
+export declare const TWO: import("bn.js");
+export declare const MASK_250: import("bn.js");
 /**
  * The following is taken from https://github.com/starkware-libs/starkex-resources/blob/master/crypto/starkware/crypto/signature/pedersen_params.json but converted to hex, because JS is very bad handling big integers by default
  * Please do not edit until the JSON changes.

package/dist/contract.d.ts

@@ -2,7 +2,10 @@ import { Provider } from './provider';
 import { Abi, StructAbi } from './types';
 import { BigNumberish } from './utils/number';
 export declare type Args = {
-    [inputName: string]: string | string[];
+    [inputName: string]: string | string[] | {
+        type: 'struct';
+        [k: string]: BigNumberish;
+    };
 };
 export declare type Calldata = string[];
 export declare function compileCalldata(args: Args): Calldata;

package/dist/contract.js

@@ -101,6 +101,16 @@ function compileCalldata(args) {
     return Object.values(args).flatMap(function (value) {
         if (Array.isArray(value))
             return __spreadArray([(0, number_1.toBN)(value.length).toString()], __read(value.map(function (x) { return (0, number_1.toBN)(x).toString(); })), false);
+        if (typeof value === 'object' && 'type' in value)
+            return Object.entries(value)
+                .filter(function (_a) {
+                var _b = __read(_a, 1), k = _b[0];
+                return k !== 'type';
+            })
+                .map(function (_a) {
+                var _b = __read(_a, 2), v = _b[1];
+                return (0, number_1.toBN)(v).toString();
+            });
         return (0, number_1.toBN)(value).toString();
     });
 }
@@ -145,14 +155,18 @@ var Contract = /** @class */ (function () {
         // ensure args match abi type
         var methodAbi = this.abi.find(function (abi) { return abi.name === method && abi.type === 'function'; });
         methodAbi.inputs.forEach(function (input) {
-            if (args[input.name] !== undefined) {
+            var arg = args[input.name];
+            if (arg !== undefined) {
                 if (input.type === 'felt') {
-                    (0, minimalistic_assert_1.default)(typeof args[input.name] === 'string', "arg " + input.name + " should be a felt (string)");
-                    (0, minimalistic_assert_1.default)(isFelt(args[input.name]), "arg " + input.name + " should be decimal or hexadecimal");
+                    (0, minimalistic_assert_1.default)(typeof arg === 'string', "arg " + input.name + " should be a felt (string)");
+                    (0, minimalistic_assert_1.default)(isFelt(arg), "arg " + input.name + " should be decimal or hexadecimal");
+                }
+                else if (typeof arg === 'object' && 'type' in arg) {
+                    (0, minimalistic_assert_1.default)(arg.type === 'struct', "arg " + input.name + " should be a struct");
                 }
                 else {
-                    (0, minimalistic_assert_1.default)(Array.isArray(args[input.name]), "arg " + input.name + " should be a felt* (string[])");
-                    args[input.name].forEach(function (felt, i) {
+                    (0, minimalistic_assert_1.default)(Array.isArray(arg), "arg " + input.name + " should be a felt* (string[])");
+                    arg.forEach(function (felt, i) {
                         (0, minimalistic_assert_1.default)(typeof felt === 'string', "arg " + input.name + "[" + i + "] should be a felt (string) as part of a felt* (string[])");
                         (0, minimalistic_assert_1.default)(isFelt(felt), "arg " + input.name + "[" + i + "] should be decimal or hexadecimal as part of a felt* (string[])");
                     });

package/dist/index.d.ts

@@ -15,3 +15,5 @@ export * as json from './utils/json';
 export * as number from './utils/number';
 export * as stark from './utils/stark';
 export * as ec from './utils/ellipticCurve';
+export * as uint256 from './utils/uint256';
+export * as shortString from './utils/shortString';

package/dist/index.js

@@ -22,7 +22,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ec = exports.stark = exports.number = exports.json = exports.hash = exports.encode = exports.constants = void 0;
+exports.shortString = exports.uint256 = exports.ec = exports.stark = exports.number = exports.json = exports.hash = exports.encode = exports.constants = void 0;
 /**
  * Main
  */
@@ -40,3 +40,5 @@ exports.json = __importStar(require("./utils/json"));
 exports.number = __importStar(require("./utils/number"));
 exports.stark = __importStar(require("./utils/stark"));
 exports.ec = __importStar(require("./utils/ellipticCurve"));
+exports.uint256 = __importStar(require("./utils/uint256"));
+exports.shortString = __importStar(require("./utils/shortString"));

package/dist/provider/default.d.ts

@@ -12,7 +12,7 @@ export declare class Provider implements ProviderInterface {
     feederGatewayUrl: string;
     gatewayUrl: string;
     constructor(optionsOrProvider?: ProviderOptions | Provider);
-    protected static getNetworkFromName(name: NetworkName): "http://alpha-mainnet.starknet.io/" | "https://alpha4.starknet.io";
+    protected static getNetworkFromName(name: NetworkName): "https://alpha-mainnet.starknet.io" | "https://alpha4.starknet.io";
     /**
      * Gets the smart contract address on the goerli testnet.
      *
@@ -25,11 +25,11 @@ export declare class Provider implements ProviderInterface {
      *
      * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L17-L25)
      *
-     * @param invokeTx - transaction to be invoked
+     * @param invokeTransaction - transaction to be invoked
      * @param blockId
      * @returns the result of the function on the smart contract.
      */
-    callContract(invokeTx: CallContractTransaction, blockId?: number): Promise<CallContractResponse>;
+    callContract(invokeTransaction: CallContractTransaction, blockId?: number): Promise<CallContractResponse>;
     /**
      * Gets the block information from a block ID.
      *
@@ -83,10 +83,10 @@ export declare class Provider implements ProviderInterface {
      *
      * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/gateway/gateway_client.py#L13-L17)
      *
-     * @param tx - transaction to be invoked
+     * @param transaction - transaction to be invoked
      * @returns a confirmation of invoking a function on the starknet contract
      */
-    addTransaction(tx: Transaction): Promise<AddTransactionResponse>;
+    addTransaction(transaction: Transaction): Promise<AddTransactionResponse>;
     /**
      * Deploys a given compiled contract (json) to starknet
      *

package/dist/provider/default.js

@@ -52,6 +52,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Provider = void 0;
 var axios_1 = __importDefault(require("axios"));
+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");
@@ -71,14 +72,14 @@ var Provider = /** @class */ (function () {
                 ? optionsOrProvider.baseUrl
                 : Provider.getNetworkFromName(optionsOrProvider.network);
             this.baseUrl = baseUrl;
-            this.feederGatewayUrl = baseUrl + "/feeder_gateway";
-            this.gatewayUrl = baseUrl + "/gateway";
+            this.feederGatewayUrl = (0, url_join_1.default)(baseUrl, 'feeder_gateway');
+            this.gatewayUrl = (0, url_join_1.default)(baseUrl, 'gateway');
         }
     }
     Provider.getNetworkFromName = function (name) {
         switch (name) {
             case 'mainnet-alpha':
-                return 'http://alpha-mainnet.starknet.io/';
+                return 'https://alpha-mainnet.starknet.io';
             case 'georli-alpha':
             default:
                 return 'https://alpha4.starknet.io';
@@ -95,7 +96,7 @@ var Provider = /** @class */ (function () {
             var data;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, axios_1.default.get(this.feederGatewayUrl + "/get_contract_addresses")];
+                    case 0: return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_contract_addresses'))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -108,16 +109,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#L17-L25)
      *
-     * @param invokeTx - transaction to be invoked
+     * @param invokeTransaction - transaction to be invoked
      * @param blockId
      * @returns the result of the function on the smart contract.
      */
-    Provider.prototype.callContract = function (invokeTx, blockId) {
+    Provider.prototype.callContract = function (invokeTransaction, blockId) {
         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(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', "?blockId=" + (blockId !== null && blockId !== void 0 ? blockId : 'null')), __assign({ signature: [], calldata: [] }, invokeTransaction))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -138,7 +139,7 @@ var Provider = /** @class */ (function () {
             var data;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, axios_1.default.get(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', "?blockId=" + (blockId !== null && blockId !== void 0 ? blockId : 'null')))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -160,7 +161,7 @@ var Provider = /** @class */ (function () {
             var data;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, axios_1.default.get(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 + "&blockId=" + (blockId !== null && blockId !== void 0 ? blockId : 'null')))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -184,7 +185,7 @@ var Provider = /** @class */ (function () {
             var data;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, axios_1.default.get(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 + "&blockId=" + (blockId !== null && blockId !== void 0 ? blockId : 'null')))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -207,7 +208,7 @@ var Provider = /** @class */ (function () {
                 switch (_a.label) {
                     case 0:
                         txHashBn = (0, number_1.toBN)(txHash);
-                        return [4 /*yield*/, axios_1.default.get(this.feederGatewayUrl + "/get_transaction_status?transactionHash=" + (0, number_1.toHex)(txHashBn))];
+                        return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_transaction_status', "?transactionHash=" + (0, number_1.toHex)(txHashBn)))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -230,7 +231,7 @@ var Provider = /** @class */ (function () {
                 switch (_a.label) {
                     case 0:
                         txHashBn = (0, number_1.toBN)(txHash);
-                        return [4 /*yield*/, axios_1.default.get(this.feederGatewayUrl + "/get_transaction?transactionHash=" + (0, number_1.toHex)(txHashBn))];
+                        return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_transaction', "?transactionHash=" + (0, number_1.toHex)(txHashBn)))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -243,18 +244,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(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];

package/dist/provider/interface.d.ts

@@ -16,11 +16,11 @@ 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 invokeTransaction - transaction to be invoked
      * @param blockId
      * @returns the result of the function on the smart contract.
      */
-    abstract callContract(invokeTx: CallContractTransaction, blockId?: number): Promise<CallContractResponse>;
+    abstract callContract(invokeTransaction: CallContractTransaction, blockId?: number): Promise<CallContractResponse>;
     /**
      * Gets the block information from a block ID.
      *
@@ -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
      *

package/dist/signer/default.d.ts

@@ -10,8 +10,8 @@ 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>;
 }

package/dist/signer/default.js

@@ -100,34 +100,39 @@ 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;
+            var nonceBn, result, calldataDecimal, msgHash, _a, r, s;
             return __generator(this, function (_b) {
                 switch (_b.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:
+                        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 = (_b.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()));
+                        _b.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()));
                         _a = (0, ellipticCurve_1.sign)(this.keyPair, msgHash), r = _a.r, s = _a.s;
                         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(),

package/dist/signer/interface.d.ts

@@ -7,8 +7,8 @@ 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>;
 }

package/dist/types.d.ts

@@ -7,7 +7,7 @@ export declare type GetContractAddressesResponse = {
     GpsStatementVerifier: string;
 };
 export declare type Status = 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'REJECTED' | 'ACCEPTED_ONCHAIN';
-export declare type TxStatus = 'TRANSACTION_RECEIVED';
+export declare type TransactionStatus = 'TRANSACTION_RECEIVED';
 export declare type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
 export declare type EntryPointType = 'EXTERNAL';
 export declare type CompressedProgram = string;
@@ -44,6 +44,7 @@ export declare type DeployTransaction = {
     contract_definition: CompressedCompiledContract;
     contract_address_salt: BigNumberish;
     constructor_calldata: string[];
+    nonce?: BigNumberish;
 };
 export declare type InvokeFunctionTransaction = {
     type: 'INVOKE_FUNCTION';
@@ -52,6 +53,7 @@ export declare type InvokeFunctionTransaction = {
     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;
@@ -100,7 +102,7 @@ export declare type GetTransactionResponse = {
     transaction_hash: string;
 };
 export declare type AddTransactionResponse = {
-    code: TxStatus;
+    code: TransactionStatus;
     transaction_hash: string;
     address?: string;
 };

package/dist/utils/shortString.d.ts

@@ -0,0 +1,4 @@
+export declare function isASCII(str: string): boolean;
+export declare function isShortString(str: string): boolean;
+export declare function encodeShortString(str: string): string;
+export declare function decodeShortString(str: string): string;