starknet 3.12.2 → 3.12.3

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [3.12.3](https://github.com/0xs34n/starknet.js/compare/v3.12.2...v3.12.3) (2022-05-30)
+
+### Bug Fixes
+
+- remove superstruct ([6f13cf0](https://github.com/0xs34n/starknet.js/commit/6f13cf0ec740e715fcbdacf846cd9bcd653c1399))
+
 ## [3.12.2](https://github.com/0xs34n/starknet.js/compare/v3.12.1...v3.12.2) (2022-05-30)
 
 ### Bug Fixes

package/dist/utils/typedData/index.d.ts

@@ -35,24 +35,7 @@ export declare const getTypeHash: (typedData: TypedData, type: string) => string
  * @param {string} type
  * @param {Record<string, any>} data
  */
-export declare const encodeData: <T extends {
-    types: {
-        StarkNetDomain: {
-            type: string;
-            name: string;
-        }[];
-    } & Record<string, {
-        type: string;
-        name: string;
-    }[]>;
-    primaryType: string;
-    domain: {
-        version?: string | undefined;
-        chainId?: string | number | undefined;
-        name?: string | undefined;
-    };
-    message: Record<string, unknown>;
-}>(typedData: T, type: string, data: T["message"]) => string[][];
+export declare const encodeData: <T extends TypedData>(typedData: T, type: string, data: T["message"]) => string[][];
 /**
  * Get encoded data as a hash. The data should be a key -> value object with all the required values. All dependant
  * types are automatically encoded.
@@ -62,24 +45,7 @@ export declare const encodeData: <T extends {
  * @param {Record<string, any>} data
  * @return {Buffer}
  */
-export declare const getStructHash: <T extends {
-    types: {
-        StarkNetDomain: {
-            type: string;
-            name: string;
-        }[];
-    } & Record<string, {
-        type: string;
-        name: string;
-    }[]>;
-    primaryType: string;
-    domain: {
-        version?: string | undefined;
-        chainId?: string | number | undefined;
-        name?: string | undefined;
-    };
-    message: Record<string, unknown>;
-}>(typedData: T, type: string, data: T["message"]) => string;
+export declare const getStructHash: <T extends TypedData>(typedData: T, type: string, data: T["message"]) => string;
 /**
  * Get the EIP-191 encoded message to sign, from the typedData object. If `hash` is enabled, the message will be hashed
  * with Keccak256.

package/dist/utils/typedData/types.d.ts

@@ -1,82 +1,27 @@
-import { Infer } from 'superstruct';
-export declare const ATOMIC_TYPES: string[];
-/**
- * Checks if a type is valid with the given `typedData`. The following types are valid:
- * - Atomic types: felt, felt*
- * - Reference types: struct type (e.g. SomeStruct)
- *
- * @param {Record<string, unknown>} types
- * @param {string} type
- * @return {boolean}
- */
-export declare const isValidType: (types: Record<string, unknown>, type: string) => boolean;
-export declare const STARKNET_TYPE: import("superstruct").Struct<{
-    type: string;
-    name: string;
-}, {
-    name: import("superstruct").Struct<string, null>;
-    type: import("superstruct").Struct<string, null>;
-}>;
 /**
  * A single type, as part of a struct. The `type` field can be any of the EIP-712 supported types.
  *
  * Note that the `uint` and `int` aliases like in Solidity, and fixed point numbers are not supported by the EIP-712
  * standard.
  */
-export declare type StarkNetType = Infer<typeof STARKNET_TYPE>;
-export declare const STARKNET_DOMAIN_TYPE: import("superstruct").Struct<{
-    version?: string | undefined;
-    chainId?: string | number | undefined;
-    name?: string | undefined;
-}, {
-    name: import("superstruct").Struct<string | undefined, null>;
-    version: import("superstruct").Struct<string | undefined, null>;
-    chainId: import("superstruct").Struct<string | number | undefined, null>;
-}>;
+export interface StarkNetType {
+    name: string;
+    type: 'felt' | 'felt*' | string;
+}
 /**
  * The EIP712 domain struct. Any of these fields are optional, but it must contain at least one field.
  */
-export declare type StarkNetDomain = Infer<typeof STARKNET_DOMAIN_TYPE>;
-export declare const STARKNET_TYPED_DATA_TYPE: import("superstruct").Struct<{
-    types: {
-        StarkNetDomain: {
-            type: string;
-            name: string;
-        }[];
-    } & Record<string, {
-        type: string;
-        name: string;
-    }[]>;
-    primaryType: string;
-    domain: {
-        version?: string | undefined;
-        chainId?: string | number | undefined;
-        name?: string | undefined;
-    };
-    message: Record<string, unknown>;
-}, {
-    types: import("superstruct").Struct<{
-        StarkNetDomain: {
-            type: string;
-            name: string;
-        }[];
-    } & Record<string, {
-        type: string;
-        name: string;
-    }[]>, null>;
-    primaryType: import("superstruct").Struct<string, null>;
-    domain: import("superstruct").Struct<{
-        version?: string | undefined;
-        chainId?: string | number | undefined;
-        name?: string | undefined;
-    }, {
-        name: import("superstruct").Struct<string | undefined, null>;
-        version: import("superstruct").Struct<string | undefined, null>;
-        chainId: import("superstruct").Struct<string | number | undefined, null>;
-    }>;
-    message: import("superstruct").Struct<Record<string, unknown>, null>;
-}>;
+export interface StarkNetDomain extends Record<string, unknown> {
+    name?: string;
+    version?: string;
+    chainId?: string | number;
+}
 /**
  * The complete typed data, with all the structs, domain data, primary type of the message, and the message itself.
  */
-export declare type TypedData = Infer<typeof STARKNET_TYPED_DATA_TYPE>;
+export interface TypedData {
+    types: Record<string, StarkNetType[]>;
+    primaryType: string;
+    domain: StarkNetDomain;
+    message: Record<string, unknown>;
+}

package/dist/utils/typedData/types.js

@@ -1,47 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.STARKNET_TYPED_DATA_TYPE = exports.STARKNET_DOMAIN_TYPE = exports.STARKNET_TYPE = exports.isValidType = exports.ATOMIC_TYPES = void 0;
-var superstruct_1 = require("superstruct");
-exports.ATOMIC_TYPES = ['felt', 'felt*'];
-// Source: https://github.com/Mrtenz/eip-712/blob/master/src/eip-712.ts
-// and modified to support starknet types
-/**
- * Checks if a type is valid with the given `typedData`. The following types are valid:
- * - Atomic types: felt, felt*
- * - Reference types: struct type (e.g. SomeStruct)
- *
- * @param {Record<string, unknown>} types
- * @param {string} type
- * @return {boolean}
- */
-var isValidType = function (types, type) {
-    if (exports.ATOMIC_TYPES.includes(type)) {
-        return true;
-    }
-    if (types[type]) {
-        return true;
-    }
-    return false;
-};
-exports.isValidType = isValidType;
-var TYPE = (0, superstruct_1.refine)((0, superstruct_1.string)(), 'Type', function (type, context) {
-    return (0, exports.isValidType)(context.branch[0].types, type);
-});
-exports.STARKNET_TYPE = (0, superstruct_1.object)({
-    name: (0, superstruct_1.string)(),
-    type: TYPE,
-});
-exports.STARKNET_DOMAIN_TYPE = (0, superstruct_1.object)({
-    name: (0, superstruct_1.optional)((0, superstruct_1.string)()),
-    version: (0, superstruct_1.optional)((0, superstruct_1.string)()),
-    chainId: (0, superstruct_1.optional)((0, superstruct_1.union)([(0, superstruct_1.string)(), (0, superstruct_1.number)()])),
-});
-exports.STARKNET_TYPED_DATA_TYPE = (0, superstruct_1.object)({
-    types: (0, superstruct_1.intersection)([
-        (0, superstruct_1.type)({ StarkNetDomain: (0, superstruct_1.array)(exports.STARKNET_TYPE) }),
-        (0, superstruct_1.record)((0, superstruct_1.string)(), (0, superstruct_1.array)(exports.STARKNET_TYPE)),
-    ]),
-    primaryType: (0, superstruct_1.string)(),
-    domain: exports.STARKNET_DOMAIN_TYPE,
-    message: (0, superstruct_1.object)(),
-});

package/dist/utils/typedData/utils.d.ts

@@ -1,24 +1,8 @@
+import { TypedData } from './types';
 /**
  * Validates that `data` matches the EIP-712 JSON schema.
  *
  * @param {any} data
  * @return {boolean}
  */
-export declare const validateTypedData: (data: unknown) => data is {
-    types: {
-        StarkNetDomain: {
-            type: string;
-            name: string;
-        }[];
-    } & Record<string, {
-        type: string;
-        name: string;
-    }[]>;
-    primaryType: string;
-    domain: {
-        version?: string | undefined;
-        chainId?: string | number | undefined;
-        name?: string | undefined;
-    };
-    message: Record<string, unknown>;
-};
+export declare const validateTypedData: (data: unknown) => data is TypedData;

package/dist/utils/typedData/utils.js

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateTypedData = void 0;
-var superstruct_1 = require("superstruct");
-var types_1 = require("./types");
 /**
  * Validates that `data` matches the EIP-712 JSON schema.
  *
@@ -10,6 +8,9 @@ var types_1 = require("./types");
  * @return {boolean}
  */
 var validateTypedData = function (data) {
-    return (0, superstruct_1.is)(data, types_1.STARKNET_TYPED_DATA_TYPE);
+    var typedData = data;
+    // Validate that the data matches the EIP-712 JSON schema
+    var valid = Boolean(typedData.types && typedData.primaryType && typedData.message);
+    return valid;
 };
 exports.validateTypedData = validateTypedData;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "3.12.2",
+  "version": "3.12.3",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -71,7 +71,6 @@
     "json-bigint": "^1.0.0",
     "minimalistic-assert": "^1.0.1",
     "pako": "^2.0.4",
-    "superstruct": "^0.15.3",
     "url-join": "^4.0.1"
   },
   "lint-staged": {

package/src/utils/typedData/types.ts

@@ -1,82 +1,29 @@
-import {
-  Infer,
-  array,
-  intersection,
-  number,
-  object,
-  optional,
-  record,
-  refine,
-  string,
-  type as t,
-  union,
-} from 'superstruct';
-
-export const ATOMIC_TYPES = ['felt', 'felt*'];
-
-// Source: https://github.com/Mrtenz/eip-712/blob/master/src/eip-712.ts
-// and modified to support starknet types
-
-/**
- * Checks if a type is valid with the given `typedData`. The following types are valid:
- * - Atomic types: felt, felt*
- * - Reference types: struct type (e.g. SomeStruct)
- *
- * @param {Record<string, unknown>} types
- * @param {string} type
- * @return {boolean}
- */
-export const isValidType = (types: Record<string, unknown>, type: string): boolean => {
-  if (ATOMIC_TYPES.includes(type as string)) {
-    return true;
-  }
-
-  if (types[type]) {
-    return true;
-  }
-
-  return false;
-};
-
-const TYPE = refine(string(), 'Type', (type, context) => {
-  return isValidType(context.branch[0].types, type);
-});
-
-export const STARKNET_TYPE = object({
-  name: string(),
-  type: TYPE,
-});
-
 /**
  * A single type, as part of a struct. The `type` field can be any of the EIP-712 supported types.
  *
  * Note that the `uint` and `int` aliases like in Solidity, and fixed point numbers are not supported by the EIP-712
  * standard.
  */
-export type StarkNetType = Infer<typeof STARKNET_TYPE>;
-
-export const STARKNET_DOMAIN_TYPE = object({
-  name: optional(string()),
-  version: optional(string()),
-  chainId: optional(union([string(), number()])),
-});
+export interface StarkNetType {
+  name: string;
+  type: 'felt' | 'felt*' | string;
+}
 
 /**
  * The EIP712 domain struct. Any of these fields are optional, but it must contain at least one field.
  */
-export type StarkNetDomain = Infer<typeof STARKNET_DOMAIN_TYPE>;
-
-export const STARKNET_TYPED_DATA_TYPE = object({
-  types: intersection([
-    t({ StarkNetDomain: array(STARKNET_TYPE) }),
-    record(string(), array(STARKNET_TYPE)),
-  ]),
-  primaryType: string(),
-  domain: STARKNET_DOMAIN_TYPE,
-  message: object(),
-});
+export interface StarkNetDomain extends Record<string, unknown> {
+  name?: string;
+  version?: string;
+  chainId?: string | number;
+}
 
 /**
  * The complete typed data, with all the structs, domain data, primary type of the message, and the message itself.
  */
-export type TypedData = Infer<typeof STARKNET_TYPED_DATA_TYPE>;
+export interface TypedData {
+  types: Record<string, StarkNetType[]>;
+  primaryType: string;
+  domain: StarkNetDomain;
+  message: Record<string, unknown>;
+}

package/src/utils/typedData/utils.ts

@@ -1,6 +1,4 @@
-import { is } from 'superstruct';
-
-import { STARKNET_TYPED_DATA_TYPE, TypedData } from './types';
+import { TypedData } from './types';
 
 /**
  * Validates that `data` matches the EIP-712 JSON schema.
@@ -9,5 +7,10 @@ import { STARKNET_TYPED_DATA_TYPE, TypedData } from './types';
  * @return {boolean}
  */
 export const validateTypedData = (data: unknown): data is TypedData => {
-  return is(data, STARKNET_TYPED_DATA_TYPE);
+  const typedData = data as TypedData;
+
+  // Validate that the data matches the EIP-712 JSON schema
+  const valid = Boolean(typedData.types && typedData.primaryType && typedData.message);
+
+  return valid;
 };

package/utils/typedData/index.d.ts

@@ -39,29 +39,7 @@ export declare const getTypeHash: (typedData: TypedData, type: string) => string
  * @param {string} type
  * @param {Record<string, any>} data
  */
-export declare const encodeData: <
-  T extends {
-    types: {
-      StarkNetDomain: {
-        type: string;
-        name: string;
-      }[];
-    } & Record<
-      string,
-      {
-        type: string;
-        name: string;
-      }[]
-    >;
-    primaryType: string;
-    domain: {
-      version?: string | undefined;
-      chainId?: string | number | undefined;
-      name?: string | undefined;
-    };
-    message: Record<string, unknown>;
-  }
->(
+export declare const encodeData: <T extends TypedData>(
   typedData: T,
   type: string,
   data: T['message']
@@ -75,29 +53,7 @@ export declare const encodeData: <
  * @param {Record<string, any>} data
  * @return {Buffer}
  */
-export declare const getStructHash: <
-  T extends {
-    types: {
-      StarkNetDomain: {
-        type: string;
-        name: string;
-      }[];
-    } & Record<
-      string,
-      {
-        type: string;
-        name: string;
-      }[]
-    >;
-    primaryType: string;
-    domain: {
-      version?: string | undefined;
-      chainId?: string | number | undefined;
-      name?: string | undefined;
-    };
-    message: Record<string, unknown>;
-  }
->(
+export declare const getStructHash: <T extends TypedData>(
   typedData: T,
   type: string,
   data: T['message']

package/utils/typedData/types.d.ts

@@ -1,103 +1,27 @@
-import { Infer } from 'superstruct';
-export declare const ATOMIC_TYPES: string[];
-/**
- * Checks if a type is valid with the given `typedData`. The following types are valid:
- * - Atomic types: felt, felt*
- * - Reference types: struct type (e.g. SomeStruct)
- *
- * @param {Record<string, unknown>} types
- * @param {string} type
- * @return {boolean}
- */
-export declare const isValidType: (types: Record<string, unknown>, type: string) => boolean;
-export declare const STARKNET_TYPE: import('superstruct').Struct<
-  {
-    type: string;
-    name: string;
-  },
-  {
-    name: import('superstruct').Struct<string, null>;
-    type: import('superstruct').Struct<string, null>;
-  }
->;
 /**
  * A single type, as part of a struct. The `type` field can be any of the EIP-712 supported types.
  *
  * Note that the `uint` and `int` aliases like in Solidity, and fixed point numbers are not supported by the EIP-712
  * standard.
  */
-export declare type StarkNetType = Infer<typeof STARKNET_TYPE>;
-export declare const STARKNET_DOMAIN_TYPE: import('superstruct').Struct<
-  {
-    version?: string | undefined;
-    chainId?: string | number | undefined;
-    name?: string | undefined;
-  },
-  {
-    name: import('superstruct').Struct<string | undefined, null>;
-    version: import('superstruct').Struct<string | undefined, null>;
-    chainId: import('superstruct').Struct<string | number | undefined, null>;
-  }
->;
+export interface StarkNetType {
+  name: string;
+  type: 'felt' | 'felt*' | string;
+}
 /**
  * The EIP712 domain struct. Any of these fields are optional, but it must contain at least one field.
  */
-export declare type StarkNetDomain = Infer<typeof STARKNET_DOMAIN_TYPE>;
-export declare const STARKNET_TYPED_DATA_TYPE: import('superstruct').Struct<
-  {
-    types: {
-      StarkNetDomain: {
-        type: string;
-        name: string;
-      }[];
-    } & Record<
-      string,
-      {
-        type: string;
-        name: string;
-      }[]
-    >;
-    primaryType: string;
-    domain: {
-      version?: string | undefined;
-      chainId?: string | number | undefined;
-      name?: string | undefined;
-    };
-    message: Record<string, unknown>;
-  },
-  {
-    types: import('superstruct').Struct<
-      {
-        StarkNetDomain: {
-          type: string;
-          name: string;
-        }[];
-      } & Record<
-        string,
-        {
-          type: string;
-          name: string;
-        }[]
-      >,
-      null
-    >;
-    primaryType: import('superstruct').Struct<string, null>;
-    domain: import('superstruct').Struct<
-      {
-        version?: string | undefined;
-        chainId?: string | number | undefined;
-        name?: string | undefined;
-      },
-      {
-        name: import('superstruct').Struct<string | undefined, null>;
-        version: import('superstruct').Struct<string | undefined, null>;
-        chainId: import('superstruct').Struct<string | number | undefined, null>;
-      }
-    >;
-    message: import('superstruct').Struct<Record<string, unknown>, null>;
-  }
->;
+export interface StarkNetDomain extends Record<string, unknown> {
+  name?: string;
+  version?: string;
+  chainId?: string | number;
+}
 /**
  * The complete typed data, with all the structs, domain data, primary type of the message, and the message itself.
  */
-export declare type TypedData = Infer<typeof STARKNET_TYPED_DATA_TYPE>;
+export interface TypedData {
+  types: Record<string, StarkNetType[]>;
+  primaryType: string;
+  domain: StarkNetDomain;
+  message: Record<string, unknown>;
+}

package/utils/typedData/types.js

@@ -1,57 +1,2 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.STARKNET_TYPED_DATA_TYPE =
-  exports.STARKNET_DOMAIN_TYPE =
-  exports.STARKNET_TYPE =
-  exports.isValidType =
-  exports.ATOMIC_TYPES =
-    void 0;
-var superstruct_1 = require('superstruct');
-exports.ATOMIC_TYPES = ['felt', 'felt*'];
-// Source: https://github.com/Mrtenz/eip-712/blob/master/src/eip-712.ts
-// and modified to support starknet types
-/**
- * Checks if a type is valid with the given `typedData`. The following types are valid:
- * - Atomic types: felt, felt*
- * - Reference types: struct type (e.g. SomeStruct)
- *
- * @param {Record<string, unknown>} types
- * @param {string} type
- * @return {boolean}
- */
-var isValidType = function (types, type) {
-  if (exports.ATOMIC_TYPES.includes(type)) {
-    return true;
-  }
-  if (types[type]) {
-    return true;
-  }
-  return false;
-};
-exports.isValidType = isValidType;
-var TYPE = (0, superstruct_1.refine)((0, superstruct_1.string)(), 'Type', function (type, context) {
-  return (0, exports.isValidType)(context.branch[0].types, type);
-});
-exports.STARKNET_TYPE = (0, superstruct_1.object)({
-  name: (0, superstruct_1.string)(),
-  type: TYPE,
-});
-exports.STARKNET_DOMAIN_TYPE = (0, superstruct_1.object)({
-  name: (0, superstruct_1.optional)((0, superstruct_1.string)()),
-  version: (0, superstruct_1.optional)((0, superstruct_1.string)()),
-  chainId: (0, superstruct_1.optional)(
-    (0, superstruct_1.union)([(0, superstruct_1.string)(), (0, superstruct_1.number)()])
-  ),
-});
-exports.STARKNET_TYPED_DATA_TYPE = (0, superstruct_1.object)({
-  types: (0, superstruct_1.intersection)([
-    (0, superstruct_1.type)({ StarkNetDomain: (0, superstruct_1.array)(exports.STARKNET_TYPE) }),
-    (0, superstruct_1.record)(
-      (0, superstruct_1.string)(),
-      (0, superstruct_1.array)(exports.STARKNET_TYPE)
-    ),
-  ]),
-  primaryType: (0, superstruct_1.string)(),
-  domain: exports.STARKNET_DOMAIN_TYPE,
-  message: (0, superstruct_1.object)(),
-});

package/utils/typedData/utils.d.ts

@@ -1,27 +1,8 @@
+import { TypedData } from './types';
 /**
  * Validates that `data` matches the EIP-712 JSON schema.
  *
  * @param {any} data
  * @return {boolean}
  */
-export declare const validateTypedData: (data: unknown) => data is {
-  types: {
-    StarkNetDomain: {
-      type: string;
-      name: string;
-    }[];
-  } & Record<
-    string,
-    {
-      type: string;
-      name: string;
-    }[]
-  >;
-  primaryType: string;
-  domain: {
-    version?: string | undefined;
-    chainId?: string | number | undefined;
-    name?: string | undefined;
-  };
-  message: Record<string, unknown>;
-};
+export declare const validateTypedData: (data: unknown) => data is TypedData;

package/utils/typedData/utils.js

@@ -1,8 +1,6 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.validateTypedData = void 0;
-var superstruct_1 = require('superstruct');
-var types_1 = require('./types');
 /**
  * Validates that `data` matches the EIP-712 JSON schema.
  *
@@ -10,6 +8,9 @@ var types_1 = require('./types');
  * @return {boolean}
  */
 var validateTypedData = function (data) {
-  return (0, superstruct_1.is)(data, types_1.STARKNET_TYPED_DATA_TYPE);
+  var typedData = data;
+  // Validate that the data matches the EIP-712 JSON schema
+  var valid = Boolean(typedData.types && typedData.primaryType && typedData.message);
+  return valid;
 };
 exports.validateTypedData = validateTypedData;