starknet 4.7.0 → 4.8.0

package/src/utils/hash.ts

@@ -15,7 +15,15 @@ import {
 import { RawCalldata } from '../types/lib';
 import { ec } from './ellipticCurve';
 import { addHexPrefix, buf2hex, removeHexPrefix, utf8ToArray } from './encode';
-import { BigNumberish, toBN, toFelt, toHex } from './number';
+import {
+  BigNumberish,
+  isHex,
+  isStringWholeNumber,
+  toBN,
+  toFelt,
+  toHex,
+  toHexString,
+} from './number';
 
 export const transactionVersion = 1;
 export const feeTransactionVersion = toBN(2).pow(toBN(128)).add(toBN(transactionVersion));
@@ -53,6 +61,21 @@ export function getSelectorFromName(funcName: string) {
   return toHex(starknetKeccak(funcName));
 }
 
+/**
+ * Function to get hex selector from function name, decimal string or hex string
+ * @param value hex string | decimal string | string
+ * @returns Hex selector
+ */
+export function getSelector(value: string) {
+  if (isHex(value)) {
+    return value;
+  }
+  if (isStringWholeNumber(value)) {
+    return toHexString(value);
+  }
+  return getSelectorFromName(value);
+}
+
 const constantPoints = CONSTANT_POINTS.map((coords: string[]) =>
   ec.curve.point(coords[0], coords[1])
 );

package/src/utils/merkle.ts

@@ -1,4 +1,5 @@
 import { pedersen } from './hash';
+import { toBN } from './number';
 
 export class MerkleTree {
   public leaves: string[];
@@ -31,7 +32,7 @@ export class MerkleTree {
   }
 
   static hash(a: string, b: string) {
-    const [aSorted, bSorted] = [a, b].sort();
+    const [aSorted, bSorted] = [toBN(a), toBN(b)].sort((x: any, y: any) => (x.gte(y) ? 1 : -1));
     return pedersen([aSorted, bSorted]);
   }
 

package/src/utils/number.ts

@@ -61,3 +61,30 @@ export function bigNumberishArrayToDecimalStringArray(rawCalldata: BigNumberish[
 export function bigNumberishArrayToHexadecimalStringArray(rawCalldata: BigNumberish[]): string[] {
   return rawCalldata.map((x) => toHex(toBN(x)));
 }
+
+export const isStringWholeNumber = (value: string) => /^\d+$/.test(value);
+export const toHexString = (value: string) => toHex(toBN(value));
+
+export function getDecimalString(value: string) {
+  if (isHex(value)) {
+    return hexToDecimalString(value);
+  }
+  if (isStringWholeNumber(value)) {
+    return value;
+  }
+  throw new Error(`${value} need to be hex-string or whole-number-string`);
+}
+
+export function getHexString(value: string) {
+  if (isHex(value)) {
+    return value;
+  }
+  if (isStringWholeNumber(value)) {
+    return toHexString(value);
+  }
+  throw new Error(`${value} need to be hex-string or whole-number-string`);
+}
+
+export function getHexStringArray(value: Array<string>) {
+  return value.map((el) => getHexString(el));
+}

package/src/utils/responseParser/sequencer.ts

@@ -19,12 +19,9 @@ import { ResponseParser } from '.';
 export class SequencerAPIResponseParser extends ResponseParser {
   public parseGetBlockResponse(res: Sequencer.GetBlockResponse): GetBlockResponse {
     return {
-      timestamp: res.timestamp,
-      block_hash: res.block_hash,
-      block_number: res.block_number,
+      ...res,
       new_root: res.state_root,
       parent_hash: res.parent_block_hash,
-      status: res.status,
       transactions: Object.values(res.transactions)
         .map((value) => 'transaction_hash' in value && value.transaction_hash)
         .filter(Boolean) as Array<string>,
@@ -62,12 +59,20 @@ export class SequencerAPIResponseParser extends ResponseParser {
   ): GetTransactionReceiptResponse {
     return {
       transaction_hash: res.transaction_hash,
-      actual_fee: 'actual_fee' in res ? res.actual_fee : undefined,
       status: res.status,
-      status_data: undefined,
       messages_sent: res.l2_to_l1_messages as any, // TODO: parse
       events: res.events as any,
-      l1_origin_message: undefined,
+      ...('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 && {
+        l1_to_l2_consumed_message: res['l1_to_l2_consumed_message'],
+      }),
+      ...('transaction_failure_reason' in res && {
+        transaction_failure_reason: res.transaction_failure_reason,
+      }),
     };
   }
 

package/types/api/sequencer.d.ts

@@ -15,15 +15,17 @@ export declare type GetContractAddressesResponse = {
     Starknet: string;
     GpsStatementVerifier: string;
 };
-export declare type InvokeFunctionTrace = {
+export declare type FunctionInvocation = {
     caller_address: string;
     contract_address: string;
-    code_address: string;
-    selector: string;
     calldata: RawCalldata;
+    call_type?: string;
+    class_hash?: string;
+    selector?: string;
+    entry_point_type?: EntryPointType;
     result: Array<any>;
     execution_resources: ExecutionResources;
-    internal_call: Array<InvokeFunctionTrace>;
+    internal_calls: Array<FunctionInvocation>;
     events: Array<any>;
     messages: Array<any>;
 };
@@ -40,18 +42,9 @@ export declare type ExecutionResources = {
     n_memory_holes: number;
 };
 export declare type GetTransactionTraceResponse = {
-    function_invocation: {
-        caller_address: string;
-        contract_address: string;
-        code_address: string;
-        selector: string;
-        calldata: RawArgs;
-        result: Array<any>;
-        execution_resources: ExecutionResources;
-        internal_call: Array<any>;
-        events: Array<any>;
-        messages: Array<any>;
-    };
+    validate_invocation?: FunctionInvocation;
+    function_invocation?: FunctionInvocation;
+    fee_transfer_invocation?: FunctionInvocation;
     signature: Signature;
 };
 export declare type RawArgs = {
@@ -60,6 +53,12 @@ export declare type RawArgs = {
         [k: string]: BigNumberish;
     };
 };
+export declare type CallL1Handler = {
+    from_address: string;
+    to_address: string;
+    entry_point_selector: string;
+    payload: Array<string>;
+};
 export declare namespace Sequencer {
     type DeclareTransaction = {
         type: 'DECLARE';
@@ -165,6 +164,7 @@ export declare namespace Sequencer {
         status: Status;
         gas_price: string;
         sequencer_address: string;
+        starknet_version: string;
     };
     type CallContractTransaction = Omit<InvokeFunctionTransaction, 'type' | 'entry_point_type' | 'nonce'> & {
         entry_point_selector: string;
@@ -296,5 +296,10 @@ export declare namespace Sequencer {
             REQUEST: never;
             RESPONSE: any;
         };
+        estimate_message_fee: {
+            QUERY: any;
+            REQUEST: any;
+            RESPONSE: EstimateFeeResponse;
+        };
     };
 }

package/types/provider.d.ts

@@ -13,6 +13,10 @@ export interface GetBlockResponse {
     parent_hash: string;
     status: Status;
     transactions: Array<string>;
+    gas_price?: string;
+    sequencer_address?: string;
+    starknet_version?: string;
+    transaction_receipts?: any;
 }
 export interface GetCodeResponse {
     bytecode: string[];

package/utils/hash.d.ts

@@ -21,6 +21,12 @@ export declare function starknetKeccak(value: string): BN;
  * @returns hex selector of given abi function name
  */
 export declare function getSelectorFromName(funcName: string): string;
+/**
+ * Function to get hex selector from function name, decimal string or hex string
+ * @param value hex string | decimal string | string
+ * @returns Hex selector
+ */
+export declare function getSelector(value: string): string;
 export declare function pedersen(input: [BigNumberish, BigNumberish]): string;
 export declare function computeHashOnElements(data: BigNumberish[]): string;
 export declare function calculateTransactionHashCommon(txHashPrefix: TransactionHashPrefix, version: BigNumberish, contractAddress: BigNumberish, entryPointSelector: BigNumberish, calldata: BigNumberish[], maxFee: BigNumberish, chainId: StarknetChainId, additionalData?: BigNumberish[]): string;

package/utils/hash.js

@@ -28,7 +28,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateContractAddressFromHash = exports.calculateTransactionHash = exports.calculateDeployTransactionHash = exports.calculateTransactionHashCommon = exports.computeHashOnElements = exports.pedersen = exports.getSelectorFromName = exports.starknetKeccak = exports.keccakBn = exports.feeTransactionVersion = exports.transactionVersion = void 0;
+exports.calculateContractAddressFromHash = exports.calculateTransactionHash = exports.calculateDeployTransactionHash = exports.calculateTransactionHashCommon = exports.computeHashOnElements = exports.pedersen = exports.getSelector = exports.getSelectorFromName = exports.starknetKeccak = exports.keccakBn = exports.feeTransactionVersion = exports.transactionVersion = void 0;
 var keccak_1 = require("ethereum-cryptography/keccak");
 var utils_1 = require("ethereum-cryptography/utils");
 var minimalistic_assert_1 = __importDefault(require("minimalistic-assert"));
@@ -70,6 +70,21 @@ function getSelectorFromName(funcName) {
     return (0, number_1.toHex)(starknetKeccak(funcName));
 }
 exports.getSelectorFromName = getSelectorFromName;
+/**
+ * Function to get hex selector from function name, decimal string or hex string
+ * @param value hex string | decimal string | string
+ * @returns Hex selector
+ */
+function getSelector(value) {
+    if ((0, number_1.isHex)(value)) {
+        return value;
+    }
+    if ((0, number_1.isStringWholeNumber)(value)) {
+        return (0, number_1.toHexString)(value);
+    }
+    return getSelectorFromName(value);
+}
+exports.getSelector = getSelector;
 var constantPoints = constants_1.CONSTANT_POINTS.map(function (coords) {
     return ellipticCurve_1.ec.curve.point(coords[0], coords[1]);
 });

package/utils/merkle.js

@@ -27,6 +27,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.proofMerklePath = exports.MerkleTree = void 0;
 var hash_1 = require("./hash");
+var number_1 = require("./number");
 var MerkleTree = /** @class */ (function () {
     function MerkleTree(leafHashes) {
         this.branches = [];
@@ -52,7 +53,7 @@ var MerkleTree = /** @class */ (function () {
         return this.build(newLeaves);
     };
     MerkleTree.hash = function (a, b) {
-        var _a = __read([a, b].sort(), 2), aSorted = _a[0], bSorted = _a[1];
+        var _a = __read([(0, number_1.toBN)(a), (0, number_1.toBN)(b)].sort(function (x, y) { return (x.gte(y) ? 1 : -1); }), 2), aSorted = _a[0], bSorted = _a[1];
         return (0, hash_1.pedersen)([aSorted, bSorted]);
     };
     MerkleTree.prototype.getProof = function (leaf, branch, hashPath) {

package/utils/number.d.ts

@@ -8,3 +8,8 @@ export declare function toFelt(num: BigNumberish): string;
 export declare function assertInRange(input: BigNumberish, lowerBound: BigNumberish, upperBound: BigNumberish, inputName?: string): void;
 export declare function bigNumberishArrayToDecimalStringArray(rawCalldata: BigNumberish[]): string[];
 export declare function bigNumberishArrayToHexadecimalStringArray(rawCalldata: BigNumberish[]): string[];
+export declare const isStringWholeNumber: (value: string) => boolean;
+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[];

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.bigNumberishArrayToHexadecimalStringArray = exports.bigNumberishArrayToDecimalStringArray = exports.assertInRange = exports.toFelt = exports.hexToDecimalString = exports.toHex = exports.toBN = exports.isHex = void 0;
+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");
@@ -80,3 +80,31 @@ function bigNumberishArrayToHexadecimalStringArray(rawCalldata) {
     return rawCalldata.map(function (x) { return toHex(toBN(x)); });
 }
 exports.bigNumberishArrayToHexadecimalStringArray = bigNumberishArrayToHexadecimalStringArray;
+var isStringWholeNumber = function (value) { return /^\d+$/.test(value); };
+exports.isStringWholeNumber = isStringWholeNumber;
+var toHexString = function (value) { return toHex(toBN(value)); };
+exports.toHexString = toHexString;
+function getDecimalString(value) {
+    if (isHex(value)) {
+        return hexToDecimalString(value);
+    }
+    if ((0, exports.isStringWholeNumber)(value)) {
+        return value;
+    }
+    throw new Error("".concat(value, " need to be hex-string or whole-number-string"));
+}
+exports.getDecimalString = getDecimalString;
+function getHexString(value) {
+    if (isHex(value)) {
+        return value;
+    }
+    if ((0, exports.isStringWholeNumber)(value)) {
+        return (0, exports.toHexString)(value);
+    }
+    throw new Error("".concat(value, " need to be hex-string or whole-number-string"));
+}
+exports.getHexString = getHexString;
+function getHexStringArray(value) {
+    return value.map(function (el) { return getHexString(el); });
+}
+exports.getHexStringArray = getHexStringArray;

package/utils/responseParser/sequencer.js

@@ -35,17 +35,9 @@ var SequencerAPIResponseParser = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     SequencerAPIResponseParser.prototype.parseGetBlockResponse = function (res) {
-        return {
-            timestamp: res.timestamp,
-            block_hash: res.block_hash,
-            block_number: res.block_number,
-            new_root: res.state_root,
-            parent_hash: res.parent_block_hash,
-            status: res.status,
-            transactions: Object.values(res.transactions)
+        return __assign(__assign({}, res), { new_root: res.state_root, parent_hash: res.parent_block_hash, transactions: Object.values(res.transactions)
                 .map(function (value) { return 'transaction_hash' in value && value.transaction_hash; })
-                .filter(Boolean),
-        };
+                .filter(Boolean) });
     };
     SequencerAPIResponseParser.prototype.parseGetTransactionResponse = function (res) {
         return {
@@ -66,15 +58,11 @@ var SequencerAPIResponseParser = /** @class */ (function (_super) {
         };
     };
     SequencerAPIResponseParser.prototype.parseGetTransactionReceiptResponse = function (res) {
-        return {
-            transaction_hash: res.transaction_hash,
-            actual_fee: 'actual_fee' in res ? res.actual_fee : undefined,
-            status: res.status,
-            status_data: undefined,
-            messages_sent: res.l2_to_l1_messages,
-            events: res.events,
-            l1_origin_message: undefined,
-        };
+        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 && {
+            l1_to_l2_consumed_message: res['l1_to_l2_consumed_message'],
+        })), ('transaction_failure_reason' in res && {
+            transaction_failure_reason: res.transaction_failure_reason,
+        }));
     };
     SequencerAPIResponseParser.prototype.parseFeeEstimateResponse = function (res) {
         if ('overall_fee' in res) {

package/www/docs/API/provider.md

@@ -271,21 +271,29 @@ Gets the transaction trace from a tx hash.
 
 ```typescript
 {
-  function_invocation: {
+  validate_invocation?: FunctionInvocation;
+  function_invocation?: FunctionInvocation;
+  fee_transfer_invocation?: FunctionInvocation;
+  signature: Signature;
+}
+
+{
+  FunctionInvocation: {
     caller_address: string;
     contract_address: string;
-    code_address: string;
-    selector: string;
     calldata: {
       [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };
     };
+    call_type?: string;
+    class_hash?: string;
+    selector?: string;
+    entry_point_type?: EntryPointType;
     result: Array<any>;
-    execution_resources: any;
-    internal_call: Array<any>;
+    execution_resources: ExecutionResources;
+    internal_calls: Array<FunctionInvocation>;
     events: Array<any>;
     messages: Array<any>;
   };
-  signature: Signature;
 }
 ```
 

package/www/guides/account.md

@@ -45,7 +45,7 @@ const compiledAccount = json.parse(
 
 > **Note**
 >
-> below example uses [Argent's](https://github.com/argentlabs/argent-contracts-starknet/blob/develop/contracts/ArgentAccount.cairo) account contract
+> below example uses [Argent's](https://github.com/argentlabs/argent-contracts-starknet/blob/develop/contracts/account/ArgentAccount.cairo) account contract
 
 ```javascript
 const accountResponse = await defaultProvider.deployContract({