starknet 2.0.2 → 2.3.0

package/CHANGELOG.md

@@ -1,3 +1,51 @@
+# [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)
+
+### Bug Fixes
+
+- deps ([020ba39](https://github.com/seanjameshan/starknet.js/commit/020ba3948f03e41fc96c7c002b613250d73fbda6))
+- transaction status pending ([198d82b](https://github.com/seanjameshan/starknet.js/commit/198d82b30dd8c0c978cfdd2d56cb5a7e5131cb6a))
+
+### Features
+
+- support mainnet ([de07149](https://github.com/seanjameshan/starknet.js/commit/de07149ad6521edc9f79e2b0e9c82bf40f32fe02))
+
 ## [2.0.2](https://github.com/seanjameshan/starknet.js/compare/v2.0.1...v2.0.2) (2021-11-22)
 
 ### Bug Fixes

package/README.md

@@ -44,14 +44,53 @@ $ npm install starknet
 
 Import `starknet` and use the [API](https://www.starknetjs.com/modules.html)
 
+The following code is used to build a [simple AMM example](https://starkfin.netlify.app/) from the [cairo docs](https://www.cairo-lang.org/docs/hello_starknet/amm.html)
+
 ```javascript
-import { defaultProvider } from 'starknet';
+import { defaultProvider, stark } from 'starknet';
+const { getSelectorFromName } = stark;
+
+const CONTRACT_ADDRESS =
+  "0x03e19baa6cb2078631bcdb34844f3f7879449a544c9ce722681a54af08cff4b9";
+
+/**
+ * addTransaction() example
+**/
+
+/** Reset the liquidity pool **/
+const addTokenResponse = await provider.addTransaction({
+  type: "INVOKE_FUNCTION",
+  contract_address: CONTRACT_ADDRESS,
+  entry_point_selector: getSelectorFromName("init_pool"),
+  calldata: ["1000000", "1000000"],
+});
+console.log(addTokenResponse);
+
+/**
+ * callContract() example
+**/
 
-defaultProvider.getContractAddresses().then((data) => {
-  console.log(data);
+/** Get the balance of the liquidity pool of token A **/
+const poolBalanceTokenA = await callContract({
+  contract_address: CONTRACT_ADDRESS,
+  entry_point_selector: getSelectorFromName("get_pool_token_balance"),
+  calldata: ["1"],
 });
+const balanceA = poolBalanceTokenA.result[0];
+console.log('token a liquidity pool balance: ', parseInt(balanceA, 16));
+
+/** Get the balance of the liquidity pool of token B **/
+const poolBalanceTokenB = await callContract({
+  contract_address: CONTRACT_ADDRESS,
+  entry_point_selector: getSelectorFromName("get_pool_token_balance"),
+  calldata: ["2"],
+});
+const balanceB = poolBalanceTokenB.result[0];
+console.log('token b liquidity pool balance: ', parseInt(balanceB, 16));
 ```
 
+For more information about **signing transactions**, please take a look at this [pull request](https://github.com/seanjameshan/starknet.js/pull/51)
+
 ## 🌐 API
 
 [Click Here](https://www.starknetjs.com/modules.html)
@@ -60,6 +99,7 @@ defaultProvider.getContractAddresses().then((data) => {
 
 - [Argent X - the first StarkNet wallet](https://github.com/argentlabs/argent-x)
 - [React + Starknet.js boilerplate](https://github.com/fracek/starknet-react-example)
+- [AMM Demo](https://www.starknetswap.com/)
 
 ## ✏️ Contributing
 
@@ -67,7 +107,7 @@ If you consider to contribute to this project please read [CONTRIBUTING.md](http
 
 ## ❤️ Special Thanks
 
-Special thanks to all the [contributors](https://github.com/seanjameshan/starknet.js/graphs/contributors), and especially Janek ([@janek26](https://github.com/janek26)) from [Argent](https://github.com/argentlabs) for driving the development of Starknet.js.
+Special thanks to all the [contributors](https://github.com/seanjameshan/starknet.js/graphs/contributors), especially to Janek ([@janek26](https://github.com/janek26)) from [Argent](https://github.com/argentlabs) for driving the development of Starknet.js.
 
 This library would not be possible without these rockstars.
 

package/__tests__/provider.test.ts

@@ -49,17 +49,17 @@ describe('defaultProvider', () => {
         )
       ).resolves.not.toThrow();
     });
-    test('getTransactionStatus()', () => {
+    test('getTransactionStatus()', async () => {
       return expect(
         defaultProvider.getTransactionStatus(
-          '0x774f7856b1ce6d5ce023a18cd5a06ab67e3a6d81c7bfcd01f99f32243c2d2ef'
+          '0x72add9621ecdcb07405a4f943fe410bf57003ca250400f01ce70f8a6fc72147'
         )
       ).resolves.not.toThrow();
     });
     test('getTransaction()', async () => {
       return expect(
         defaultProvider.getTransaction(
-          '0x774f7856b1ce6d5ce023a18cd5a06ab67e3a6d81c7bfcd01f99f32243c2d2ef'
+          '0x72add9621ecdcb07405a4f943fe410bf57003ca250400f01ce70f8a6fc72147'
         )
       ).resolves.not.toThrow();
     });

package/__tests__/utils/ellipticalCurve.test.ts

@@ -1,4 +1,4 @@
-import { getKeyPair, getStarkKey, sign, verify, ec } from '../../src/utils/ellipticCurve';
+import { ec, getKeyPair, getStarkKey, sign, verify } from '../../src/utils/ellipticCurve';
 import { removeHexPrefix } from '../../src/utils/encode';
 import { hashCalldata, hashMessage, pedersen } from '../../src/utils/hash';
 import { toBN, toHex } from '../../src/utils/number';

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/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/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

@@ -1,16 +1,18 @@
 import { AddTransactionResponse, CallContractResponse, CallContractTransaction, CompiledContract, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, Transaction } from '../types';
 import { BigNumberish } from '../utils/number';
 import { ProviderInterface } from './interface';
-declare type NetworkName = 'alpha';
-interface ProviderOptions {
-    network?: NetworkName;
-}
+declare type NetworkName = 'mainnet-alpha' | 'georli-alpha';
+declare type ProviderOptions = {
+    network: NetworkName;
+} | {
+    baseUrl: string;
+};
 export declare class Provider implements ProviderInterface {
     baseUrl: string;
     feederGatewayUrl: string;
     gatewayUrl: string;
     constructor(optionsOrProvider?: ProviderOptions | Provider);
-    protected static getNetworkFromName(name: NetworkName): string;
+    protected static getNetworkFromName(name: NetworkName): "https://alpha-mainnet.starknet.io" | "https://alpha4.starknet.io";
     /**
      * Gets the smart contract address on the goerli testnet.
      *

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");
@@ -60,22 +61,26 @@ function wait(delay) {
 }
 var Provider = /** @class */ (function () {
     function Provider(optionsOrProvider) {
+        if (optionsOrProvider === void 0) { optionsOrProvider = { network: 'georli-alpha' }; }
         if (optionsOrProvider instanceof Provider) {
             this.baseUrl = optionsOrProvider.baseUrl;
             this.feederGatewayUrl = optionsOrProvider.feederGatewayUrl;
             this.gatewayUrl = optionsOrProvider.gatewayUrl;
         }
         else {
-            var _a = (optionsOrProvider || {}).network, network = _a === void 0 ? 'alpha' : _a;
-            var baseUrl = Provider.getNetworkFromName(network);
+            var baseUrl = 'baseUrl' in optionsOrProvider
+                ? 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 'alpha':
+            case 'mainnet-alpha':
+                return 'https://alpha-mainnet.starknet.io';
+            case 'georli-alpha':
             default:
                 return 'https://alpha4.starknet.io';
         }
@@ -91,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];
@@ -113,7 +118,7 @@ var Provider = /** @class */ (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: [] }, invokeTx))];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -134,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];
@@ -156,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];
@@ -180,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];
@@ -203,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];
@@ -226,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];
@@ -250,7 +255,7 @@ var Provider = /** @class */ (function () {
                     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' } })];
+                        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' } })];
                     case 1:
                         data = (_a.sent()).data;
                         return [2 /*return*/, data];
@@ -296,14 +301,13 @@ var Provider = /** @class */ (function () {
         });
     };
     Provider.prototype.waitForTx = function (txHash, retryInterval) {
-        if (retryInterval === void 0) { retryInterval = 5000; }
+        if (retryInterval === void 0) { retryInterval = 8000; }
         return __awaiter(this, void 0, void 0, function () {
-            var onchain, firstRun, res;
+            var onchain, res;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         onchain = false;
-                        firstRun = true;
                         _a.label = 1;
                     case 1:
                         if (!!onchain) return [3 /*break*/, 4];
@@ -315,16 +319,17 @@ var Provider = /** @class */ (function () {
                         return [4 /*yield*/, this.getTransactionStatus(txHash)];
                     case 3:
                         res = _a.sent();
-                        if (res.tx_status === 'ACCEPTED_ONCHAIN' || res.tx_status === 'PENDING') {
+                        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.
+                        ) {
                             onchain = true;
                         }
                         else if (res.tx_status === 'REJECTED') {
                             throw Error('REJECTED');
                         }
-                        else if (res.tx_status === 'NOT_RECEIVED' && !firstRun) {
+                        else if (res.tx_status === 'NOT_RECEIVED') {
                             throw Error('NOT_RECEIVED');
                         }
-                        firstRun = false;
                         return [3 /*break*/, 1];
                     case 4: return [2 /*return*/];
                 }

package/dist/types.d.ts

@@ -61,14 +61,14 @@ export declare type CallContractResponse = {
 export declare type GetBlockResponse = {
     sequence_number: number;
     state_root: string;
-    block_id: number;
+    block_hash: string;
     transactions: {
         [txHash: string]: Transaction;
     };
     timestamp: number;
     transaction_receipts: {
         [txHash: string]: {
-            block_id: number;
+            block_hash: string;
             transaction_hash: string;
             l2_to_l1_messages: {
                 to_address: string;
@@ -80,7 +80,7 @@ export declare type GetBlockResponse = {
             transaction_index: number;
         };
     };
-    previous_block_id: number;
+    previous_block_hash: string;
     status: Status;
 };
 export declare type GetCodeResponse = {
@@ -89,12 +89,12 @@ export declare type GetCodeResponse = {
 };
 export declare type GetTransactionStatusResponse = {
     tx_status: Status;
-    block_id: number;
+    block_hash: string;
 };
 export declare type GetTransactionResponse = {
     status: Status;
     transaction: Transaction;
-    block_id: number;
+    block_hash: string;
     block_number: number;
     transaction_index: number;
     transaction_hash: 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;

package/dist/utils/shortString.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeShortString = exports.encodeShortString = exports.isShortString = exports.isASCII = void 0;
+var encode_1 = require("./encode");
+function isASCII(str) {
+    // eslint-disable-next-line no-control-regex
+    return /^[\x00-\x7F]*$/.test(str);
+}
+exports.isASCII = isASCII;
+// function to check if string has less or equal 31 characters
+function isShortString(str) {
+    return str.length <= 31;
+}
+exports.isShortString = isShortString;
+function encodeShortString(str) {
+    if (!isASCII(str))
+        throw new Error(str + " is not an ASCII string");
+    if (!isShortString(str))
+        throw new Error(str + " is too long");
+    return (0, encode_1.addHexPrefix)(str.replace(/./g, function (char) { return char.charCodeAt(0).toString(16); }));
+}
+exports.encodeShortString = encodeShortString;
+function decodeShortString(str) {
+    return (0, encode_1.removeHexPrefix)(str).replace(/.{2}/g, function (hex) { return String.fromCharCode(parseInt(hex, 16)); });
+}
+exports.decodeShortString = decodeShortString;

package/dist/utils/stark.d.ts

@@ -19,3 +19,6 @@ export declare function getSelectorFromName(funcName: string): string;
 export declare function randomAddress(): string;
 export declare function makeAddress(input: string): string;
 export declare function formatSignature(sig?: [BigNumberish, BigNumberish]): [string, string] | [];
+export declare function compileStructToCalldata<S extends {
+    [k: string]: string;
+}>(struct: S): string[];

package/dist/utils/stark.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatSignature = exports.makeAddress = exports.randomAddress = exports.getSelectorFromName = exports.compressProgram = void 0;
+exports.compileStructToCalldata = exports.formatSignature = exports.makeAddress = exports.randomAddress = exports.getSelectorFromName = exports.compressProgram = void 0;
 var pako_1 = require("pako");
 var ellipticCurve_1 = require("./ellipticCurve");
 var encode_1 = require("./encode");
@@ -52,3 +52,7 @@ function formatSignature(sig) {
     }
 }
 exports.formatSignature = formatSignature;
+function compileStructToCalldata(struct) {
+    return Object.values(struct);
+}
+exports.compileStructToCalldata = compileStructToCalldata;

package/dist/utils/uint256.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="bn.js" />
+import { BigNumberish } from './number';
+export interface Uint256 {
+    low: BigNumberish;
+    high: BigNumberish;
+}
+export declare function uint256ToBN(uint256: Uint256): import("bn.js");
+export declare const UINT_128_MAX: import("bn.js");
+export declare const UINT_256_MAX: import("bn.js");
+export declare function isUint256(bn: BigNumberish): boolean;
+export declare function bnToUint256(bignumber: BigNumberish): Uint256;

package/dist/utils/uint256.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bnToUint256 = exports.isUint256 = exports.UINT_256_MAX = exports.UINT_128_MAX = exports.uint256ToBN = void 0;
+var encode_1 = require("./encode");
+var number_1 = require("./number");
+// function to convert Uint256 to BN
+function uint256ToBN(uint256) {
+    return (0, number_1.toBN)(uint256.high).shln(128).add((0, number_1.toBN)(uint256.low));
+}
+exports.uint256ToBN = uint256ToBN;
+exports.UINT_128_MAX = (0, number_1.toBN)(1).shln(128).sub((0, number_1.toBN)(1));
+exports.UINT_256_MAX = (0, number_1.toBN)(1).shln(256).sub((0, number_1.toBN)(1));
+// function to check if BN is smaller or equal 2**256-1
+function isUint256(bn) {
+    return (0, number_1.toBN)(bn).lte(exports.UINT_256_MAX);
+}
+exports.isUint256 = isUint256;
+// function to convert BN to Uint256
+function bnToUint256(bignumber) {
+    var bn = (0, number_1.toBN)(bignumber);
+    if (!isUint256(bn))
+        throw new Error('Number is too large');
+    return {
+        low: (0, encode_1.addHexPrefix)(bn.maskn(128).toString(16)),
+        high: (0, encode_1.addHexPrefix)(bn.shrn(128).toString(16)),
+    };
+}
+exports.bnToUint256 = bnToUint256;

package/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/index.js

@@ -44,7 +44,9 @@ var __importStar =
     return result;
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.ec =
+exports.shortString =
+  exports.uint256 =
+  exports.ec =
   exports.stark =
   exports.number =
   exports.json =
@@ -69,3 +71,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "2.0.2",
+  "version": "2.3.0",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -40,6 +40,7 @@
     "@types/json-bigint": "^1.0.1",
     "@types/minimalistic-assert": "^1.0.1",
     "@types/pako": "^1.0.2",
+    "@types/url-join": "^4.0.1",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
     "eslint": "^7.32.0",
@@ -65,7 +66,8 @@
     "hash.js": "^1.1.7",
     "json-bigint": "^1.0.0",
     "minimalistic-assert": "^1.0.1",
-    "pako": "^2.0.4"
+    "pako": "^2.0.4",
+    "url-join": "^4.0.1"
   },
   "lint-staged": {
     "*.ts": "eslint --cache --fix",