starknet 5.28.0 → 5.29.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [5.29.0](https://github.com/starknet-io/starknet.js/compare/v5.28.0...v5.29.0) (2024-02-02)
+
+### Features
+
+- add provider.decodeParameters ([39595f3](https://github.com/starknet-io/starknet.js/commit/39595f3303204b273fadd53764c59767ce6c5b36))
+
 # [5.28.0](https://github.com/starknet-io/starknet.js/compare/v5.27.0...v5.28.0) (2024-02-01)
 
 ### Features

package/dist/index.d.ts

@@ -143,15 +143,15 @@ declare enum NetworkName {
     SN_SEPOLIA = "SN_SEPOLIA"
 }
 declare enum StarknetChainId {
-    SN_MAIN = "0x534e5f4d41494e",
-    SN_GOERLI = "0x534e5f474f45524c49",
+    SN_MAIN = "0x534e5f4d41494e",// encodeShortString('SN_MAIN'),
+    SN_GOERLI = "0x534e5f474f45524c49",// encodeShortString('SN_GOERLI')
     SN_SEPOLIA = "0x534e5f5345504f4c4941"
 }
 declare enum TransactionHashPrefix {
-    DECLARE = "0x6465636c617265",
-    DEPLOY = "0x6465706c6f79",
-    DEPLOY_ACCOUNT = "0x6465706c6f795f6163636f756e74",
-    INVOKE = "0x696e766f6b65",
+    DECLARE = "0x6465636c617265",// encodeShortString('declare'),
+    DEPLOY = "0x6465706c6f79",// encodeShortString('deploy'),
+    DEPLOY_ACCOUNT = "0x6465706c6f795f6163636f756e74",// encodeShortString('deploy_account'),
+    INVOKE = "0x696e766f6b65",// encodeShortString('invoke'),
     L1_HANDLER = "0x6c315f68616e646c6572"
 }
 declare const UDC: {
@@ -5404,6 +5404,17 @@ declare class CallData {
      * @returns HexCalldata
      */
     static toHex(raw?: RawArgs): HexCalldata;
+    /**
+     * Parse the elements of a contract response and structure them into one or several Result.
+     * In Cairo 0, arrays are not supported.
+     * @param typeCairo string or string[] - Cairo type name, ex : "hello::hello::UserData"
+     * @param response string[] - serialized data corresponding to typeCairo.
+     * @return Result or Result[] - parsed response corresponding to typeData.
+     * @example
+     * const res2=helloCallData.decodeParameters("hello::hello::UserData",["0x123456","0x1"]);
+     * result = { address: 1193046n, is_claimed: true }
+     */
+    decodeParameters(typeCairo: AllowArray<string>, response: string[]): AllowArray<Result>;
 }
 
 declare function isSierra(contract: CairoContract | string): contract is SierraContractClass | CompiledSierra;

package/dist/index.global.js

@@ -5366,6 +5366,29 @@ var starknet = (() => {
       const calldata = CallData.compile(raw);
       return calldata.map((it) => toHex(it));
     }
+    /**
+     * Parse the elements of a contract response and structure them into one or several Result.
+     * In Cairo 0, arrays are not supported.
+     * @param typeCairo string or string[] - Cairo type name, ex : "hello::hello::UserData"
+     * @param response string[] - serialized data corresponding to typeCairo.
+     * @return Result or Result[] - parsed response corresponding to typeData.
+     * @example
+     * const res2=helloCallData.decodeParameters("hello::hello::UserData",["0x123456","0x1"]);
+     * result = { address: 1193046n, is_claimed: true }
+     */
+    decodeParameters(typeCairo, response) {
+      const typeCairoArray = Array.isArray(typeCairo) ? typeCairo : [typeCairo];
+      const responseIterator = response.flat()[Symbol.iterator]();
+      const decodedArray = typeCairoArray.map(
+        (typeParam) => responseParser(
+          responseIterator,
+          { name: "", type: typeParam },
+          this.structs,
+          this.enums
+        )
+      );
+      return decodedArray.length === 1 ? decodedArray[0] : decodedArray;
+    }
   };
 
   // src/utils/hash.ts