starknet 4.16.0 → 4.17.0

package/www/docs/API/account.md

@@ -24,6 +24,8 @@ The address of the account contract.
 
 ## Methods
 
+### getNonce()
+
 account.**getNonce(blockIdentifier)** => _Promise < BigNumberish >_
 
 Gets the nonce of the account with respect to a specific block.
@@ -32,7 +34,9 @@ _blockIdentifier_ - optional blockIdentifier. Defaults to 'pending'.
 
 Returns the nonce of the account.
 
-<hr />
+---
+
+### estimateInvokeFee()
 
 account.**estimateInvokeFee**(calls [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
 
@@ -59,7 +63,9 @@ The _estimateFeeDetails_ object may include any of:
 }
 ```
 
-<hr />
+---
+
+### estimateDeclareFee()
 
 account.**estimateDeclareFee**(contractPayload [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
 
@@ -85,7 +91,9 @@ The _estimateFeeDetails_ object may include any of:
 }
 ```
 
-<hr />
+---
+
+### estimateAccountDeployFee()
 
 account.**estimateAccountDeployFee**(contractPayload [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
 
@@ -111,7 +119,9 @@ The _estimateFeeDetails_ object may include any of:
 }
 ```
 
-<hr />
+---
+
+### execute()
 
 account.**execute**(transactions [ , abi , transactionsDetail ]) => _Promise < InvokeFunctionResponse >_
 
@@ -140,9 +150,9 @@ The _transactionsDetail_ object may include any of:
 };
 ```
 
-<hr />
+---
 
-### Declare
+### declare()
 
 account.**declare**(contractPayload [ , transactionsDetail ]) => _Promise < DeclareContractResponse >_
 
@@ -180,13 +190,13 @@ const declareTx = await account.declare({
 };
 ```
 
-<hr />
+---
 
-### Deploy
+### deploy()
 
 Deploys a given compiled contract (json) to starknet, wrapper around _execute_ invoke function
 
-**deploy**(deployContractPayload [ , transactionsDetail ]) => _Promise < InvokeFunctionResponse >_
+account.**deploy**(deployContractPayload [ , transactionsDetail ]) => _Promise < InvokeFunctionResponse >_
 
 @param object **_deployContractPayload_**
 
@@ -226,14 +236,14 @@ Example multi-call:
 TODO Example with multi-call
 ```
 
-<hr />
+---
 
-### DeployContract
+### deployContract()
 
 ✅ NEW
 High level wrapper for deploy. Doesn't require waitForTransaction. Response similar to deprecated provider deployContract.
 
-**deployContract**(payload [ , details ]) => _Promise < DeployContractUDCResponse >_
+account.**deployContract**(payload [ , details ]) => _Promise < DeployContractUDCResponse >_
 
 @param object **_payload_** UniversalDeployerContractPayload
 
@@ -273,14 +283,14 @@ Example:
   });
 ```
 
-<hr />
+---
 
-### DeclareDeploy
+### declareDeploy()
 
 ✅ NEW
 High level wrapper for declare & deploy. Doesn't require waitForTransaction. Functionality similar to deprecated provider deployContract. Declare and Deploy contract using single function.
 
-**declareDeploy**(payload [ , details ]) => _Promise < DeclareDeployUDCResponse >_
+account.**declareDeploy**(payload [ , details ]) => _Promise < DeclareDeployUDCResponse >_
 
 @param object **_payload_** DeclareDeployContractPayload
 
@@ -311,7 +321,7 @@ High level wrapper for declare & deploy. Doesn't require waitForTransaction. Fun
   - calldata_len
   - calldata
   - salt
-  <hr />
+  ***
 
 Example:
 
@@ -330,7 +340,9 @@ Example:
   const erc20Address = declareDeploy.deploy.contract_address;
 ```
 
-### deployAccount
+---
+
+### deployAccount()
 
 account.**deployAccount**(contractPayload [ , transactionsDetail ]) => _Promise < DeployContractResponse >_
 
@@ -360,7 +372,9 @@ The _transactionsDetail_ object may include any of:
 };
 ```
 
-<hr/>
+---
+
+### signMessage()
 
 account.**signMessage**(typedData) => _Promise < Signature >_
 
@@ -374,7 +388,9 @@ _typedData_ - JSON object to be signed
 string[];
 ```
 
