starknet 4.9.0 → 4.11.0

package/www/docs/API/account.md

@@ -24,20 +24,56 @@ 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.**estimateInvokeFee**(calls [ , options ]) => _Promise < EstimateFeeResponse >_
+account.**estimateDeclareFee**(contractPayload [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
+
+Estimate Fee for executing a DECLARE 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
+- 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,14 +87,19 @@ The _options_ object may include any of:
 
 <hr />
 
-account.**estimateDeclareFee**(contractPayload [ , 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 declare transaction.
+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_
 
@@ -72,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
 {
@@ -92,12 +142,14 @@ The _transactionsDetail_ object may include any of:
 
 <hr />
 
-account.**declare**(payload [ , transactionsDetail ]) => _Promise < DeclareContractResponse >_
+account.**declare**(contractPayload [ , transactionsDetail ]) => _Promise < DeclareContractResponse >_
 
-The _payload_ object consists of:
+Declares a given compiled contract (json) to starknet.
 
-- payload.**contract** - The compiled contract
-- payload.**classHash** - Hash of the compiled contract
+The _contractPayload_ object consists of:
+
+- contractPayload.**contract** - The compiled contract
+- contractPayload.**classHash** - Hash of the compiled contract
 
 The _transactionsDetail_ object may include any of:
 
@@ -105,8 +157,6 @@ The _transactionsDetail_ object may include any of:
 - transactionsDetail.**nonce** - Nonce for the transaction
 - transactionsDetail.**version** - Version for the transaction (default is 1)
 
-Declares a contract on Starknet.
-
 > _Note:_ Once the classHash is included in CompiledContract, this parameter can be removed. Currently it can be pre-computed from starknet-cli.
 
 Example:
@@ -128,11 +178,43 @@ const declareTx = await account.declare({
 };
 ```
 
+<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_
 
@@ -144,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 />
 
@@ -162,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.

package/www/docs/API/provider.md

@@ -259,10 +259,12 @@ The options for the provider depend on the network. The structure of the options
 - options.**baseUrl** - Base URL of the network
 - options.**feederGatewayUrl** - Feeder Gateway Endpoint of the network
 - options.**gatewayUrl** - Gateway Endpoint
+- options.**headers** - [Optional] custom fetch headers
 
 or
 
 - options.**network** - Either 'mainnet-alpha' or 'goerli-alpha'
+- options.**headers** - [Optional] custom fetch headers
 
 Example:
 
@@ -396,6 +398,8 @@ Gets the transaction trace from a tx hash.
 `new starknet.RpcProvider(options)`
 
 - options.**nodeUrl** - Starknet RPC node url
+- options.**headers** - [Optional] custom fetch headers
+- options.**retries** - [Optional] wait for transaction max retries
 
 Example:
 

package/www/docs/API/signer.md

@@ -20,7 +20,15 @@ Returns the public key of the signer.
 
 signer.**signTransaction**(transactions, transactionsDetail [ , abi ]) => _Promise < Signature >_
 
-Returns the signature of the transaction.
+Signs a transaction with the starknet private key and returns the signature.
+
+The _transactions_ object for write methods may include any of:
+
+- transactions.**contractAddress** - the address of the contract
+- transactions.**entrypoint** - the entrypoint of the contract
+- transactions.**calldata** - (defaults to []) the calldata
+
+_abi_ - (optional) the abi of the contract for better displaying
 
 ###### _Signature_
 
@@ -32,7 +40,53 @@ string[]
 
 signer.**signMessage**(typedData, accountAddress) => _Promise < Signature >_
 
-Returns the signature of the transaction.
+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
+_accountAddress_ - calldata to be passed in deploy constructor
+
+###### _Signature_
+
+```typescript
+string[]
+```
+
+<hr />
+
+signer.**signDeployAccountTransaction**(transaction) => _Promise < Signature >_
+
+Signs a DEPLOY_ACCOUNT transaction with the starknet private key and returns the signature.
+
+The _transactions_ object for write methods may include any of:
+
+- transactions.**contractAddress** - the address of the contract
+- transactions.**constructorCalldata** - calldata to be passed in deploy constructor
+- transactions.**addressSalt** - contract address salt
+- transactions.**chainId** - the chainId to declare contract on
+- transactions.**maxFee** - maxFee for the declare transaction
+- transactions.**version** - transaction version
+- transactions.**nonce** - Nonce of the declare transaction
+
+###### _Signature_
+
+```typescript
+string[]
+```
+
+<hr />
+
+signer.**signDeclareTransaction**(transaction, transactionsDetail [ , abi ]) => _Promise < Signature >_
+
+Signs a DECLARE transaction with the starknet private key and returns the signature.
+
+The _transaction_ object for write methods may include any of:
+
+- transactions.**classHash** - computed class hash. Will be replaced by ContractClass in future once class hash is present in CompiledContract
+- transactions.**senderAddress** - the address of the sender
+- transactions.**chainId** - the chainId to declare contract on
+- transactions.**maxFee** - maxFee for the declare transaction
+- transactions.**version** - transaction version
+- transactions.**nonce** - Nonce of the declare transaction
 
 ###### _Signature_