starknet 4.8.0 → 4.10.0

package/www/docs/API/provider.md

@@ -8,7 +8,9 @@ The **Provider** API allows you to interact with the StarkNet network, without s
 
 Typically, these are _read_ calls on the blockchain.
 
-## Creating an instance
+## Default Provider
+
+### Creating an instance
 
 `new starknet.Provider(optionsOrProvider)`
 
@@ -53,7 +55,13 @@ These are also the default options for the Provider constructor with `network: '
 >
 > `network` arguement should work in most cases. If you want to use the `sequencer` arguement with `baseUrl`, you will not be able to use the `network` field in the object.
 
-## Methods
+### Methods
+
+<hr/>
+
+provider.**getChainId**() => _Promise < StarknetChainId >_
+
+Returns the chain Id for the current network.
 
 <hr/>
 
@@ -117,6 +125,28 @@ Gets the contract class of the deployed contract.
 
 <hr/>
 
+provider.**getInvokeEstimateFee**(invocationWithTxType, invocationDetails, blockIdentifier) => _Promise < EstimateFeeResponse >_
+
+Estimate fee for invoke transaction.
+
+###### _EstimateFeeResponse_
+
+```typescript
+{
+  overall_fee: BN;
+  gas_consumed?: BN;
+  gas_price?: BN;
+}
+```
+
+<hr/>
+
+provider.**getNonce**(contractAddress, blockIdentifier) => _Promise < BigNumberish >_
+
+Gets the nonce of the provided contractAddress.
+
+<hr/>
+
 provider.**getStorageAt**(contractAddress, key, blockIdentifier) => _Promise < string >_
 
 Gets the contract's storage variable at a specific key.
@@ -166,9 +196,24 @@ Gets the transaction information from a tx hash.
 
 <hr/>
 
-provider.**declareContract**(payload) => _Promise < DeclareContractResponse >_
+provider.**deployContract**(payload [ , abi ]) => _Promise < DeployContractResponse >_
+
+Deploys a contract on Starknet.
+
+###### _DeployContractResponse_
+
+```typescript
+{
+  transaction_hash: string;
+  contract_address: string;
+};
+```
+
+<hr/>
+
+provider.**declareContract**(transaction, details) => _Promise < DeclareContractResponse >_
 
-Declares a contract on Starknet.
+Declare a contract on Starknet.
 
 ###### _DeclareContractResponse_
 
@@ -181,16 +226,17 @@ Declares a contract on Starknet.
 
 <hr/>
 
-provider.**deployContract**(payload [ , abi ]) => _Promise < DeployContractResponse >_
+provider.**getDeclareEstimateFee**(transaction, details, blockIdentifier) => _Promise < EstimateFeeResponse >_
 
-Deploys a contract on Starknet.
+Estimate fee for declare transaction.
 
-###### _DeployContractResponse_
+###### _EstimateFeeResponse_
 
 ```typescript
 {
-  transaction_hash: string;
-  contract_address?: string;
+  overall_fee: BN;
+  gas_consumed?: BN;
+  gas_price?: BN;
 };
 ```
 
@@ -200,9 +246,11 @@ provider.**waitForTransaction**(txHash [ , retryInterval]) => _Promise < void >_
 
 Wait for the transaction to be accepted on L2 or L1.
 
-# SequencerProvider
+## SequencerProvider
+
+On top of methods found in the [Default Provider](#default-provider) section, `SequencerProvider` has some additional ones you can use.
 
-## Creating an instance
+### Creating an instance
 
 `new starknet.SequencerProvider(optionsOrProvider)`
 
@@ -211,27 +259,31 @@ 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:
 
 ```typescript
