starknet 5.24.2 → 5.24.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,15 @@
1
+ ## [5.24.4](https://github.com/starknet-io/starknet.js/compare/v5.24.3...v5.24.4) (2023-12-06)
2
+
3
+ ### Bug Fixes
4
+
5
+ - typos ([#862](https://github.com/starknet-io/starknet.js/issues/862)) ([b2431d3](https://github.com/starknet-io/starknet.js/commit/b2431d36d636821b32403ef0aa4def2312b10254))
6
+
7
+ ## [5.24.3](https://github.com/starknet-io/starknet.js/compare/v5.24.2...v5.24.3) (2023-11-20)
8
+
9
+ ### Bug Fixes
10
+
11
+ - correct syncing type ([41f9d8a](https://github.com/starknet-io/starknet.js/commit/41f9d8a0d1b69c569e7a3aa55cec09f105c32356))
12
+
1
13
  ## [5.24.2](https://github.com/starknet-io/starknet.js/compare/v5.24.1...v5.24.2) (2023-11-17)
2
14
 
3
15
  ### Bug Fixes
package/dist/index.d.ts CHANGED
@@ -1651,7 +1651,7 @@ type BlockTransactionsTraces = {
1651
1651
  transaction_hash: FELT;
1652
1652
  trace_root: TRANSACTION_TRACE;
1653
1653
  }[];
1654
- type Syncing = boolean | SYNC_STATUS;
1654
+ type Syncing = false | SYNC_STATUS;
1655
1655
  type Events = EVENTS_CHUNK;
1656
1656
  type InvokedTransaction = {
1657
1657
  transaction_hash: TXN_HASH;
@@ -3802,56 +3802,59 @@ declare abstract class SignerInterface {
3802
3802
  /**
3803
3803
  * Method to get the public key of the signer
3804
3804
  *
3805
- * @returns public key of signer as hex string with 0x prefix
3805
+ * @returns format: hex-string
3806
3806
  */
3807
3807
  abstract getPubKey(): Promise<string>;
3808
3808
  /**
3809
- * Sign an JSON object for off-chain usage with the starknet private key and return the signature
3810
- * This adds a message prefix so it cant be interchanged with transactions
3809
+ * Signs a JSON object for off-chain usage with the Starknet private key and returns the signature
3810
+ * This adds a message prefix so it can't be interchanged with transactions
3811
3811
  *
3812
3812
  * @param typedData - JSON object to be signed
3813
- * @param accountAddress - account
3814
- * @returns the signature of the JSON object
3815
- * @throws {Error} if the JSON object is not a valid JSON
3813
+ * @param accountAddress
3816
3814
  */
3817
3815
  abstract signMessage(typedData: TypedData, accountAddress: string): Promise<Signature>;
3818
3816
  /**
3819
- * Signs a transaction with the starknet private key and returns the signature
3820
- *
3821
- * @param invocation the invocation object containing:
3822
- * - contractAddress - the address of the contract
3823
- * - entrypoint - the entrypoint of the contract
3824
- * - calldata - (defaults to []) the calldata
3825
- * @param abi (optional) the abi of the contract for better displaying
3817
+ * Signs transactions with the Starknet private key and returns the signature
3826
3818
  *
3827
- * @returns signature
3819
+ * @param transactions - Array of Call objects, each including:<br/>
3820
+ * - contractAddress<br/>
3821
+ * - entrypoint<br/>
3822
+ * - calldata<br/>
3823
+ * @param transactionsDetail - InvocationsSignerDetails object with:<br/>
3824
+ * - walletAddress<br/>
3825
+ * - chainId<br/>
3826
+ * - cairoVersion<br/>
3827
+ * - maxFee<br/>
3828
+ * - version<br/>
3829
+ * - nonce<br/>
3830
+ * @param abis - (optional) An array of Abi objects for displaying decoded data
3828
3831
  */
3829
3832
  abstract signTransaction(transactions: Call[], transactionsDetail: InvocationsSignerDetails, abis?: Abi[]): Promise<Signature>;
3830
3833
  /**
3831
- * Signs a DEPLOY_ACCOUNT transaction with the starknet private key and returns the signature
3834
+ * Signs a DEPLOY_ACCOUNT transaction with the Starknet private key and returns the signature
3832
3835
  *
3833
- * @param transaction
3834
- * - contractAddress - the computed address of the contract
3835
- * - constructorCalldata - calldata to be passed in deploy constructor
3836
- * - addressSalt - contract address salt
3837
- * - chainId - the chainId to declare contract on
3838
- * - maxFee - maxFee for the declare transaction
3839
- * - version - transaction version
3840
- * - nonce - Nonce of the declare transaction
3841
- * @returns signature
3836
+ * @param transaction<br/>
3837
+ * - contractAddress<br/>
3838
+ * - chainId<br/>
3839
+ * - classHash<br/>
3840
+ * - constructorCalldata<br/>
3841
+ * - addressSalt<br/>
3842
+ * - maxFee<br/>
3843
+ * - version<br/>
3844
+ * - nonce<br/>
3842
3845
  */
3843
3846
  abstract signDeployAccountTransaction(transaction: DeployAccountSignerDetails): Promise<Signature>;
3844
3847
  /**
3845
- * Signs a DECLARE transaction with the starknet private key and returns the signature
3848
+ * Signs a DECLARE transaction with the Starknet private key and returns the signature
3846
3849
  *
3847
- * @param transaction
3848
- * - classHash - computed class hash. Will be replaced by ContractClass in future once class hash is present in CompiledContract
3849
- * - senderAddress - the address of the sender
3850
- * - chainId - the chainId to declare contract on
3851
- * - maxFee - maxFee for the declare transaction
3852
- * - version - transaction version
3853
- * - nonce - Nonce of the declare transaction
3854
- * @returns signature
3850
+ * @param transaction<br/>
3851
+ * - classHash<br/>
3852
+ * - compiledClassHash? - used for Cairo1<br/>
3853
+ * - senderAddress<br/>
3854
+ * - chainId<br/>
3855
+ * - maxFee<br/>
3856
+ * - version<br/>
3857
+ * - nonce<br/>
3855
3858
  */
3856
3859
  abstract signDeclareTransaction(transaction: DeclareSignerDetails): Promise<Signature>;
3857
3860
  }
@@ -4939,7 +4939,7 @@ var starknet = (() => {
4939
4939
  if (input.type === "core::starknet::eth_address::EthAddress") {
4940
4940
  assert(
4941
4941
  typeof parameter !== "object",
4942
- `EthAdress type is waiting a BigNumberish. Got ${parameter}`
4942
+ `EthAddress type is waiting a BigNumberish. Got ${parameter}`
4943
4943
  );
4944
4944
  const param = BigInt(parameter.toString(10));
4945
4945
  assert(