-<hr />
+---
+
+### hashMessage()
 
 account.**hashMessage**(typedData) => _Promise < string >_
 
@@ -384,7 +400,9 @@ _typedData_ - JSON object to be signed
 
 Returns the hash of the JSON object.
 
-<hr />
+---
+
+### verifyMessageHash()
 
 account.**verifyMessageHash**(hash, signature) => _Promise < boolean >_
 
@@ -394,7 +412,9 @@ Verify a signature of a given hash.
 >
 > This method is not recommended, use `verifyMessage` instead
 
-<hr />
+---
+
+### verifyMessage()
 
 account.**verifyMessage**(typedData, signature) => _Promise < boolean >_
 
@@ -405,7 +425,9 @@ _signature_ - signature of the JSON object
 
 Returns true if the signature is valid, false otherwise
 
-<hr />
+---
+
+### getSuggestedMaxFee()
 
 account.**getSuggestedMaxFee**(estimateFeeAction, details) => _Promise < BigNumberish >_
 
@@ -416,7 +438,9 @@ The _details_ object may include any of:
 - details.**blockIdentifier**
 - details.**nonce**
 
-<hr />
+---
+
+### getStarkName()
 
 account.**getStarkName**(StarknetIdContract) => _Promise<string | Error>_
 
@@ -426,7 +450,9 @@ The _StarknetIdContract_ argument can be undefined, if it is, the function will
 
 Returns directly a string (Example: `vitalik.stark`).
 
-<hr />
+---
+
+### getAddressFromStarkName()
 
 account.**getAddressFromStarkName**(name, StarknetIdContract) => _Promise<string | Error>_
 

package/www/docs/API/contract.md

@@ -36,43 +36,57 @@ If the Contract object is the result of a ContractFactory deployment, this is th
 
 ## Methods
 
+### attach()
+
 contract.**attach**(address) => void
 
 Saves the address of the contract deployed on network that will be used for interaction.
 
 _address_ - address of the contract.
 
-<br></br>
+---
+
+### connect()
 
 contract.**connect**(providerOrAccount) => void
 
 Attaches to new Provider or Account
 
-<br></br>
+---
+
+### deployed()
 
 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>
+---
+
+### call()
 
 contract.**call**(method, args, options) => _Promise < Result >_
 
 Calls a method on a contract.
 
-<br></br>
+---
+
+### invoke()
 
 contract.**invoke**(method, args, options) => _Promise < InvokeFunctionResponse >_
 
 Invokes a method on a contract.
 
-<br></br>
+---
+
+### estimate()
 
 contract.**estimate**(method, args, options) => _Promise < any >_
 
 Estimates a method on a contract.
 
-<br></br>
+---
+
+### populate()
 
 contract.**populate**(method, args, options) => _Invocation_
 

package/www/docs/API/contractFactory.md