-const provider = new starknet.Provider({
+const provider = new starknet.SequencerProvider({
   baseUrl: 'https://alpha4.starknet.io',
   feederGatewayUrl: 'feeder_gateway',
   gatewayUrl: 'gateway',
 })
 ```
 
-## Methods
+### Methods
 
-Gets the smart contract address on the network.
+<hr/>
 
 provider.**getContractAddresses**() => _Promise < GetContractAddressesResponse >_
 
+Gets the smart contract address on the network.
+
 ###### _GetContractAddressesResponse_
 
 ```typescript
@@ -243,6 +295,48 @@ provider.**getContractAddresses**() => _Promise < GetContractAddressesResponse >
 
 <hr/>
 
+provider.**getCode**(contractAddress, blockIdentifier) => _Promise < GetCodeResponse >_
+
+Gets the smart contract address on the network.
+
+###### _GetCodeResponse_
+
+```typescript
+{
+  bytecode: string[];
+  abi: Abi;
+}
+```
+
+<hr/>
+
+provider.**estimateMessageFee**(CallL1Handler, blockIdentifier) => _Promise < EstimateFeeResponse >_
+
+Estimate fee for sending a message to L1.
+
+##### _CallL1Handler_
+
+````typescript
+type CallL1Handler = {
+  from_address: getDecimalString(from_address),
+  to_address: getHexString(to_address),
+  entry_point_selector: getSelector(entry_point_selector),
+  payload: getHexStringArray(payload),
+};
+
+###### _EstimateFeeResponse_
+
+```typescript
+{
+  overall_fee: number;
+  gas_price: number;
+  gas_usage: number;
+  unit: string;
+}
+````
+
+<hr/>
+
 provider.**getTransactionStatus**(txHash) => _Promise < GetTransactionStatusResponse >_
 
 Gets the status of a transaction.
@@ -297,13 +391,15 @@ Gets the transaction trace from a tx hash.
 }
 ```
 
-# RpcProvider
+## RpcProvider
 
-## Creating an instance
+### Creating an instance
 
 `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:
 
@@ -313,7 +409,60 @@ const provider = new starknet.RpcProvider({
 })
 ```
 
-## Methods
+### Methods
+
+<hr/>
+
+provider.**fetch**(method: any, params: any) => _Promise < any >_
+
+Generic method for users to be able to experiment with RPC methods.
+
+<hr/>
+
+provider.**getChainId**() => _Promise < any >_
+
+<hr/>
+
+provider.**getBlock**(blockIdentifier) => _Promise < GetBlockResponse >_
+
+<hr/>
+
+provider.**getBlockHashAndNumber**() => _Promise < BlockHashAndNumber >_
+
+###### _BlockHashAndNumber_
+
+```typescript
+{
+  block_hash: BLOCK_HASH;
+  block_number: BLOCK_NUMBER;
+}
+```
+
+<hr/>
+
+provider.**getBlockWithTxHashes**(blockIdentifier) => _Promise < GetBlockWithTxHashesResponse >_
+
+###### _GetBlockWithTxHashesResponse_
+
+```typescript
+OPENRPC.BlockWithTxHashes
+```
+
+<hr/>
+
+provider.**getBlockWithTxs**(blockIdentifier) => _Promise < GetBlockWithTxs >_
+
+###### _GetBlockWithTxs_
+
+```typescript
+OPENRPC.BlockWithTxs
+```
+
+<hr/>
+
+provider.**getClassHashAt**(blockIdentifier) => _Promise < ContractAddress >_
+
+<hr/>
 
 provider.**getTransactionCount**(blockIdentifier) => _Promise < number >_
 
@@ -333,6 +482,148 @@ Gets the nonce of the provided contractAddress
 
 <hr/>
 
+provider.**getPendingTransactions**() => _Promise < PendingTransactions >_
+
+###### _PendingTransactions_
+
+```typescript
+OPENRPC.PendingTransactions;
+```
+
+<hr/>
+
+provider.**getStateUpdate**(blockIdentifier) => _Promise < StateUpdate >_
+
+###### _StateUpdate_
+
+```typescript
+OPENRPC.StateUpdate;
+```
+
+<hr/>
+
+provider.**getStorageAt**(contractAddress, key, blockIdentifier) => _Promise < BigNumberish >_
+
+<hr/>
+
+provider.**getTransaction**(txHash) => _Promise < GetTransactionResponse >_
+
+<hr/>
+
+provider.**getTransactionByHash**(txHash) => _Promise < GetTransactionByHashResponse >_
+
+###### _GetTransactionByHashResponse_
+
+```typescript
+OPENRPC.Transaction;
+```
+
+<hr/>
+
+provider.**getTransactionByBlockIdAndIndex**(blockIdentifier, index) => _Promise < GetTransactionByBlockIdAndIndex >_
+
+###### _GetTransactionByBlockIdAndIndex_
+
+```typescript
+OPENRPC.Transaction;
+```
+
+<hr/>
+
+provider.**getTransactionReceipt**(txHash) => _Promise < GetTransactionReceiptResponse >_
+
+<hr/>
+
+provider.**getClass**(classHash) => _Promise < ContractClass >_
+
+###### _ContractClass_
+
+```typescript
+OPENRPC.ContractClass;
+```
+
+<hr/>
+
+provider.**getClassAt**(contractAddress, blockIdentifier) => _Promise < ContractClass >_
+
+###### _ContractClass_
+
+```typescript
+OPENRPC.ContractClass;
+```
+
+<hr/>
+
+provider.**getInvokeEstimateFee**(invocation, invocationDetails, blockIdentifier) => _Promise < EstimateFeeResponse >_
+
+###### _EstimateFeeResponse_
+
+```typescript
+  overall_fee: BN;
+  gas_consumed?: BN;
+  gas_price?: BN;
+```
+
+<hr/>
+
+provider.**getDeclareEstimateFee**(DeclareContractTransaction, details, blockIdentifier) => _Promise < EstimateFeeResponse >_
+
+###### _EstimateFeeResponse_
+
+```typescript
+  overall_fee: BN;
+  gas_consumed?: BN;
+  gas_price?: BN;
+```
+
+<hr/>
+
+provider.**declareContract**(DeclareContractTransaction, details) => _Promise < DeclareContractResponse >_
+
+###### _DeclareContractResponse_
+
+```typescript
+  transaction_hash: string;
+  class_hash: string;
+```
+
+<hr/>
+
+provider.**deployContract**(contract, constructorCalldata, addressSalt) => _Promise < DeployContractResponse >_
+
+###### _DeployContractResponse_
+
+```typescript
+  contract_address: string;
+  transaction_hash: string;
+```
+
+<hr/>
+
+provider.**callContract**(call, blockIdentifier) => _Promise < CallContractResponse >_
+
+<hr/>
+
+provider.**traceTransaction**(transactionHash) => _Promise < Trace >_
+
+###### _Trace_
+
+```typescript
+OPENRPC.Trace;
+```
+
+<hr/>
+
+provider.**traceBlockTransactions**(blockHash) => _Promise < Traces >_
+
+###### _Traces_
+
+```typescript
+OPENRPC.Traces;
+```
+
+<hr/>
+
 provider.**getSyncingStats**() => _Promise < GetSyncingStatsResponse >_
 
 Gets syncing status of the node.
@@ -355,6 +646,8 @@ boolean |
 
 provider.**getEvents**(eventFilter) => _Promise < GetEventsResponse >_
 
+Gets all the events filtered
+
 ##### _EventFilter_
 
 ```typescript

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_
 

package/www/guides/erc20.md

@@ -12,11 +12,17 @@ const compiledErc20 = json.parse(
 );
 const erc20Response = await defaultProvider.deployContract({
   contract: compiledErc20,
+  constructorCalldata: [encodeShortString('TokenName'), encodeShortString('TokenSymbol'), recipient], // Here the `recipient` receives the initial 1000 tokens
 });
+
 console.log("Waiting for Tx to be Accepted on Starknet - ERC20 Deployment...");
 await defaultProvider.waitForTransaction(erc20Response.transaction_hash);
 ```
 
+> **Note**
+>
+> The ERC20 contract can be found [here](https://github.com/argentlabs/argent-contracts-starknet/blob/develop/contracts/lib/ERC20.cairo)
+
 ## Get the erc20 contract address and create the contact object
 
 ```javascript
@@ -35,7 +41,7 @@ erc20.connect(account);
 
 const { transaction_hash: mintTxHash } = await erc20.mint(
   account.address,
-  "1000",
+ [ "1000", "0"]
   {
     maxFee: "1"
   }
@@ -59,11 +65,11 @@ await defaultProvider.waitForTransaction(mintTxHash);
 
 ```javascript
 console.log(`Calling StarkNet for account balance...`);
-const balanceBeforeTransfer = await erc20.balance_of(account.address);
+const balanceBeforeTransfer = await erc20.balanceOf(account.address);
 
 console.log(
   `account Address ${account.address} has a balance of:`,
-  number.toBN(balanceBeforeTransfer.res, 16).toString()
+  number.toBN(balanceBeforeTransfer.balance.low, 16).toString()
 );
 ```
 
@@ -76,7 +82,7 @@ const { transaction_hash: transferTxHash } = await account.execute(
   {
     contractAddress: erc20Address,
     entrypoint: "transfer",
-    calldata: [erc20Address, "10"],
+    calldata: [erc20Address, "10", "0"],
   },
   undefined,
   { maxFee: "1" }
@@ -90,12 +96,12 @@ await defaultProvider.waitForTransaction(transferTxHash);
 ## Check balance after transfer
 
 ```javascript
-// Check balance after transfer - should be 990
+// Check balance after transfer - should be 1990 (1000 initial supply + 1000 mint - 10 transfer)
 console.log(`Calling StarkNet for account balance...`);
-const balanceAfterTransfer = await erc20.balance_of(account.address);
+const balanceAfterTransfer = await erc20.balanceOf(account.address);
 
 console.log(
   `account Address ${account.address} has a balance of:`,
-  number.toBN(balanceAfterTransfer.res, 16).toString()
+  number.toBN(balanceAfterTransfer.balance.low, 16).toString()
 );
 ```