starknet 2.0.0 → 2.1.1

package/CHANGELOG.md

@@ -1,3 +1,34 @@
+## [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))
+
+# [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
+
+- 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))
+
+## [2.0.1](https://github.com/seanjameshan/starknet.js/compare/v2.0.0...v2.0.1) (2021-11-18)
+
+### Bug Fixes
+
+- msgHash length fix in signature verify function ([589b126](https://github.com/seanjameshan/starknet.js/commit/589b126b2b87bf7d0b2730f53a40ee2d9ef9aca0))
+
 # [2.0.0](https://github.com/seanjameshan/starknet.js/compare/v1.7.0...v2.0.0) (2021-11-18)
 
 ### Features
@@ -23,7 +54,13 @@
 ### Features
 
 - add invokeFunction ([7e04b5e](https://github.com/seanjameshan/starknet.js/commit/7e04b5ec383fa6d466e9e06d9fa02e2d0c36b020))
-- add signer and provider v1 ([909fdc0](https://github.com/seanjameshan/starknet.js/commit/909fdc0b2b211755b9124b62f97476d89b655de1))
+- # add signer and provider v1 ([909fdc0](https://github.com/seanjameshan/starknet.js/commit/909fdc0b2b211755b9124b62f97476d89b655de1))
+
+## [1.5.5](https://github.com/seanjameshan/starknet.js/compare/v1.5.4...v1.5.5) (2021-11-13)
+
+### Bug Fixes
+
+- msgHash length fix in signature verify function ([589b126](https://github.com/seanjameshan/starknet.js/commit/589b126b2b87bf7d0b2730f53a40ee2d9ef9aca0))
 
 ## [1.5.4](https://github.com/seanjameshan/starknet.js/compare/v1.5.3...v1.5.4) (2021-11-05)
 

package/README.md

@@ -44,23 +44,74 @@ $ 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
+**/
+
+/** 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));
 
-defaultProvider.getContractAddresses().then((data) => {
-  console.log(data);
+/** 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)
 
-## Contributing
+## 🚀 Powered by Starknet.js
+
+- [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
 
 If you consider to contribute to this project please read [CONTRIBUTING.md](https://github.com/seanjameshan/starknet.js/blob/main/CONTRIBUTING.md) first.
 
-## License
+## ❤️ Special Thanks
+
+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.
+
+## 📜 License
 
 Copyright (c) 2021 Sean James Han
 

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 } 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';
@@ -48,3 +48,15 @@ test('hashMessage()', () => {
     toBN('3439514492576562277095748549117516048613512930236865921315982886313695689433').toString()
   );
 });
+
+test('verify signed message()', () => {
+  const pk = '0x019800ea6a9a73f94aee6a3d2edf018fc770443e90c7ba121e8303ec6b349279';
+  const account = '0x33f45f07e1bd1a51b45fc24ec8c8c9908db9e42191be9e169bfcac0c0d99745';
+  const price = '1';
+  const hashMsg = pedersen([account, price]);
+  const keyPair = getKeyPair(pk);
+  const signature = sign(keyPair, removeHexPrefix(hashMsg));
+  const pubKey = keyPair.getPublic('hex');
+  const pubKeyPair = ec.keyFromPublic(pubKey, 'hex');
+  expect(verify(pubKeyPair, removeHexPrefix(hashMsg), signature)).toBe(true);
+});

package/constants.d.ts

@@ -1,9 +1,9 @@
-/// <reference types="bn.js" />
+import BN from 'bn.js';
 export { IS_BROWSER } from './utils/encode';
-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');
+export declare const ZERO: BN;
+export declare const ONE: BN;
+export declare const TWO: BN;
+export declare const MASK_250: BN;
 /**
  * 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

@@ -1,5 +1,5 @@
 import { Provider } from './provider';
-import { Abi } from './types';
+import { Abi, StructAbi } from './types';
 import { BigNumberish } from './utils/number';
 export declare type Args = {
   [inputName: string]: string | string[];
@@ -9,6 +9,9 @@ export declare function compileCalldata(args: Args): Calldata;
 export declare class Contract {
   connectedTo: string | null;
   abi: Abi[];
+  structs: {
+    [name: string]: StructAbi;
+  };
   provider: Provider;
   /**
    * Contract class to handle contract methods
@@ -19,6 +22,7 @@ export declare class Contract {
   constructor(abi: Abi[], address?: string | null, provider?: Provider);
   connect(address: string): Contract;
   private validateMethodAndArgs;
+  private parseResponseField;
   private parseResponse;
   invoke(
     method: string,

package/contract.js

@@ -238,6 +238,14 @@ var Contract = /** @class */ (function () {
     this.connectedTo = address;
     this.provider = provider;
     this.abi = abi;
+    this.structs = abi
+      .filter(function (abiEntry) {
+        return abiEntry.type === 'struct';
+      })
+      .reduce(function (acc, abiEntry) {
+        var _a;
+        return __assign(__assign({}, acc), ((_a = {}), (_a[abiEntry.name] = abiEntry), _a));
+      }, {});
   }
   Contract.prototype.connect = function (address) {
     this.connectedTo = address;
@@ -250,9 +258,9 @@ var Contract = /** @class */ (function () {
     // ensure provided method exists
     var invokeableFunctionNames = this.abi
       .filter(function (abi) {
+        if (abi.type !== 'function') return false;
         var isView = abi.stateMutability === 'view';
-        var isFunction = abi.type === 'function';
-        return isFunction && type === 'INVOKE' ? !isView : isView;
+        return type === 'INVOKE' ? !isView : isView;
       })
       .map(function (abi) {
         return abi.name;
@@ -263,7 +271,7 @@ var Contract = /** @class */ (function () {
     );
     // ensure args match abi type
     var methodAbi = this.abi.find(function (abi) {
-      return abi.name === method;
+      return abi.name === method && abi.type === 'function';
     });
     methodAbi.inputs.forEach(function (input) {
       if (args[input.name] !== undefined) {
@@ -291,14 +299,31 @@ var Contract = /** @class */ (function () {
       }
     });
   };
+  Contract.prototype.parseResponseField = function (element, responseIterator) {
+    var _this = this;
+    var entries = [];
+    if (['felt', 'felt*'].includes(element.type)) {
+      return responseIterator.next().value;
+    }
+    if (element.type in this.structs) {
+      entries = this.structs[element.type].members;
+    } else if ('outputs' in element) {
+      entries = element.outputs;
+    }
+    return entries.reduce(function (acc, member) {
+      var _a;
+      return __assign(
+        __assign({}, acc),
+        ((_a = {}), (_a[member.name] = _this.parseResponseField(member, responseIterator)), _a)
+      );
+    }, {});
+  };
   Contract.prototype.parseResponse = function (method, response) {
     var methodAbi = this.abi.find(function (abi) {
       return abi.name === method;
     });
-    return methodAbi.outputs.reduce(function (acc, output, i) {
-      var _a;
-      return __assign(__assign({}, acc), ((_a = {}), (_a[output.name] = response[i]), _a));
-    }, {});
+    var responseIterator = response.flat()[Symbol.iterator]();
+    return this.parseResponseField(methodAbi, responseIterator);
   };
   Contract.prototype.invoke = function (method, args, signature) {
     if (args === void 0) {

package/dist/constants.d.ts

@@ -1,9 +1,9 @@
-/// <reference types="bn.js" />
+import BN from 'bn.js';
 export { IS_BROWSER } from './utils/encode';
-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");
+export declare const ZERO: BN;
+export declare const ONE: BN;
+export declare const TWO: BN;
+export declare const MASK_250: BN;
 /**
  * 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

@@ -1,5 +1,5 @@
 import { Provider } from './provider';
-import { Abi } from './types';
+import { Abi, StructAbi } from './types';
 import { BigNumberish } from './utils/number';
 export declare type Args = {
     [inputName: string]: string | string[];
@@ -9,6 +9,9 @@ export declare function compileCalldata(args: Args): Calldata;
 export declare class Contract {
     connectedTo: string | null;
     abi: Abi[];
+    structs: {
+        [name: string]: StructAbi;
+    };
     provider: Provider;
     /**
      * Contract class to handle contract methods
@@ -19,6 +22,7 @@ export declare class Contract {
     constructor(abi: Abi[], address?: string | null, provider?: Provider);
     connect(address: string): Contract;
     private validateMethodAndArgs;
+    private parseResponseField;
     private parseResponse;
     invoke(method: string, args?: Args, signature?: [BigNumberish, BigNumberish]): Promise<import("./types").AddTransactionResponse>;
     call(method: string, args?: Args): Promise<Args>;

package/dist/contract.js

@@ -119,6 +119,12 @@ var Contract = /** @class */ (function () {
         this.connectedTo = address;
         this.provider = provider;
         this.abi = abi;
+        this.structs = abi
+            .filter(function (abiEntry) { return abiEntry.type === 'struct'; })
+            .reduce(function (acc, abiEntry) {
+            var _a;
+            return (__assign(__assign({}, acc), (_a = {}, _a[abiEntry.name] = abiEntry, _a)));
+        }, {});
     }
     Contract.prototype.connect = function (address) {
         this.connectedTo = address;
@@ -129,14 +135,15 @@ var Contract = /** @class */ (function () {
         // ensure provided method exists
         var invokeableFunctionNames = this.abi
             .filter(function (abi) {
+            if (abi.type !== 'function')
+                return false;
             var isView = abi.stateMutability === 'view';
-            var isFunction = abi.type === 'function';
-            return isFunction && type === 'INVOKE' ? !isView : isView;
+            return type === 'INVOKE' ? !isView : isView;
         })
             .map(function (abi) { return abi.name; });
         (0, minimalistic_assert_1.default)(invokeableFunctionNames.includes(method), (type === 'INVOKE' ? 'invokeable' : 'viewable') + " method not found in abi");
         // ensure args match abi type
-        var methodAbi = this.abi.find(function (abi) { return abi.name === method; });
+        var methodAbi = this.abi.find(function (abi) { return abi.name === method && abi.type === 'function'; });
         methodAbi.inputs.forEach(function (input) {
             if (args[input.name] !== undefined) {
                 if (input.type === 'felt') {
@@ -153,13 +160,28 @@ var Contract = /** @class */ (function () {
             }
         });
     };
-    Contract.prototype.parseResponse = function (method, response) {
-        var methodAbi = this.abi.find(function (abi) { return abi.name === method; });
-        return methodAbi.outputs.reduce(function (acc, output, i) {
+    Contract.prototype.parseResponseField = function (element, responseIterator) {
+        var _this = this;
+        var entries = [];
+        if (['felt', 'felt*'].includes(element.type)) {
+            return responseIterator.next().value;
+        }
+        if (element.type in this.structs) {
+            entries = this.structs[element.type].members;
+        }
+        else if ('outputs' in element) {
+            entries = element.outputs;
+        }
+        return entries.reduce(function (acc, member) {
             var _a;
-            return __assign(__assign({}, acc), (_a = {}, _a[output.name] = response[i], _a));
+            return (__assign(__assign({}, acc), (_a = {}, _a[member.name] = _this.parseResponseField(member, responseIterator), _a)));
         }, {});
     };
+    Contract.prototype.parseResponse = function (method, response) {
+        var methodAbi = this.abi.find(function (abi) { return abi.name === method; });
+        var responseIterator = response.flat()[Symbol.iterator]();
+        return this.parseResponseField(methodAbi, responseIterator);
+    };
     Contract.prototype.invoke = function (method, args, signature) {
         if (args === void 0) { args = {}; }
         // ensure contract is connected

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): "http://alpha-mainnet.starknet.io/" | "https://alpha4.starknet.io";
     /**
      * Gets the smart contract address on the goerli testnet.
      *

package/dist/provider/default.js

@@ -60,14 +60,16 @@ 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";
@@ -75,7 +77,9 @@ var Provider = /** @class */ (function () {
     }
     Provider.getNetworkFromName = function (name) {
         switch (name) {
-            case 'alpha':
+            case 'mainnet-alpha':
+                return 'http://alpha-mainnet.starknet.io/';
+            case 'georli-alpha':
             default:
                 return 'https://alpha4.starknet.io';
         }
@@ -296,14 +300,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 +318,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

@@ -11,19 +11,26 @@ export declare type TxStatus = 'TRANSACTION_RECEIVED';
 export declare type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
 export declare type EntryPointType = 'EXTERNAL';
 export declare type CompressedProgram = string;
-export declare type Abi = {
-    inputs: {
-        name: string;
-        type: 'felt' | 'felt*';
-    }[];
+export declare type AbiEntry = {
     name: string;
-    outputs: {
-        name: string;
-        type: 'felt' | 'felt*';
-    }[];
+    type: 'felt' | 'felt*' | string;
+};
+export declare type FunctionAbi = {
+    inputs: AbiEntry[];
+    name: string;
+    outputs: AbiEntry[];
     stateMutability?: 'view';
     type: 'function';
 };
+export declare type StructAbi = {
+    members: (AbiEntry & {
+        offset: number;
+    })[];
+    name: string;
+    size: number;
+    type: 'struct';
+};
+export declare type Abi = FunctionAbi | StructAbi;
 export declare type EntryPointsByType = object;
 export declare type Program = object;
 export declare type CompiledContract = {
@@ -54,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;
@@ -73,7 +80,7 @@ export declare type GetBlockResponse = {
             transaction_index: number;
         };
     };
-    previous_block_id: number;
+    previous_block_hash: string;
     status: Status;
 };
 export declare type GetCodeResponse = {
@@ -82,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/ellipticCurve.js

@@ -84,6 +84,6 @@ function verify(keyPair, msgHash, sig) {
     (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(msgHash, sig);
+    return keyPair.verify(fixMessage(msgHash), sig);
 }
 exports.verify = verify;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/provider/default.d.ts

@@ -12,16 +12,22 @@ import {
 } 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
+  ): 'http://alpha-mainnet.starknet.io/' | 'https://alpha4.starknet.io';
   /**
    * Gets the smart contract address on the goerli testnet.
    *

package/provider/default.js

@@ -162,14 +162,18 @@ 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';
@@ -177,7 +181,9 @@ var Provider = /** @class */ (function () {
   }
   Provider.getNetworkFromName = function (name) {
     switch (name) {
-      case 'alpha':
+      case 'mainnet-alpha':
+        return 'http://alpha-mainnet.starknet.io/';
+      case 'georli-alpha':
       default:
         return 'https://alpha4.starknet.io';
     }
@@ -484,15 +490,14 @@ var Provider = /** @class */ (function () {
   };
   Provider.prototype.waitForTx = function (txHash, retryInterval) {
     if (retryInterval === void 0) {
-      retryInterval = 5000;
+      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];
@@ -504,14 +509,16 @@ 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/src/constants.ts

@@ -1,11 +1,13 @@
+import BN from 'bn.js';
+
 import { toBN } from './utils/number';
 
 export { IS_BROWSER } from './utils/encode';
 
-export const ZERO = toBN(0);
-export const ONE = toBN(1);
-export const TWO = toBN(2);
-export const MASK_250 = TWO.pow(toBN(250)).sub(ONE); // 2 ** 250 - 1
+export const ZERO: BN = toBN(0);
+export const ONE: BN = toBN(1);
+export const TWO: BN = toBN(2);
+export const MASK_250: BN = TWO.pow(toBN(250)).sub(ONE); // 2 ** 250 - 1
 
 /**
  * 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

package/src/contract.ts

@@ -2,7 +2,7 @@ import BN from 'bn.js';
 import assert from 'minimalistic-assert';
 
 import { Provider, defaultProvider } from './provider';
-import { Abi } from './types';
+import { Abi, AbiEntry, FunctionAbi, StructAbi } from './types';
 import { BigNumberish, toBN } from './utils/number';
 import { getSelectorFromName } from './utils/stark';
 
@@ -39,6 +39,8 @@ export class Contract {
 
   abi: Abi[];
 
+  structs: { [name: string]: StructAbi };
+
   provider: Provider;
 
   /**
@@ -51,6 +53,15 @@ export class Contract {
     this.connectedTo = address;
     this.provider = provider;
     this.abi = abi;
+    this.structs = abi
+      .filter((abiEntry) => abiEntry.type === 'struct')
+      .reduce(
+        (acc, abiEntry) => ({
+          ...acc,
+          [abiEntry.name]: abiEntry,
+        }),
+        {}
+      );
   }
 
   public connect(address: string): Contract {
@@ -62,9 +73,9 @@ export class Contract {
     // ensure provided method exists
     const invokeableFunctionNames = this.abi
       .filter((abi) => {
+        if (abi.type !== 'function') return false;
         const isView = abi.stateMutability === 'view';
-        const isFunction = abi.type === 'function';
-        return isFunction && type === 'INVOKE' ? !isView : isView;
+        return type === 'INVOKE' ? !isView : isView;
       })
       .map((abi) => abi.name);
     assert(
@@ -73,7 +84,9 @@ export class Contract {
     );
 
     // ensure args match abi type
-    const methodAbi = this.abi.find((abi) => abi.name === method)!;
+    const methodAbi = this.abi.find(
+      (abi) => abi.name === method && abi.type === 'function'
+    ) as FunctionAbi;
     methodAbi.inputs.forEach((input) => {
       if (args[input.name] !== undefined) {
         if (input.type === 'felt') {
@@ -102,14 +115,32 @@ export class Contract {
     });
   }
 
-  private parseResponse(method: string, response: (string | string[])[]): Args {
-    const methodAbi = this.abi.find((abi) => abi.name === method)!;
-    return methodAbi.outputs.reduce((acc, output, i) => {
-      return {
+  private parseResponseField(
+    element: AbiEntry | FunctionAbi,
+    responseIterator: Iterator<string>
+  ): Args {
+    let entries: AbiEntry[] = [];
+    if (['felt', 'felt*'].includes(element.type)) {
+      return responseIterator.next().value;
+    }
+    if (element.type in this.structs) {
+      entries = this.structs[element.type].members;
+    } else if ('outputs' in element) {
+      entries = element.outputs;
+    }
+    return entries.reduce(
+      (acc, member) => ({
         ...acc,
-        [output.name]: response[i],
-      };
-    }, {} as Args);
+        [member.name]: this.parseResponseField(member, responseIterator),
+      }),
+      {}
+    );
+  }
+
+  private parseResponse(method: string, response: string[]): Args {
+    const methodAbi = this.abi.find((abi) => abi.name === method) as FunctionAbi;
+    const responseIterator = response.flat()[Symbol.iterator]();
+    return this.parseResponseField(methodAbi, responseIterator);
   }
 
   public invoke(method: string, args: Args = {}, signature?: [BigNumberish, BigNumberish]) {

package/src/provider/default.ts

@@ -17,11 +17,15 @@ import { BigNumberish, toBN, toHex } from '../utils/number';
 import { compressProgram, formatSignature, randomAddress } from '../utils/stark';
 import { ProviderInterface } from './interface';
 
-type NetworkName = 'alpha';
+type NetworkName = 'mainnet-alpha' | 'georli-alpha';
 
-interface ProviderOptions {
-  network?: NetworkName;
-}
+type ProviderOptions =
+  | {
+      network: NetworkName;
+    }
+  | {
+      baseUrl: string;
+    };
 
 function wait(delay: number) {
   return new Promise((res) => setTimeout(res, delay));
@@ -34,14 +38,16 @@ export class Provider implements ProviderInterface {
 
   public gatewayUrl: string;
 
-  constructor(optionsOrProvider?: ProviderOptions | Provider) {
+  constructor(optionsOrProvider: ProviderOptions | Provider = { network: 'georli-alpha' }) {
     if (optionsOrProvider instanceof Provider) {
       this.baseUrl = optionsOrProvider.baseUrl;
       this.feederGatewayUrl = optionsOrProvider.feederGatewayUrl;
       this.gatewayUrl = optionsOrProvider.gatewayUrl;
     } else {
-      const { network = 'alpha' } = optionsOrProvider || {};
-      const baseUrl = Provider.getNetworkFromName(network);
+      const baseUrl =
+        'baseUrl' in optionsOrProvider
+          ? optionsOrProvider.baseUrl
+          : Provider.getNetworkFromName(optionsOrProvider.network);
       this.baseUrl = baseUrl;
       this.feederGatewayUrl = `${baseUrl}/feeder_gateway`;
       this.gatewayUrl = `${baseUrl}/gateway`;
@@ -50,7 +56,9 @@ export class Provider implements ProviderInterface {
 
   protected static getNetworkFromName(name: NetworkName) {
     switch (name) {
-      case 'alpha':
+      case 'mainnet-alpha':
+        return 'http://alpha-mainnet.starknet.io/';
+      case 'georli-alpha':
       default:
         return 'https://alpha4.starknet.io';
     }
@@ -257,23 +265,24 @@ export class Provider implements ProviderInterface {
     });
   }
 
-  public async waitForTx(txHash: BigNumberish, retryInterval: number = 5000) {
+  public async waitForTx(txHash: BigNumberish, retryInterval: number = 8000) {
     let onchain = false;
-    let firstRun = true;
     while (!onchain) {
       // eslint-disable-next-line no-await-in-loop
       await wait(retryInterval);
       // eslint-disable-next-line no-await-in-loop
       const res = await this.getTransactionStatus(txHash);
 
-      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;
     }
   }
 }

package/src/types.ts

@@ -16,13 +16,25 @@ export type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
 export type EntryPointType = 'EXTERNAL';
 export type CompressedProgram = string;
 
-export type Abi = {
-  inputs: { name: string; type: 'felt' | 'felt*' }[];
+export type AbiEntry = { name: string; type: 'felt' | 'felt*' | string };
+
+export type FunctionAbi = {
+  inputs: AbiEntry[];
   name: string;
-  outputs: { name: string; type: 'felt' | 'felt*' }[];
+  outputs: AbiEntry[];
   stateMutability?: 'view';
   type: 'function';
 };
+
+export type StructAbi = {
+  members: (AbiEntry & { offset: number })[];
+  name: string;
+  size: number;
+  type: 'struct';
+};
+
+export type Abi = FunctionAbi | StructAbi;
+
 export type EntryPointsByType = object;
 export type Program = object;
 
@@ -61,14 +73,14 @@ export type CallContractResponse = {
 export 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 +92,7 @@ export type GetBlockResponse = {
       transaction_index: number;
     };
   };
-  previous_block_id: number;
+  previous_block_hash: string;
   status: Status;
 };
 
@@ -91,13 +103,13 @@ export type GetCodeResponse = {
 
 export type GetTransactionStatusResponse = {
   tx_status: Status;
-  block_id: number;
+  block_hash: string;
 };
 
 export type GetTransactionResponse = {
   status: Status;
   transaction: Transaction;
-  block_id: number;
+  block_hash: string;
   block_number: number;
   transaction_index: number;
   transaction_hash: string;

package/src/utils/ellipticCurve.ts

@@ -88,5 +88,5 @@ export function verify(keyPair: KeyPair, msgHash: string, sig: Signature): boole
   assertInRange(s, ONE, toBN(addHexPrefix(EC_ORDER)), 's');
   assertInRange(w, ONE, toBN(addHexPrefix(MAX_ECDSA_VAL)), 'w');
 
-  return keyPair.verify(msgHash, sig);
+  return keyPair.verify(fixMessage(msgHash), sig);
 }

package/tsconfig.json

@@ -105,11 +105,12 @@
   "include": ["src/**/*"],
   "exclude": ["node_modules"],
   "typedocOptions": {
-    "entryPoints": ["src/starknet.ts", "src/types.ts"],
+    "entryPoints": "src/index.ts",
+    "entryPointStrategy": "expand",
     "out": "docs",
     "githubPages": false,
     "readme": "./README.md",
     "name": "StarkNet.js Docs",
-    "sort": "source-order"
+    "sort": "required-first"
   }
 }

package/types.d.ts

@@ -17,19 +17,26 @@ export declare type TxStatus = 'TRANSACTION_RECEIVED';
 export declare type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
 export declare type EntryPointType = 'EXTERNAL';
 export declare type CompressedProgram = string;
-export declare type Abi = {
-  inputs: {
-    name: string;
-    type: 'felt' | 'felt*';
-  }[];
+export declare type AbiEntry = {
   name: string;
-  outputs: {
-    name: string;
-    type: 'felt' | 'felt*';
-  }[];
+  type: 'felt' | 'felt*' | string;
+};
+export declare type FunctionAbi = {
+  inputs: AbiEntry[];
+  name: string;
+  outputs: AbiEntry[];
   stateMutability?: 'view';
   type: 'function';
 };
+export declare type StructAbi = {
+  members: (AbiEntry & {
+    offset: number;
+  })[];
+  name: string;
+  size: number;
+  type: 'struct';
+};
+export declare type Abi = FunctionAbi | StructAbi;
 export declare type EntryPointsByType = object;
 export declare type Program = object;
 export declare type CompiledContract = {
@@ -60,14 +67,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;
@@ -79,7 +86,7 @@ export declare type GetBlockResponse = {
       transaction_index: number;
     };
   };
-  previous_block_id: number;
+  previous_block_hash: string;
   status: Status;
 };
 export declare type GetCodeResponse = {
@@ -88,12 +95,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/utils/ellipticCurve.js

@@ -138,6 +138,6 @@ function verify(keyPair, msgHash, sig) {
     (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.MAX_ECDSA_VAL)),
     'w'
   );
-  return keyPair.verify(msgHash, sig);
+  return keyPair.verify(fixMessage(msgHash), sig);
 }
 exports.verify = verify;