starknet 4.3.0 → 4.4.1

package/utils/typedData/index.js

@@ -39,8 +39,9 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMessageHash = exports.getStructHash = exports.encodeData = exports.getTypeHash = exports.encodeType = exports.getDependencies = void 0;
+exports.getMessageHash = exports.getStructHash = exports.encodeData = exports.encodeValue = exports.getTypeHash = exports.encodeType = exports.getDependencies = exports.isMerkleTreeType = exports.prepareSelector = void 0;
 var hash_1 = require("../hash");
+var merkle_1 = require("../merkle");
 var number_1 = require("../number");
 var shortString_1 = require("../shortString");
 var utils_1 = require("./utils");
@@ -56,6 +57,14 @@ function getHex(value) {
         throw new Error("Invalid BigNumberish: ".concat(value));
     }
 }
+function prepareSelector(selector) {
+    return (0, number_1.isHex)(selector) ? selector : (0, hash_1.getSelectorFromName)(selector);
+}
+exports.prepareSelector = prepareSelector;
+function isMerkleTreeType(type) {
+    return type.type === 'merkletree';
+}
+exports.isMerkleTreeType = isMerkleTreeType;
 /**
  * Get the dependencies of a struct type. If a struct has the same dependency multiple times, it's only included once
  * in the resulting array.
@@ -65,12 +74,8 @@ function getHex(value) {
  * @param {string[]} [dependencies]
  * @return {string[]}
  */