@@ -28,14 +28,18 @@ contractFactory.**abi** => _Abi_ (the ABI the contractFactory was constructed wi
 
 ## Methods
 
+### attach()
+
 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 _account_ passed in when creating the ContractFactory.
 
-<hr />
+---
+
+### deploy()
 
-contractFactory.**deploy**( constructorCalldata, addressSalt ) ⇒ _Promise < Contract >_
+contractFactory.**deploy**( args, 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.
+Uses the provider to deploy the Contract with _args_ 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.

package/www/docs/API/provider.md

@@ -57,13 +57,15 @@ These are also the default options for the Provider constructor with `network: '
 
 ### Methods
 
-<hr/>
+#### getChainId()
 
 provider.**getChainId**() => _Promise < StarknetChainId >_
 
 Returns the chain Id for the current network.
 
-<hr/>
+---
+
+#### callContract()
 
 provider.**callContract**(call [ , blockIdentifier ]) => _Promise < CallContractResponse >_
 
@@ -83,7 +85,9 @@ The call object structure:
 }
 ```
 
-<hr/>
+---
+
+#### getBlock()
 
 provider.**getBlock**(blockIdentifier) => _Promise < GetBlockResponse >_
 
@@ -107,7 +111,9 @@ Gets the block information.
 }
 ```
 
-<hr/>
+---
+
+#### getClassAt()
 
 provider.**getClassAt**(contractAddress, blockIdentifier) => _Promise < ContractClass >_
 
@@ -123,7 +129,9 @@ Gets the contract class of the deployed contract.
 }
 ```
 
-<hr/>
+---
+
+#### getInvokeEstimateFee()
 
 provider.**getInvokeEstimateFee**(invocationWithTxType, invocationDetails, blockIdentifier) => _Promise < EstimateFeeResponse >_
 
@@ -139,19 +147,25 @@ Estimate fee for invoke transaction.
 }
 ```
 
-<hr/>
+---
+
+#### getNonceForAddress()
 
 provider.**getNonceForAddress**(contractAddress, blockIdentifier) => _Promise < BigNumberish >_
 
 Gets the nonce of the provided contractAddress. This was renamed from `getNonce` to `getNonceForAddress` to avoid confusion when inheriting an Account from the Provider class.
 
-<hr/>
+---
+
+#### getStorageAt()
 
 provider.**getStorageAt**(contractAddress, key, blockIdentifier) => _Promise < string >_
 
 Gets the contract's storage variable at a specific key.
 
-<hr/>
+---
+
+#### getTransactionReceipt()
 
 provider.**getTransactionReceipt**(txHash) => _Promise < GetTransactionReceiptResponse >_
 
@@ -171,7 +185,9 @@ Gets the status of a transaction.
 }
 ```
 
-<hr/>
+---
+
+#### getTransaction()
 
 provider.**getTransaction**(txHash) => _Promise < GetTransactionResponse >_
 
@@ -194,7 +210,9 @@ Gets the transaction information from a tx hash.
 }
 ```
 
-<hr/>
+---
+
+#### declareContract()
 
 provider.**declareContract**(transaction, details) => _Promise < DeclareContractResponse >_
 
@@ -209,7 +227,9 @@ Declare a contract on Starknet.
 };
 ```
 
-<hr/>
+---
+
+#### getDeclareEstimateFee()
 
 provider.**getDeclareEstimateFee**(transaction, details, blockIdentifier) => _Promise < EstimateFeeResponse >_
 
@@ -225,9 +245,9 @@ Estimate fee for declare transaction.
 };
 ```
 
-<hr/>
+---
 
-### waitForTransaction
+#### waitForTransaction()
 
 provider.**waitForTransaction**(txHash [ , retryInterval]) => _Promise < GetTransactionReceiptResponse >_
 
@@ -265,7 +285,9 @@ const provider = new starknet.SequencerProvider({
 
 ### Methods
 
-<hr/>
+---
+
+#### getContractAddresses()
 
 provider.**getContractAddresses**() => _Promise < GetContractAddressesResponse >_
 
@@ -280,7 +302,9 @@ Gets the smart contract address on the network.
 }
 ```
 
-<hr/>
+---
+
+#### getCode()
 
 provider.**getCode**(contractAddress, blockIdentifier) => _Promise < GetCodeResponse >_
 
