starknet 4.8.0 → 4.10.0

package/utils/merkle.js

@@ -44,7 +44,7 @@ var MerkleTree = /** @class */ (function () {
         var newLeaves = [];
         for (var i = 0; i < leaves.length; i += 2) {
             if (i + 1 === leaves.length) {
-                newLeaves.push(leaves[i]);
+                newLeaves.push(MerkleTree.hash(leaves[i], '0x0'));
             }
             else {
                 newLeaves.push(MerkleTree.hash(leaves[i], leaves[i + 1]));
@@ -74,9 +74,7 @@ var MerkleTree = /** @class */ (function () {
             ? -1
             : this.branches.findIndex(function (b) { return b.length === branch.length; });
         var nextBranch = (_b = this.branches[currentBranchLevelIndex + 1]) !== null && _b !== void 0 ? _b : [this.root];
-        return this.getProof(neededBranch === '0x0'
-            ? leaf
-            : MerkleTree.hash(isLeft ? leaf : neededBranch, isLeft ? neededBranch : leaf), nextBranch, newHashPath);
+        return this.getProof(MerkleTree.hash(isLeft ? leaf : neededBranch, isLeft ? neededBranch : leaf), nextBranch, newHashPath);
     };
     return MerkleTree;
 }());

package/utils/number.d.ts

@@ -13,3 +13,4 @@ export declare const toHexString: (value: string) => string;
 export declare function getDecimalString(value: string): string;
 export declare function getHexString(value: string): string;
 export declare function getHexStringArray(value: Array<string>): string[];
+export declare const toCairoBool: (value: boolean) => string;

package/utils/number.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHexStringArray = exports.getHexString = exports.getDecimalString = exports.toHexString = exports.isStringWholeNumber = exports.bigNumberishArrayToHexadecimalStringArray = exports.bigNumberishArrayToDecimalStringArray = exports.assertInRange = exports.toFelt = exports.hexToDecimalString = exports.toHex = exports.toBN = exports.isHex = void 0;
+exports.toCairoBool = exports.getHexStringArray = exports.getHexString = exports.getDecimalString = exports.toHexString = exports.isStringWholeNumber = exports.bigNumberishArrayToHexadecimalStringArray = exports.bigNumberishArrayToDecimalStringArray = exports.assertInRange = exports.toFelt = exports.hexToDecimalString = exports.toHex = exports.toBN = exports.isHex = void 0;
 var bn_js_1 = __importStar(require("bn.js"));
 var minimalistic_assert_1 = __importDefault(require("minimalistic-assert"));
 var encode_1 = require("./encode");
@@ -108,3 +108,5 @@ function getHexStringArray(value) {
     return value.map(function (el) { return getHexString(el); });
 }
 exports.getHexStringArray = getHexStringArray;
+var toCairoBool = function (value) { return (+value).toString(); };
+exports.toCairoBool = toCairoBool;

package/utils/responseParser/rpc.d.ts

@@ -2,7 +2,7 @@
  * Map RPC Response to common interface response
  * Intersection (sequencer response ∩ (∪ rpc responses))
  */
-import { CallContractResponse, EstimateFeeResponse, GetBlockResponse, GetTransactionReceiptResponse, GetTransactionResponse } from '../../types';
+import { CallContractResponse, EstimateFeeResponse, GetBlockResponse, GetTransactionResponse } from '../../types';
 import { RPC } from '../../types/api';
 import { ResponseParser } from '.';
 declare type RpcGetBlockResponse = RPC.GetBlockWithTxHashesResponse & {
@@ -11,13 +11,9 @@ declare type RpcGetBlockResponse = RPC.GetBlockWithTxHashesResponse & {
 declare type GetTransactionByHashResponse = RPC.GetTransactionByHashResponse & {
     [key: string]: any;
 };
-declare type TransactionReceipt = RPC.TransactionReceipt & {
-    [key: string]: any;
-};
-export declare class RPCResponseParser implements Omit<ResponseParser, 'parseDeclareContractResponse' | 'parseDeployContractResponse' | 'parseInvokeFunctionResponse'> {
+export declare class RPCResponseParser implements Omit<ResponseParser, 'parseDeclareContractResponse' | 'parseDeployContractResponse' | 'parseInvokeFunctionResponse' | 'parseGetTransactionReceiptResponse'> {
     parseGetBlockResponse(res: RpcGetBlockResponse): GetBlockResponse;
     parseGetTransactionResponse(res: GetTransactionByHashResponse): GetTransactionResponse;
-    parseGetTransactionReceiptResponse(res: TransactionReceipt): GetTransactionReceiptResponse;
     parseFeeEstimateResponse(res: RPC.EstimateFeeResponse): EstimateFeeResponse;
     parseCallContractResponse(res: Array<string>): CallContractResponse;
 }

package/utils/responseParser/rpc.js

@@ -27,17 +27,6 @@ var RPCResponseParser = /** @class */ (function () {
             version: res.version,
         };
     };
-    RPCResponseParser.prototype.parseGetTransactionReceiptResponse = function (res) {
-        return {
-            transaction_hash: res.transaction_hash,
-            actual_fee: res.actual_fee,
-            status: res.status,
-            status_data: res.status_data,
-            messages_sent: res.messages_sent,
-            l1_origin_message: res.l1_origin_message,
-            events: res.events,
-        };
-    };
     RPCResponseParser.prototype.parseFeeEstimateResponse = function (res) {
         return {
             overall_fee: (0, number_1.toBN)(res.overall_fee),

package/utils/responseParser/sequencer.js

@@ -40,25 +40,15 @@ var SequencerAPIResponseParser = /** @class */ (function (_super) {
                 .filter(Boolean) });
     };
     SequencerAPIResponseParser.prototype.parseGetTransactionResponse = function (res) {
-        return {
-            calldata: 'calldata' in res.transaction ? res.transaction.calldata : [],
-            contract_address: 'contract_address' in res.transaction ? res.transaction.contract_address : undefined,
-            contract_class: 'contract_class' in res.transaction ? res.transaction.contract_class : undefined,
-            entry_point_selector: 'entry_point_selector' in res.transaction
+        return __assign(__assign({}, res), { calldata: 'calldata' in res.transaction ? res.transaction.calldata : [], contract_address: 'contract_address' in res.transaction ? res.transaction.contract_address : undefined, contract_class: 'contract_class' in res.transaction ? res.transaction.contract_class : undefined, entry_point_selector: 'entry_point_selector' in res.transaction
                 ? res.transaction.entry_point_selector
-                : undefined,
-            max_fee: 'max_fee' in res.transaction ? res.transaction.max_fee : undefined,
-            nonce: res.transaction.nonce,
-            sender_address: 'sender_address' in res.transaction
+                : undefined, max_fee: 'max_fee' in res.transaction ? res.transaction.max_fee : undefined, nonce: res.transaction.nonce, sender_address: 'sender_address' in res.transaction
                 ? res.transaction.sender_address
-                : undefined,
-            signature: 'signature' in res.transaction ? res.transaction.signature : undefined,
-            transaction_hash: 'transaction_hash' in res.transaction ? res.transaction.transaction_hash : undefined,
-            version: 'version' in res.transaction ? res.transaction.version : undefined,
-        };
+                : undefined, signature: 'signature' in res.transaction ? res.transaction.signature : undefined, transaction_hash: 'transaction_hash' in res.transaction ? res.transaction.transaction_hash : undefined, version: 'version' in res.transaction ? res.transaction.version : undefined });
     };
     SequencerAPIResponseParser.prototype.parseGetTransactionReceiptResponse = function (res) {
         return __assign(__assign(__assign(__assign(__assign(__assign(__assign({ transaction_hash: res.transaction_hash, status: res.status, messages_sent: res.l2_to_l1_messages, events: res.events }, ('block_hash' in res && { block_hash: res.block_hash })), ('block_number' in res && { block_number: res.block_number })), ('actual_fee' in res && { actual_fee: res.actual_fee })), ('transaction_index' in res && { transaction_index: res.transaction_index })), ('execution_resources' in res && { execution_resources: res.execution_resources })), ('l1_to_l2_consumed_message' in res && {
+            // eslint-disable-next-line @typescript-eslint/dot-notation
             l1_to_l2_consumed_message: res['l1_to_l2_consumed_message'],
         })), ('transaction_failure_reason' in res && {
             transaction_failure_reason: res.transaction_failure_reason,

package/www/docs/API/account.md

@@ -24,20 +24,82 @@ The address of the account contract.
 
 ## Methods
 
-account.**getNonce()** => _Promise < BigNumberish >_
+account.**getNonce(blockIdentifier)** => _Promise < BigNumberish >_
 
-Gets the new Nonce of the connected account for the next transaction.
+Gets the nonce of the account with respect to a specific block.
+
+_blockIdentifier_ - optional blockIdentifier. Defaults to 'pending'.
+
+Returns the nonce of the account.
+
+<hr />
+
+account.**estimateInvokeFee**(calls [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
+
+Estimate Fee for executing an INVOKE transaction on starknet.
+
+The _calls_ object structure:
+
+- calls.**contractAddress** - Address of the contract
+- calls.**entrypoint** - Entrypoint of the call (method name)
+- calls.**calldata** - Payload for the invoking method
+
+The _estimateFeeDetails_ object may include any of:
+
+- estimateFeeDetails.**blockIdentifier** - Block Identifier for the transaction
+- estimateFeeDetails.**nonce** - Nonce for the transaction
+
+###### _EstimateFeeResponse_
+
+```typescript
+{
+  overall_fee: BN;
+  gas_consumed?: BN;
+  gas_price?: BN;
+}
+```
+
+<hr />
+
+account.**estimateDeclareFee**(contractPayload [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
+
+Estimate Fee for executing a DECLARE transaction on starknet.
+
+The _contractPayload_ object structure:
+
+- contractPayload.**contract** - The compiled contract
+- contractPayload.**classHash** - This can be obtained by using starknet-cli. Once the classHash is included in CompiledContract, this can be removed
+
+The _estimateFeeDetails_ object may include any of:
+
+- estimateFeeDetails.**blockIdentifier** - Block Identifier for the transaction
+- estimateFeeDetails.**nonce** - Nonce for the transaction
+
+###### _EstimateFeeResponse_
+
+```typescript
+{
+  overall_fee: BN;
+  gas_consumed?: BN;
+  gas_price?: BN;
+}
+```
 
 <hr />
 
-account.**estimateFee**(calls [ , options ]) => _Promise < EstimateFeeResponse >_
+account.**estimateAccountDeployFee**(contractPayload [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
+
+Estimate Fee for executing a DEPLOY_ACCOUNT transaction on starknet
 
-Gets the estimated fee for the call(s).
+The _contractPayload_ object structure:
 
-The _options_ object may include any of:
+- contractPayload.**contract** - The compiled contract to be declared
+- contractPayload.**classHash** - This can be obtained by using starknet-cli. Once the classHash is included in CompiledContract, this can be removed
 
-- options.**blockIdentifier** - Block Identifier for the transaction
-- options.**nonce** - Nonce for the transaction
+The _estimateFeeDetails_ object may include any of:
+
+- estimateFeeDetails.**blockIdentifier** - Block Identifier for the transaction
+- estimateFeeDetails.**nonce** - Nonce for the transaction
 
 ###### _EstimateFeeResponse_
 
@@ -51,17 +113,26 @@ The _options_ object may include any of:
 
 <hr />
 
-account.**execute**(calls [ , abi , transactionsDetail ]) => _Promise < AddTransactionResponse >_
+account.**execute**(transactions [ , abi , transactionsDetail ]) => _Promise < InvokeFunctionResponse >_
 
 Executes one or multiple calls using the account contract.
 
+The _transactions_ object structure:
+
+- contractPayload.**contractAddress** - the address of the contract
+- contractPayload.**entrypoint** - the entrypoint of the contract
+- contractPayload.**calldata** - (defaults to []) the calldata
+- contractPayload.**signature** - (defaults to []) the signature
+
+_abi_ - (optional) the abi of the contract for better displaying
+
 The _transactionsDetail_ object may include any of:
 
 - transactionsDetail.**maxFee** - Max Fee that that will be used to execute the call(s)
 - transactionsDetail.**nonce** - Nonce for the transaction
 - transactionsDetail.**version** - Version for the transaction (default is 1)
 
-###### _AddTransactionResponse_
+###### _InvokeFunctionResponse_
 
 ```typescript
 {
@@ -71,9 +142,79 @@ The _transactionsDetail_ object may include any of:
 
 <hr />
 
+account.**declare**(contractPayload [ , transactionsDetail ]) => _Promise < DeclareContractResponse >_
+
+Declares a given compiled contract (json) to starknet.
+
+The _contractPayload_ object consists of:
+
+- contractPayload.**contract** - The compiled contract
+- contractPayload.**classHash** - Hash of the compiled contract
+
+The _transactionsDetail_ object may include any of:
+
+- transactionsDetail.**maxFee** - Max Fee that that will be used to execute the call(s)
+- transactionsDetail.**nonce** - Nonce for the transaction
+- transactionsDetail.**version** - Version for the transaction (default is 1)
+
+> _Note:_ Once the classHash is included in CompiledContract, this parameter can be removed. Currently it can be pre-computed from starknet-cli.
+
+Example:
+
+```typescript
+const declareTx = await account.declare({
+  contract: compiledErc20,
+  // classHash is pre-computed from starknet-cli
+  classHash: '0x54328a1075b8820eb43caf0caa233923148c983742402dcfc38541dd843d01a',
+});
+```
+
+###### _DeclareContractResponse_
+
+```typescript
+{
+  transaction_hash: string;
+  class_hash: string;
+};
+```
+
+<hr />
+
+account.**deployAccount**(contractPayload [ , transactionsDetail ]) => _Promise < DeployContractResponse >_
+
+Declares a given compiled contract (json) to starknet.
+
+The _contractPayload_ object consists of:
+
+- contractPayload.**classHash** - Hash of the compiled contract
+- contractPayload.**constructorCalldata** - optional
+- contractPayload.**addressSalt** - optional
+- contractPayload.**contractAddress** - optional
+
+The _transactionsDetail_ object may include any of:
+
+- transactionsDetail.**maxFee** - Max Fee that that will be used to execute the call(s)
+- transactionsDetail.**nonce** - Nonce for the transaction
+- transactionsDetail.**version** - Version for the transaction (default is 1)
+
+> _Note:_ Once the classHash is included in CompiledContract, this parameter can be removed. Currently it can be pre-computed from starknet-cli.
+
+###### _DeployContractResponse_
+
+```typescript
+{
+  contract_address: string;
+  transaction_hash: string;
+};
+```
+
+<hr/>
+
 account.**signMessage**(typedData) => _Promise < Signature >_
 
-Creates a signature from the passed data.
+Sign an JSON object for off-chain usage with the starknet private key and return the signature. This adds a message prefix so it cant be interchanged with transactions.
+
+_typedData_ - JSON object to be signed
 
 ###### _Signature_
 
@@ -85,7 +226,11 @@ string[];
 
 account.**hashMessage**(typedData) => _Promise < string >_
 
-Creates a hash from the passed data.
+Hash a JSON object with pederson hash and return the hash. This adds a message prefix so it cant be interchanged with transactions.
+
+_typedData_ - JSON object to be signed
+
+Returns the hash of the JSON object.
 
 <hr />
 
@@ -103,4 +248,18 @@ account.**verifyMessage**(typedData, signature) => _Promise < boolean >_
 
 Verify a signature of a JSON object.
 
+_typedData_ - JSON object to be verified
+_signature_ - signature of the JSON object
+
+Returns true if the signature is valid, false otherwise
+
 <hr />
+
+account.**getSuggestedMaxFee**(estimateFeeAction, details) => _Promise < BigNumberish >_
+
+Gets Suggested Max Fee based on the transaction type.
+
+The _details_ object may include any of:
+
+- details.**blockIdentifier**
+- details.**nonce**

package/www/docs/API/contract.md

@@ -18,6 +18,10 @@ Contracts allow you to transform Cairo values, like `Uint256` to `BigNumber`. It
 
 ## Properties
 
+contract.**abi** => _Abi_
+
+The ABI the contract was constructed with.
+
 contract.**address** => _string_
 
 The address the contract was constructed/connected with.
@@ -30,16 +34,48 @@ contract.**deployTransactionHash** => _string | null_
 
 If the Contract object is the result of a ContractFactory deployment, this is the transaction which was used to deploy the contract.
 
-contract.**abi** => _Abi_
+## Methods
 
-The ABI the contract was constructed with.
+contract.**attach**(address) => void
 
-## Methods
+Saves the address of the contract deployed on network that will be used for interaction.
+
+_address_ - address of the contract.
+
+<br></br>
+
+contract.**connect**(providerOrAccount) => void
+
+Attaches to new Provider or Account
+
+<br></br>
 
 contract.**deployed**() => _Promise < Contract >_
 
 If the Contract object is the result of a ContractFactory deployment, this method will wait for the transaction to be resolved.
 
+<br></br>
+
+contract.**call**(method, args, options) => _Promise < Result >_
+
+Calls a method on a contract.
+
+<br></br>
+
+contract.**invoke**(method, args, options) => _Promise < InvokeFunctionResponse >_
+
+Invokes a method on a contract.
+
+<br></br>
+
+contract.**estimate**(method, args, options) => _Promise < any >_
+
+Estimates a method on a contract.
+
+<br></br>
+
+contract.**populate**(method, args, options) => _Invocation_
+
 ## Meta-Class
 
 A Meta-Class is a Class which has any of its properties determined at run-time. The Contract object uses a Contract's ABI to determine what methods are available, so the following sections describe the generic ways to interact with the properties added at run-time during the Contract constructor.