starknet 3.15.4 → 3.15.5

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [3.15.5](https://github.com/0xs34n/starknet.js/compare/v3.15.4...v3.15.5) (2022-06-27)
+
+### Bug Fixes
+
+- add return statement ([468a0bf](https://github.com/0xs34n/starknet.js/commit/468a0bfbbc1a9c88383ed2ba0f0bc02b0e5e3a9b))
+- don't enforce bigInt ([efef507](https://github.com/0xs34n/starknet.js/commit/efef5071ebceb5247f5f1995d3c1006d422c02ee))
+- **GatewayError:** export from index ([69addd5](https://github.com/0xs34n/starknet.js/commit/69addd5a2eb30816f5e43ffd71e190838ad5a409))
+- **GatewayError:** use ts-custom-error to support "err instanceof GatewayError" ([092abbc](https://github.com/0xs34n/starknet.js/commit/092abbcff5f5270a0be0b79a8e87645637298c56))
+- **test:** error 500 as number instead of bigInt ([b539144](https://github.com/0xs34n/starknet.js/commit/b5391448cf04d93c4d914ad52d850591a423fe42))
+
 ## [3.15.4](https://github.com/0xs34n/starknet.js/compare/v3.15.3...v3.15.4) (2022-06-20)
 
 ### Bug Fixes

package/__tests__/provider.test.ts

@@ -46,8 +46,16 @@ describe('defaultProvider', () => {
     test(`getBlock(blockHash=undefined, blockNumber=${exampleBlockNumber})`, () => {
       return expect(provider.getBlock(exampleBlockNumber)).resolves.not.toThrow();
     });
-    test('getBlock(blockHash=undefined, blockNumber=null)', () => {
-      return expect(provider.getBlock()).resolves.not.toThrow();
+    test('getBlock(blockHash=undefined, blockNumber=null)', async () => {
+      const block = await provider.getBlock();
+
+      expect(block).not.toBeNull();
+
+      const { block_number, timestamp } = block;
+
+      expect(typeof block_number).toEqual('number');
+
+      return expect(typeof timestamp).toEqual('number');
     });
     test('getBlock() -> { blockNumber }', async () => {
       const block = await provider.getBlock();
@@ -124,7 +132,7 @@ describe('defaultProvider', () => {
         await promise;
       } catch (e) {
         expect(e.errorCode).toMatchInlineSnapshot(
-          IS_DEVNET ? `500n` : `"StarknetErrorCode.ENTRY_POINT_NOT_FOUND_IN_CONTRACT"`
+          IS_DEVNET ? `500` : `"StarknetErrorCode.ENTRY_POINT_NOT_FOUND_IN_CONTRACT"`
         );
       }
     });

package/dist/provider/default.js

@@ -211,7 +211,7 @@ var Provider = /** @class */ (function () {
                             throw new utils_1.GatewayError(responseBody.message, errorCode); // Caught locally, and re-thrown for the user
                         }
                         if (endpoint === 'estimate_fee') {
-                            return [2 /*return*/, (0, json_1.parse)(textResponse, function (_, v) {
+                            return [2 /*return*/, (0, json_1.parseAlwaysAsBig)(textResponse, function (_, v) {
                                     if (v && typeof v === 'bigint') {
                                         return (0, number_1.toBN)(v.toString());
                                     }

package/dist/provider/index.d.ts

@@ -1,4 +1,5 @@
 import { Provider } from './default';
 export * from './default';
+export { GatewayError } from './utils';
 export * from './interface';
 export declare const defaultProvider: Provider;

package/dist/provider/index.js

@@ -14,8 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultProvider = void 0;
+exports.defaultProvider = exports.GatewayError = void 0;
 var default_1 = require("./default");
 __exportStar(require("./default"), exports);
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "GatewayError", { enumerable: true, get: function () { return utils_1.GatewayError; } });
 __exportStar(require("./interface"), exports);
 exports.defaultProvider = new default_1.Provider();

package/dist/provider/utils.d.ts

@@ -1,3 +1,4 @@
+import { CustomError } from 'ts-custom-error';
 import type { BlockNumber } from '../types';
 import { BigNumberish } from '../utils/number';
 /**
@@ -39,7 +40,7 @@ export declare function getBlockIdentifier(blockIdentifier: BlockIdentifier): Bl
  * @returns block identifier for API request
  */
 export declare function getFormattedBlockIdentifier(blockIdentifier?: BlockIdentifier): string;
-export declare class GatewayError extends Error {
+export declare class GatewayError extends CustomError {
     errorCode: string;
     constructor(message: string, errorCode: string);
 }

package/dist/provider/utils.js

@@ -16,6 +16,7 @@ var __extends = (this && this.__extends) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GatewayError = exports.getFormattedBlockIdentifier = exports.getBlockIdentifier = exports.txIdentifier = exports.formatHash = void 0;
+var ts_custom_error_1 = require("ts-custom-error");
 var number_1 = require("../utils/number");
 /**
  *
@@ -100,5 +101,5 @@ var GatewayError = /** @class */ (function (_super) {
         return _this;
     }
     return GatewayError;
-}(Error));
+}(ts_custom_error_1.CustomError));
 exports.GatewayError = GatewayError;

package/dist/utils/json.d.ts

@@ -1,8 +1,11 @@
-declare const parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any, stringify: {
+export declare const parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any, stringify: {
+    (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
+    (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
+};
+export declare const parseAlwaysAsBig: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any, stringifyAlwaysAsBig: {
     (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
     (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
 };
-export { parse, stringify };
 declare const _default: {
     parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any;
     stringify: {

package/dist/utils/json.js

@@ -2,15 +2,18 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringify = exports.parse = void 0;
+exports.stringifyAlwaysAsBig = exports.parseAlwaysAsBig = exports.stringify = exports.parse = void 0;
 var json_bigint_1 = __importDefault(require("json-bigint"));
-var _a = (0, json_bigint_1.default)({
-    alwaysParseAsBig: true,
-    useNativeBigInt: true,
-    protoAction: 'preserve',
-    constructorAction: 'preserve',
-}), parse = _a.parse, stringify = _a.stringify;
-exports.parse = parse;
-exports.stringify = stringify;
-exports.default = { parse: parse, stringify: stringify };
+var json = function (alwaysParseAsBig) {
+    return (0, json_bigint_1.default)({
+        alwaysParseAsBig: alwaysParseAsBig,
+        useNativeBigInt: true,
+        protoAction: 'preserve',
+        constructorAction: 'preserve',
+    });
+};
+exports.parse = (_a = json(false), _a.parse), exports.stringify = _a.stringify;
+exports.parseAlwaysAsBig = (_b = json(true), _b.parse), exports.stringifyAlwaysAsBig = _b.stringify;
+exports.default = { parse: exports.parse, stringify: exports.stringify };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "3.15.4",
+  "version": "3.15.5",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -75,6 +75,7 @@
     "json-bigint": "^1.0.0",
     "minimalistic-assert": "^1.0.1",
     "pako": "^2.0.4",
+    "ts-custom-error": "^3.2.0",
     "url-join": "^4.0.1"
   },
   "lint-staged": {

package/provider/default.js

@@ -344,7 +344,7 @@ var Provider = /** @class */ (function () {
             if (endpoint === 'estimate_fee') {
               return [
                 2 /*return*/,
-                (0, json_1.parse)(textResponse, function (_, v) {
+                (0, json_1.parseAlwaysAsBig)(textResponse, function (_, v) {
                   if (v && typeof v === 'bigint') {
                     return (0, number_1.toBN)(v.toString());
                   }

package/provider/index.d.ts

@@ -1,4 +1,5 @@
 import { Provider } from './default';
 export * from './default';
+export { GatewayError } from './utils';
 export * from './interface';
 export declare const defaultProvider: Provider;

package/provider/index.js

@@ -27,8 +27,15 @@ var __exportStar =
         __createBinding(exports, m, p);
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.defaultProvider = void 0;
+exports.defaultProvider = exports.GatewayError = void 0;
 var default_1 = require('./default');
 __exportStar(require('./default'), exports);
+var utils_1 = require('./utils');
+Object.defineProperty(exports, 'GatewayError', {
+  enumerable: true,
+  get: function () {
+    return utils_1.GatewayError;
+  },
+});
 __exportStar(require('./interface'), exports);
 exports.defaultProvider = new default_1.Provider();

package/provider/utils.d.ts

@@ -1,3 +1,5 @@
+import { CustomError } from 'ts-custom-error';
+
 import type { BlockNumber } from '../types';
 import { BigNumberish } from '../utils/number';
 /**
@@ -41,7 +43,7 @@ export declare function getBlockIdentifier(blockIdentifier: BlockIdentifier): Bl
  * @returns block identifier for API request
  */
 export declare function getFormattedBlockIdentifier(blockIdentifier?: BlockIdentifier): string;
-export declare class GatewayError extends Error {
+export declare class GatewayError extends CustomError {
   errorCode: string;
   constructor(message: string, errorCode: string);
 }

package/provider/utils.js

@@ -31,6 +31,7 @@ exports.GatewayError =
   exports.txIdentifier =
   exports.formatHash =
     void 0;
+var ts_custom_error_1 = require('ts-custom-error');
 var number_1 = require('../utils/number');
 /**
  *
@@ -116,5 +117,5 @@ var GatewayError = /** @class */ (function (_super) {
     return _this;
   }
   return GatewayError;
-})(Error);
+})(ts_custom_error_1.CustomError);
 exports.GatewayError = GatewayError;

package/src/provider/default.ts

@@ -20,7 +20,7 @@ import {
   TransactionReceiptResponse,
 } from '../types';
 import { getSelectorFromName } from '../utils/hash';
-import { parse, stringify } from '../utils/json';
+import { parse, parseAlwaysAsBig, stringify } from '../utils/json';
 import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN, toHex } from '../utils/number';
 import { compressProgram, randomAddress } from '../utils/stark';
 import { ProviderInterface } from './interface';
@@ -169,7 +169,7 @@ export class Provider implements ProviderInterface {
       }
 
       if (endpoint === 'estimate_fee') {
-        return parse(textResponse, (_, v) => {
+        return parseAlwaysAsBig(textResponse, (_, v) => {
           if (v && typeof v === 'bigint') {
             return toBN(v.toString());
           }

package/src/provider/index.ts

@@ -1,6 +1,7 @@
 import { Provider } from './default';
 
 export * from './default';
+export { GatewayError } from './utils';
 export * from './interface';
 
 export const defaultProvider = new Provider();

package/src/provider/utils.ts

@@ -1,3 +1,5 @@
+import { CustomError } from 'ts-custom-error';
+
 import type { BlockNumber } from '../types';
 import { BigNumberish, toBN, toHex } from '../utils/number';
 
@@ -83,7 +85,7 @@ export function getFormattedBlockIdentifier(blockIdentifier: BlockIdentifier = n
   return `blockHash=${toHex(toBN(blockIdentifierObject.data))}`;
 }
 
-export class GatewayError extends Error {
+export class GatewayError extends CustomError {
   constructor(message: string, public errorCode: string) {
     super(message);
   }

package/src/utils/json.ts

@@ -1,11 +1,15 @@
 import Json from 'json-bigint';
 
-const { parse, stringify } = Json({
-  alwaysParseAsBig: true,
-  useNativeBigInt: true,
-  protoAction: 'preserve',
-  constructorAction: 'preserve',
-});
+const json = (alwaysParseAsBig: boolean) => {
+  return Json({
+    alwaysParseAsBig,
+    useNativeBigInt: true,
+    protoAction: 'preserve',
+    constructorAction: 'preserve',
+  });
+};
+
+export const { parse, stringify } = json(false);
+export const { parse: parseAlwaysAsBig, stringify: stringifyAlwaysAsBig } = json(true);
 
-export { parse, stringify };
 export default { parse, stringify };

package/utils/json.d.ts

@@ -1,4 +1,4 @@
-declare const parse: (
+export declare const parse: (
     text: string,
     reviver?: ((this: any, key: string, value: any) => any) | undefined
   ) => any,
@@ -14,7 +14,22 @@ declare const parse: (
       space?: string | number | undefined
     ): string;
   };
-export { parse, stringify };
+export declare const parseAlwaysAsBig: (
+    text: string,
+    reviver?: ((this: any, key: string, value: any) => any) | undefined
+  ) => any,
+  stringifyAlwaysAsBig: {
+    (
+      value: any,
+      replacer?: ((this: any, key: string, value: any) => any) | undefined,
+      space?: string | number | undefined
+    ): string;
+    (
+      value: any,
+      replacer?: (string | number)[] | null | undefined,
+      space?: string | number | undefined
+    ): string;
+  };
 declare const _default: {
   parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any;
   stringify: {

package/utils/json.js

@@ -4,17 +4,23 @@ var __importDefault =
   function (mod) {
     return mod && mod.__esModule ? mod : { default: mod };
   };
+var _a, _b;
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.stringify = exports.parse = void 0;
+exports.stringifyAlwaysAsBig =
+  exports.parseAlwaysAsBig =
+  exports.stringify =
+  exports.parse =
+    void 0;
 var json_bigint_1 = __importDefault(require('json-bigint'));
-var _a = (0, json_bigint_1.default)({
-    alwaysParseAsBig: true,
+var json = function (alwaysParseAsBig) {
+  return (0, json_bigint_1.default)({
+    alwaysParseAsBig: alwaysParseAsBig,
     useNativeBigInt: true,
     protoAction: 'preserve',
     constructorAction: 'preserve',
-  }),
-  parse = _a.parse,
-  stringify = _a.stringify;
-exports.parse = parse;
-exports.stringify = stringify;
-exports.default = { parse: parse, stringify: stringify };
+  });
+};
+(exports.parse = ((_a = json(false)), _a.parse)), (exports.stringify = _a.stringify);
+(exports.parseAlwaysAsBig = ((_b = json(true)), _b.parse)),
+  (exports.stringifyAlwaysAsBig = _b.stringify);
+exports.default = { parse: exports.parse, stringify: exports.stringify };

package/www/guides/account.md

@@ -31,7 +31,7 @@ You can also get a key pair from a private key using `getKeyPair(pk: BigNumberis
 
 ```javascript
 const starkKeyPair = ec.genKeyPair();
-const starkKeyPub = ec.getStarkKey(starkKeyPair);;
+const starkKeyPub = ec.getStarkKey(starkKeyPair);
 ```
 
 ## Deploy Account Contract