starknet 2.0.1 → 2.0.2

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [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

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

package/package.json

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

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

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 = {