@@ -295,7 +319,9 @@ Gets the smart contract address on the network.
 }
 ```
 
-<hr/>
+---
+
+#### estimateMessageFee()
 
 provider.**estimateMessageFee**(CallL1Handler, blockIdentifier) => _Promise < EstimateFeeResponse >_
 
@@ -322,7 +348,9 @@ type CallL1Handler = {
 }
 ````
 
-<hr/>
+---
+
+#### getTransactionStatus()
 
 provider.**getTransactionStatus**(txHash) => _Promise < GetTransactionStatusResponse >_
 
@@ -342,7 +370,9 @@ Gets the status of a transaction.
 }
 ```
 
-<hr/>
+---
+
+#### getTransactionTrace()
 
 provider.**getTransactionTrace**(txHash) => _Promise < GetTransactionTraceResponse >_
 
@@ -399,21 +429,29 @@ const provider = new starknet.RpcProvider({
 
 ### Methods
 
-<hr/>
+---
+
+#### fetch()
 
 provider.**fetch**(method: any, params: any) => _Promise < any >_
 
 Generic method for users to be able to experiment with RPC methods.
 
-<hr/>
+---
+
+#### getChainId()
 
 provider.**getChainId**() => _Promise < any >_
 
-<hr/>
+---
+
+#### getBlock()
 
 provider.**getBlock**(blockIdentifier) => _Promise < GetBlockResponse >_
 
-<hr/>
+---
+
+#### getBlockHashAndNumber()
 
 provider.**getBlockHashAndNumber**() => _Promise < BlockHashAndNumber >_
 
@@ -426,7 +464,9 @@ provider.**getBlockHashAndNumber**() => _Promise < BlockHashAndNumber >_
 }
 ```
 
-<hr/>
+---
+
+#### getBlockWithTxHashes()
 
 provider.**getBlockWithTxHashes**(blockIdentifier) => _Promise < GetBlockWithTxHashesResponse >_
 
@@ -436,7 +476,9 @@ provider.**getBlockWithTxHashes**(blockIdentifier) => _Promise < GetBlockWithTxH
 OPENRPC.BlockWithTxHashes
 ```
 
-<hr/>
+---
+
+#### getBlockWithTxs()
 
 provider.**getBlockWithTxs**(blockIdentifier) => _Promise < GetBlockWithTxs >_
 
@@ -446,23 +488,31 @@ provider.**getBlockWithTxs**(blockIdentifier) => _Promise < GetBlockWithTxs >_
 OPENRPC.BlockWithTxs
 ```
 
-<hr/>
+---
+
+#### getClassHashAt()
 
 provider.**getClassHashAt**(blockIdentifier) => _Promise < ContractAddress >_
 
-<hr/>
+---
+
+#### getTransactionCount()
 
 provider.**getTransactionCount**(blockIdentifier) => _Promise < number >_
 
 Gets the transaction count from a block.
 
-<hr/>
+---
+
+#### getBlockNumber()
 
 provider.**getBlockNumber**() => _Promise < number >_
 
 Gets the latest block number.
 
-<hr/>
+---
+
+#### getPendingTransactions()
 
 provider.**getPendingTransactions**() => _Promise < PendingTransactions >_
 
@@ -472,7 +522,9 @@ provider.**getPendingTransactions**() => _Promise < PendingTransactions >_
 OPENRPC.PendingTransactions;
 ```
 
-<hr/>
+---
+
+#### getStateUpdate()
 
 provider.**getStateUpdate**(blockIdentifier) => _Promise < StateUpdate >_
 
@@ -482,15 +534,21 @@ provider.**getStateUpdate**(blockIdentifier) => _Promise < StateUpdate >_
 OPENRPC.StateUpdate;
 ```
 
-<hr/>
+---
+
+#### getStorageAt()
 
 provider.**getStorageAt**(contractAddress, key, blockIdentifier) => _Promise < BigNumberish >_
 
-<hr/>
+---
+
+#### getTransaction()
 
 provider.**getTransaction**(txHash) => _Promise < GetTransactionResponse >_
 
-<hr/>
+---
+
+#### getTransactionByHash()
 
 provider.**getTransactionByHash**(txHash) => _Promise < GetTransactionByHashResponse >_
 
@@ -500,7 +558,9 @@ provider.**getTransactionByHash**(txHash) => _Promise < GetTransactionByHashResp
 OPENRPC.Transaction;
 ```
 
-<hr/>
+---
+
+#### getTransactionByBlockIdAndIndex()
 
 provider.**getTransactionByBlockIdAndIndex**(blockIdentifier, index) => _Promise < GetTransactionByBlockIdAndIndex >_
 
@@ -510,11 +570,15 @@ provider.**getTransactionByBlockIdAndIndex**(blockIdentifier, index) => _Promise
 OPENRPC.Transaction;
 ```
 
-<hr/>
+---
+
+#### getTransactionReceipt()
 
 provider.**getTransactionReceipt**(txHash) => _Promise < GetTransactionReceiptResponse >_
 
-<hr/>
+---
+
+#### getClass()
 
 provider.**getClass**(classHash) => _Promise < ContractClass >_
 
@@ -524,7 +588,9 @@ provider.**getClass**(classHash) => _Promise < ContractClass >_
 OPENRPC.ContractClass;
 ```
 
-<hr/>
+---
+
+#### getClassAt()
 
 provider.**getClassAt**(contractAddress, blockIdentifier) => _Promise < ContractClass >_
 
@@ -534,7 +600,9 @@ provider.**getClassAt**(contractAddress, blockIdentifier) => _Promise < Contract
 OPENRPC.ContractClass;
 ```
 
-<hr/>
+---
+
+#### getInvokeEstimateFee()
 
 provider.**getInvokeEstimateFee**(invocation, invocationDetails, blockIdentifier) => _Promise < EstimateFeeResponse >_
 
@@ -546,7 +614,9 @@ provider.**getInvokeEstimateFee**(invocation, invocationDetails, blockIdentifier
   gas_price?: BN;
 ```
 
-<hr/>
+---
+
+#### getDeclareEstimateFee()
 
 provider.**getDeclareEstimateFee**(DeclareContractTransaction, details, blockIdentifier) => _Promise < EstimateFeeResponse >_
 
@@ -558,7 +628,9 @@ provider.**getDeclareEstimateFee**(DeclareContractTransaction, details, blockIde
   gas_price?: BN;
 ```
 
-<hr/>
+---
+
+#### declareContract()
 
 provider.**declareContract**(DeclareContractTransaction, details) => _Promise < DeclareContractResponse >_
 
@@ -569,11 +641,15 @@ provider.**declareContract**(DeclareContractTransaction, details) => _Promise <
   class_hash: string;
 ```
 
-<hr/>
+---
+
+#### callContract()
 
 provider.**callContract**(call, blockIdentifier) => _Promise < CallContractResponse >_
 
-<hr/>
+---
+
+#### getContractAddresses()
 
 provider.**traceTransaction**(transactionHash) => _Promise < Trace >_
 
@@ -583,7 +659,9 @@ provider.**traceTransaction**(transactionHash) => _Promise < Trace >_
 OPENRPC.Trace;
 ```
 
-<hr/>
+---
+
+#### traceBlockTransactions()
 
 provider.**traceBlockTransactions**(blockHash) => _Promise < Traces >_
 
@@ -593,7 +671,9 @@ provider.**traceBlockTransactions**(blockHash) => _Promise < Traces >_
 OPENRPC.Traces;
 ```
 
-<hr/>
+---
+
+#### getSyncingStats()
 
 provider.**getSyncingStats**() => _Promise < GetSyncingStatsResponse >_
 
@@ -613,7 +693,9 @@ boolean |
 }
 ```
 
-<hr/>
+---
+
+#### getEvents()
 
 provider.**getEvents**(eventFilter) => _Promise < GetEventsResponse >_