-var getDependencies = function (typedData, type, dependencies) {
+var getDependencies = function (types, type, dependencies) {
     if (dependencies === void 0) { dependencies = []; }
-    // `getDependencies` is called by most other functions, so we validate the JSON schema here
-    if (!(0, utils_1.validateTypedData)(typedData)) {
-        throw new Error('Typed data does not match JSON schema');
-    }
     // Include pointers (struct arrays)
     if (type[type.length - 1] === '*') {
         // eslint-disable-next-line no-param-reassign
@@ -79,14 +84,29 @@ var getDependencies = function (typedData, type, dependencies) {
     if (dependencies.includes(type)) {
         return dependencies;
     }
-    if (!typedData.types[type]) {
+    if (!types[type]) {
         return dependencies;
     }
     return __spreadArray([
         type
-    ], __read(typedData.types[type].reduce(function (previous, t) { return __spreadArray(__spreadArray([], __read(previous), false), __read((0, exports.getDependencies)(typedData, t.type, previous).filter(function (dependency) { return !previous.includes(dependency); })), false); }, [])), false);
+    ], __read(types[type].reduce(function (previous, t) { return __spreadArray(__spreadArray([], __read(previous), false), __read((0, exports.getDependencies)(types, t.type, previous).filter(function (dependency) { return !previous.includes(dependency); })), false); }, [])), false);
 };
 exports.getDependencies = getDependencies;
+function getMerkleTreeType(types, ctx) {
+    if (ctx.parent && ctx.key) {
+        var parentType = types[ctx.parent];
+        var merkleType = parentType.find(function (t) { return t.name === ctx.key; });
+        var isMerkleTree = isMerkleTreeType(merkleType);
+        if (!isMerkleTree) {
+            throw new Error("".concat(ctx.key, " is not a merkle tree"));
+        }
+        if (merkleType.contains.endsWith('*')) {
+            throw new Error("Merkle tree contain property must not be an array but was given ".concat(ctx.key));
+        }
+        return merkleType.contains;
+    }
+    return 'raw';
+}
 /**
  * Encode a type to a string. All dependant types are alphabetically sorted.
  *
@@ -94,12 +114,12 @@ exports.getDependencies = getDependencies;
  * @param {string} type
  * @return {string}
  */
-var encodeType = function (typedData, type) {
-    var _a = __read((0, exports.getDependencies)(typedData, type)), primary = _a[0], dependencies = _a.slice(1);
-    var types = __spreadArray([primary], __read(dependencies.sort()), false);
-    return types
+var encodeType = function (types, type) {
+    var _a = __read((0, exports.getDependencies)(types, type)), primary = _a[0], dependencies = _a.slice(1);
+    var newTypes = !primary ? [] : __spreadArray([primary], __read(dependencies.sort()), false);
+    return newTypes
         .map(function (dependency) {
-        return "".concat(dependency, "(").concat(typedData.types[dependency].map(function (t) { return "".concat(t.name, ":").concat(t.type); }), ")");
+        return "".concat(dependency, "(").concat(types[dependency].map(function (t) { return "".concat(t.name, ":").concat(t.type); }), ")");
     })
         .join('');
 };
@@ -111,8 +131,8 @@ exports.encodeType = encodeType;
  * @param {string} type
  * @return {string}
  */
-var getTypeHash = function (typedData, type) {
-    return (0, hash_1.getSelectorFromName)((0, exports.encodeType)(typedData, type));
+var getTypeHash = function (types, type) {
+    return (0, hash_1.getSelectorFromName)((0, exports.encodeType)(types, type));
 };
 exports.getTypeHash = getTypeHash;
 /**
@@ -124,25 +144,39 @@ exports.getTypeHash = getTypeHash;
  * @param {any} data
  * @returns {[string, string]}
  */
-var encodeValue = function (typedData, type, data) {
-    if (typedData.types[type]) {
+var encodeValue = function (types, type, data, ctx) {
+    if (ctx === void 0) { ctx = {}; }
+    if (types[type]) {
         // eslint-disable-next-line @typescript-eslint/no-use-before-define
-        return [type, (0, exports.getStructHash)(typedData, type, data)];
+        return [type, (0, exports.getStructHash)(types, type, data)];
     }
-    if (Object.keys(typedData.types)
+    if (Object.keys(types)
         .map(function (x) { return "".concat(x, "*"); })
         .includes(type)) {
         var structHashes = data.map(function (struct) {
             // eslint-disable-next-line @typescript-eslint/no-use-before-define
-            return (0, exports.getStructHash)(typedData, type.slice(0, -1), struct);
+            return (0, exports.getStructHash)(types, type.slice(0, -1), struct);
         });
         return [type, (0, hash_1.computeHashOnElements)(structHashes)];
     }
+    if (type === 'merkletree') {
+        var merkleTreeType_1 = getMerkleTreeType(types, ctx);
+        var structHashes = data.map(function (struct) {
+            // eslint-disable-next-line @typescript-eslint/no-use-before-define
+            return (0, exports.encodeValue)(types, merkleTreeType_1, struct)[1];
+        });
+        var root = new merkle_1.MerkleTree(structHashes).root;
+        return ['felt', root];
+    }
     if (type === 'felt*') {
         return ['felt*', (0, hash_1.computeHashOnElements)(data)];
     }
+    if (type === 'selector') {
+        return ['felt', prepareSelector(data)];
+    }
     return [type, getHex(data)];
 };
+exports.encodeValue = encodeValue;
 /**
  * Encode the data to an ABI encoded Buffer. The data should be a key -> value object with all the required values. All
  * dependant types are automatically encoded.
@@ -151,20 +185,23 @@ var encodeValue = function (typedData, type, data) {
  * @param {string} type
  * @param {Record<string, any>} data
  */
-var encodeData = function (typedData, type, data) {
-    var _a = __read(typedData.types[type].reduce(function (_a, field) {
+var encodeData = function (types, type, data) {
+    var _a = __read(types[type].reduce(function (_a, field) {
         var _b = __read(_a, 2), ts = _b[0], vs = _b[1];
         if (data[field.name] === undefined || data[field.name] === null) {
             throw new Error("Cannot encode data: missing data for '".concat(field.name, "'"));
         }
         var value = data[field.name];
-        var _c = __read(encodeValue(typedData, field.type, value), 2), t = _c[0], encodedValue = _c[1];
+        var _c = __read((0, exports.encodeValue)(types, field.type, value, {
+            parent: type,
+            key: field.name,
+        }), 2), t = _c[0], encodedValue = _c[1];
         return [
             __spreadArray(__spreadArray([], __read(ts), false), [t], false),
             __spreadArray(__spreadArray([], __read(vs), false), [encodedValue], false),
         ];
-    }, [['felt'], [(0, exports.getTypeHash)(typedData, type)]]), 2), types = _a[0], values = _a[1];
-    return [types, values];
+    }, [['felt'], [(0, exports.getTypeHash)(types, type)]]), 2), returnTypes = _a[0], values = _a[1];
+    return [returnTypes, values];
 };
 exports.encodeData = encodeData;
 /**
@@ -176,24 +213,26 @@ exports.encodeData = encodeData;
  * @param {Record<string, any>} data
  * @return {Buffer}
  */
-var getStructHash = function (typedData, type, data) {
-    return (0, hash_1.computeHashOnElements)((0, exports.encodeData)(typedData, type, data)[1]);
+var getStructHash = function (types, type, data) {
+    return (0, hash_1.computeHashOnElements)((0, exports.encodeData)(types, type, data)[1]);
 };
 exports.getStructHash = getStructHash;
 /**
- * Get the EIP-191 encoded message to sign, from the typedData object. If `hash` is enabled, the message will be hashed
- * with Keccak256.
+ * Get the EIP-191 encoded message to sign, from the typedData object.
  *
  * @param {TypedData} typedData
  * @param {BigNumberish} account
  * @return {string}
  */
 var getMessageHash = function (typedData, account) {
+    if (!(0, utils_1.validateTypedData)(typedData)) {
+        throw new Error('Typed data does not match JSON schema');
+    }
     var message = [
         (0, shortString_1.encodeShortString)('StarkNet Message'),
-        (0, exports.getStructHash)(typedData, 'StarkNetDomain', typedData.domain),
+        (0, exports.getStructHash)(typedData.types, 'StarkNetDomain', typedData.domain),
         account,
-        (0, exports.getStructHash)(typedData, typedData.primaryType, typedData.message),
+        (0, exports.getStructHash)(typedData.types, typedData.primaryType, typedData.message),
     ];
     return (0, hash_1.computeHashOnElements)(message);
 };

package/utils/typedData/types.d.ts

@@ -1,13 +1,18 @@
+export declare type StarkNetMerkleType = {
+    name: string;
+    type: 'merkletree';
+    contains: string;
+};
 /**
  * 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 interface StarkNetType {
+export declare type StarkNetType = {
     name: string;
-    type: 'felt' | 'felt*' | string;
-}
+    type: string;
+} | StarkNetMerkleType;
 /**
  * The EIP712 domain struct. Any of these fields are optional, but it must contain at least one field.
  */

package/www/docs/API/account.md

@@ -12,36 +12,36 @@ This API is the primary way to interact with an account contract on StarkNet.
 
 ## Creating an instance
 
-For creating new instance of Account, account contract must be deployed. Also there needs to be a Provider instance that will be passed in the constructor and key pair for the account.
+To create a new instance of the Account, first an account contract must be deployed. Also there needs to be a Provider instance that will be passed in the constructor and key pair for the account.
 
 `new starknet.Account(Provider, address, starkKeyPair)`
 
-## Account Properties
+## Properties
 
 account.**address** => _string_
 
-The address of the account contract
+The address of the account contract.
 
-## Account methods
+## Methods
 
 account.**getNonce()** => _Promise < string >_
 
-Gets new Nonce for the next transaction
+Gets the new Nonce for the next transaction.
 
 <hr />
 
 account.**estimateFee**(calls [ , options ]) => _Promise < EstimateFeeResponse >_
 
-Gets the estimated fee for the call(s)
+Gets the estimated fee for the call(s).
 
 The _options_ object may include any of:
 
 - options.**blockIdentifier** - Block Identifier for the transaction
 - options.**nonce** - Nonce for the transaction
 
-###### EstimateFeeResponse
+###### _EstimateFeeResponse_
 
-```
+```typescript
 {
   overall_fee: BN;
   gas_consumed?: BN;
@@ -53,7 +53,7 @@ The _options_ object may include any of:
 
 account.**execute**(calls [ , abi , transactionsDetail ]) => _Promise < AddTransactionResponse >_
 
-Executes one or multiple calls using the account contract
+Executes one or multiple calls using the account contract.
 
 The _transactionsDetail_ object may include any of:
 
@@ -61,9 +61,9 @@ The _transactionsDetail_ object may include any of:
 - transactionsDetail.**nonce** - Nonce for the transaction
 - transactionsDetail.**version** - Version for the transaction (default is 0)
 
-###### AddTransactionResponse
+###### _AddTransactionResponse_
 
-```
+```typescript
 {
   transaction_hash: string;
 };
@@ -73,11 +73,11 @@ The _transactionsDetail_ object may include any of:
 
 account.**signMessage**(typedData) => _Promise < Signature >_
 
-Creates a signature from the passed data
+Creates a signature from the passed data.
 
-###### Signature
+###### _Signature_
 
-```
+```typescript
 string[];
 ```
 
@@ -85,20 +85,22 @@ string[];
 
 account.**hashMessage**(typedData) => _Promise < string >_
 
-Creates a hash from the passed data
+Creates a hash from the passed data.
 
 <hr />
 
 account.**verifyMessageHash**(hash, signature) => _Promise < boolean >_
 
-Verify a signature of a given hash
+Verify a signature of a given hash.
 
-**WARNING** This method is not recommended, use verifyMessage instead
+> **WARNING**
+>
+> This method is not recommended, use `verifyMessage` instead
 
 <hr />
 
 account.**verifyMessage**(typedData, signature) => _Promise < boolean >_
 
-Verify a signature of a JSON object
+Verify a signature of a JSON object.
 
 <hr />

package/www/docs/API/contract.md

@@ -12,19 +12,19 @@ Contracts allow you to transform Cairo values, like `Uint256` to `BigNumber`. It
 
 `new starknet.Contract(abi, address, providerOrAccount)`
 
-`contract.attach(providerOrAccount)` _for changing the provider or account_
+`contract.attach(address)` _for changing the address of the connected contract_
 
-`contract.connect(address)` _for changing the address of the connected contract_
+`contract.connect(providerOrAccount)` _for changing the provider or account_
 
-## Contract properties
+## Properties
 
 contract.**address** => _string_
 
-The address the contract was constructed/connected with
+The address the contract was constructed/connected with.
 
 contract.**providerOrAccount** => _ProviderInterface | AccountInterface_
 
-Provider or account that are used to interact with the network
+Provider or account that are used to interact with the network.
 
 contract.**deployTransactionHash** => _string | null_
 
@@ -32,9 +32,9 @@ If the Contract object is the result of a ContractFactory deployment, this is th
 
 contract.**abi** => _Abi_
 
-The ABI the contract was constructed with
+The ABI the contract was constructed with.
 
-## Contract methods
+## Methods
 
 contract.**deployed**() => _Promise < Contract >_
 
@@ -46,13 +46,13 @@ A Meta-Class is a Class which has any of its properties determined at run-time.
 
 ### Read-Only Methods(constant)
 
-A constant method (denoted view in Cairo) is read-only and evaluates a small amount of EVM code against the current blockchain state. It is therefore free and does not require any fee, but cannot make changes to the blockchain state...
+A constant method (denoted view in Cairo) is read-only and evaluates a small amount of Cairo code against the current blockchain state. It is therefore free and does not require any fee, but cannot make changes to the blockchain state...
 
 contract.**METHOD_NAME**(...args [ , overrides ]) => _Promise < Result >_
 
 The type of the result depends on the ABI. Result object will be returned with each parameter available positionally and if the parameter is named, it will also be available by its name.
 
-The _overrides_ object for a read-only method may include any of:
+The _overrides_ object for a read-only method may include:
 
 - overrides.**blockIdentifier**
 
@@ -62,7 +62,7 @@ A non-constant method requires a transaction to be signed and requires payment i
 
 contract.**METHOD_NAME**(...args [ , overrides ]) => _Promise < AddTransactionResponse >_
 
-Returns a AddTransactionResponse for the transaction after it is sent to the network. This requires the Contract has a signer.
+Returns a _AddTransactionResponse_ for the transaction after it is sent to the network. This requires that Contract has a signer.
 
 The _overrides_ object for write methods may include any of:
 

package/www/docs/API/contractFactory.md

@@ -4,7 +4,7 @@ sidebar_position: 5
 
 # Contract Factory
 
-Contract Factory allow you to deploy contracts onto StarkNet. To deploy a Contract, additional information is needed that is not available on a Contract object itself.
+Contract Factory allow you to deploy contracts to StarkNet. To deploy a Contract, additional information is needed that is not available on a Contract object itself.
 
 ## Creating an instance
 
@@ -18,25 +18,28 @@ Creates a new instance of a ContractFactory for the contract described by the _c
 
 ## Properties
 
-contractFactory.**abi** => _Abi_;
+contractFactory.**abi** => _Abi_
 
-The ABI the contractFactory was constructed with
+The ABI the contractFactory was constructed with.
 
-contractFactory.**compiledContract** => _CompiledContract_;
+contractFactory.**compiledContract** => _CompiledContract_
 
-The compiled contract the contractFactory was constructed with
+The compiled contract the contractFactory was constructed with.
 
-contractFactory.**providerOrAccount** => _ProviderInterface | AccountInterface_;
+contractFactory.**providerOrAccount** => _ProviderInterface | AccountInterface_
 
-Provider or account that are used to interact with the network
+Provider or account that are used to interact with the network.
 
 ## Methods
 
 contractFactory.**attach**( address ) ⇒ _Contract_
 
-Return an instance of a Contract attached to address. This is the same as using the Contract constructor with address and this _compiledContract_ and _providerOrAccount_ passed in when creating the ContractFactory.
+Return an instance of a _Contract_ attached to address. This is the same as using the _Contract_ constructor with address and this _compiledContract_ and _providerOrAccount_ passed in when creating the ContractFactory.
 
-contractFactory.deploy( constructorCalldata, addressSalt ) ⇒ Promise< Contract >
-Uses the provider to deploy the Contract with constructorCalldata passed into the constructor and returns a Contract which is attached to the address where this contract will be deployed.
+<hr />
 
-The transaction hash can be found at contract.deployTransactionHash, and no interactions should be made until the transaction is resolved.
+contractFactory.**deploy**( constructorCalldata, addressSalt ) ⇒ _Promise < Contract >_
+
+Uses the provider to deploy the Contract with _constructorCalldata_ passed into the constructor and returns a _Contract_ which is attached to the address where this contract will be deployed.
+
+The transaction hash can be found at _contract.deployTransactionHash_, and no interactions should be made until the transaction is resolved.