starknet 4.1.0 → 4.3.1

package/www/docs/API/account.md

@@ -12,36 +12,36 @@ This API is the primary way to interact with an account contract on StarkNet.
 
 ## Creating an instance
 
-For creating new instance of Account, account contract must be deployed. Also there needs to be a Provider instance that will be passed in the constructor and key pair for the account.
+To create a new instance of the Account, first an account contract must be deployed. Also there needs to be a Provider instance that will be passed in the constructor and key pair for the account.
 
 `new starknet.Account(Provider, address, starkKeyPair)`
 
-## Account Properties
+## Properties
 
 account.**address** => _string_
 
-The address of the account contract
+The address of the account contract.
 
-## Account methods
+## Methods
 
 account.**getNonce()** => _Promise < string >_
 
-Gets new Nonce for the next transaction
+Gets the new Nonce for the next transaction.
 
 <hr />
 
 account.**estimateFee**(calls [ , options ]) => _Promise < EstimateFeeResponse >_
 
-Gets the estimated fee for the call(s)
+Gets the estimated fee for the call(s).
 
 The _options_ object may include any of:
 
 - options.**blockIdentifier** - Block Identifier for the transaction
 - options.**nonce** - Nonce for the transaction
 
-###### EstimateFeeResponse
+###### _EstimateFeeResponse_
 
-```
+```typescript
 {
   overall_fee: BN;
   gas_consumed?: BN;
@@ -53,7 +53,7 @@ The _options_ object may include any of:
 
 account.**execute**(calls [ , abi , transactionsDetail ]) => _Promise < AddTransactionResponse >_
 
-Executes one or multiple calls using the account contract
+Executes one or multiple calls using the account contract.
 
 The _transactionsDetail_ object may include any of:
 
@@ -61,9 +61,9 @@ The _transactionsDetail_ object may include any of:
 - transactionsDetail.**nonce** - Nonce for the transaction
 - transactionsDetail.**version** - Version for the transaction (default is 0)
 
-###### AddTransactionResponse
+###### _AddTransactionResponse_
 
-```
+```typescript
 {
   transaction_hash: string;
 };
@@ -73,11 +73,11 @@ The _transactionsDetail_ object may include any of:
 
 account.**signMessage**(typedData) => _Promise < Signature >_
 
-Creates a signature from the passed data
+Creates a signature from the passed data.
 
-###### Signature
+###### _Signature_
 
-```
+```typescript
 string[];
 ```
 
@@ -85,20 +85,22 @@ string[];
 
 account.**hashMessage**(typedData) => _Promise < string >_
 
-Creates a hash from the passed data
+Creates a hash from the passed data.
 
 <hr />
 
 account.**verifyMessageHash**(hash, signature) => _Promise < boolean >_
 
-Verify a signature of a given hash
+Verify a signature of a given hash.
 
-**WARNING** This method is not recommended, use verifyMessage instead
+> **WARNING**
+>
+> This method is not recommended, use `verifyMessage` instead
 
 <hr />
 
 account.**verifyMessage**(typedData, signature) => _Promise < boolean >_
 
-Verify a signature of a JSON object
+Verify a signature of a JSON object.
 
 <hr />

package/www/docs/API/contract.md

@@ -12,19 +12,19 @@ Contracts allow you to transform Cairo values, like `Uint256` to `BigNumber`. It
 
 `new starknet.Contract(abi, address, providerOrAccount)`
 
-`contract.attach(providerOrAccount)` _for changing the provider or account_
+`contract.attach(address)` _for changing the address of the connected contract_
 
-`contract.connect(address)` _for changing the address of the connected contract_
+`contract.connect(providerOrAccount)` _for changing the provider or account_
 
-## Contract properties
+## Properties
 
 contract.**address** => _string_
 
-The address the contract was constructed/connected with
+The address the contract was constructed/connected with.
 
 contract.**providerOrAccount** => _ProviderInterface | AccountInterface_
 
-Provider or account that are used to interact with the network
+Provider or account that are used to interact with the network.
 
 contract.**deployTransactionHash** => _string | null_
 
@@ -32,9 +32,9 @@ If the Contract object is the result of a ContractFactory deployment, this is th
 
 contract.**abi** => _Abi_
 
-The ABI the contract was constructed with
+The ABI the contract was constructed with.
 
-## Contract methods
+## Methods
 
 contract.**deployed**() => _Promise < Contract >_
 
@@ -46,13 +46,13 @@ A Meta-Class is a Class which has any of its properties determined at run-time.
 
 ### Read-Only Methods(constant)
 
-A constant method (denoted view in Cairo) is read-only and evaluates a small amount of EVM code against the current blockchain state. It is therefore free and does not require any fee, but cannot make changes to the blockchain state...
+A constant method (denoted view in Cairo) is read-only and evaluates a small amount of Cairo code against the current blockchain state. It is therefore free and does not require any fee, but cannot make changes to the blockchain state...
 
 contract.**METHOD_NAME**(...args [ , overrides ]) => _Promise < Result >_
 
 The type of the result depends on the ABI. Result object will be returned with each parameter available positionally and if the parameter is named, it will also be available by its name.
 
-The _overrides_ object for a read-only method may include any of:
+The _overrides_ object for a read-only method may include:
 
 - overrides.**blockIdentifier**
 
@@ -62,7 +62,7 @@ A non-constant method requires a transaction to be signed and requires payment i
 
 contract.**METHOD_NAME**(...args [ , overrides ]) => _Promise < AddTransactionResponse >_
 
-Returns a AddTransactionResponse for the transaction after it is sent to the network. This requires the Contract has a signer.
+Returns a _AddTransactionResponse_ for the transaction after it is sent to the network. This requires that Contract has a signer.
 
 The _overrides_ object for write methods may include any of:
 

package/www/docs/API/contractFactory.md

@@ -4,7 +4,7 @@ sidebar_position: 5
 
 # Contract Factory
 
-Contract Factory allow you to deploy contracts onto StarkNet. To deploy a Contract, additional information is needed that is not available on a Contract object itself.
+Contract Factory allow you to deploy contracts to StarkNet. To deploy a Contract, additional information is needed that is not available on a Contract object itself.
 
 ## Creating an instance
 
@@ -18,25 +18,28 @@ Creates a new instance of a ContractFactory for the contract described by the _c
 
 ## Properties
 
-contractFactory.**abi** => _Abi_;
+contractFactory.**abi** => _Abi_
 
-The ABI the contractFactory was constructed with
+The ABI the contractFactory was constructed with.
 
-contractFactory.**compiledContract** => _CompiledContract_;
+contractFactory.**compiledContract** => _CompiledContract_
 
-The compiled contract the contractFactory was constructed with
+The compiled contract the contractFactory was constructed with.
 
-contractFactory.**providerOrAccount** => _ProviderInterface | AccountInterface_;
+contractFactory.**providerOrAccount** => _ProviderInterface | AccountInterface_
 
-Provider or account that are used to interact with the network
+Provider or account that are used to interact with the network.
 
 ## Methods
 
 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 _providerOrAccount_ passed in when creating the ContractFactory.
+Return an instance of a _Contract_ attached to address. This is the same as using the _Contract_ constructor with address and this _compiledContract_ and _providerOrAccount_ passed in when creating the ContractFactory.
 
-contractFactory.deploy( constructorCalldata, 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.
+<hr />
 
-The transaction hash can be found at contract.deployTransactionHash, and no interactions should be made until the transaction is resolved.
+contractFactory.**deploy**( constructorCalldata, 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.
+
+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

@@ -4,7 +4,7 @@ sidebar_position: 1
 
 # Provider
 
-The **Provider** API allows you to interface with the StarkNet network, without signing transactions or messages.
+The **Provider** API allows you to interact with the StarkNet network, without signing transactions or messages.
 
 Typically, these are _read_ calls on the blockchain.
 
@@ -12,14 +12,32 @@ Typically, these are _read_ calls on the blockchain.
 
 `new starknet.Provider(optionsOrProvider)`
 
-The options for the provider depends from the network. The structure of the options object is:
+The options for the provider depend on the network. The structure of the options object is:
 
 - options.**sequencer** - Options for sequencer provider
 - options.**rpc** - Options for RPC provider
 
-Example:
+The easiest way to get started is:
+
+```typescript
+const provider = new starknet.Provider()
+```
+
+The above snippet creates a Starknet Provider instance with `goerli-alpha` network.
 
+However, if you want to use `mainnet-alpha` or explicitly declare the network, you can use:
+
+```typescript
+const provider = new starknet.Provider({
+  sequencer: {
+    network: 'mainnet-alpha' // or 'goerli-alpha'
+  }
+})
 ```
+
+If you want more control:
+
+```typescript
 const provider = new starknet.Provider({
   sequencer: {
     baseUrl: 'https://alpha4.starknet.io',
@@ -29,7 +47,11 @@ const provider = new starknet.Provider({
 })
 ```
 
-**This is also default options for the constructor for the **testnet\*\*\*
+These are also the default options for the Provider constructor with `network: 'goerli-alpha'`.
+
+> **Note**
+>
+> `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
 
@@ -43,13 +65,13 @@ The call object structure:
 
 - call.**contractAddress** - Address of the contract
 - call.**entrypoint** - Entrypoint of the call (method name)
-- call.**calldata** - Payload for the invoking the method
+- call.**calldata** - Payload for the invoking method
 
-###### CallContractResponse
+###### _CallContractResponse_
 
-```
+```typescript
 {
-    result: string[];
+  result: string[];
 }
 ```
 
@@ -61,7 +83,7 @@ Gets the block information.
 
 ###### _GetBlockResponse_
 
-```
+```typescript
 {
   accepted_time: number;
   block_hash: string;
@@ -85,7 +107,7 @@ Gets the contract class of the deployed contract.
 
 ###### _ContractClass_
 
-```
+```typescript
 {
   program: CompressedProgram;
   entry_points_by_type: EntryPointsByType;
@@ -95,9 +117,9 @@ Gets the contract class of the deployed contract.
 
 <hr/>
 
-provider.**getStorageAt**(contractAddress, key, blockHashOrTag) => _Promise < string >_
+provider.**getStorageAt**(contractAddress, key, blockIdentifier) => _Promise < string >_
 
-Gets the contract's storage variable at a specific key
+Gets the contract's storage variable at a specific key.
 
 <hr/>
 
@@ -107,7 +129,7 @@ Gets the status of a transaction.
 
 ###### _GetTransactionReceiptResponse_
 
-```
+```typescript
 {
   transaction_hash: string;
   status: 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
@@ -127,7 +149,7 @@ Gets the transaction information from a tx hash.
 
 ###### _GetTransactionResponse_
 
-```
+```typescript
 {
   transaction_hash: string;
   version?: string;
@@ -146,27 +168,26 @@ Gets the transaction information from a tx hash.
 
 provider.**declareContract**(payload) => _Promise < DeclareContractResponse >_
 
-Declares a contract on Starknet
+Declares a contract on Starknet.
 
 ###### _DeclareContractResponse_
 
-```
+```typescript
 {
   transaction_hash: string;
   class_hash: string;
 };
+```
 
 <hr/>
 
-```
-
 provider.**deployContract**(payload [ , abi ]) => _Promise < DeployContractResponse >_
 
-Deploys a contract on Starknet
+Deploys a contract on Starknet.
 
 ###### _DeployContractResponse_
 
-```
+```typescript
 {
   transaction_hash: string;
   contract_address?: string;
@@ -185,7 +206,7 @@ Wait for the transaction to be accepted on L2 or L1.
 
 `new starknet.SequencerProvider(optionsOrProvider)`
 
-The options for the provider depends from the network. The structure of the options object is:
+The options for the provider depend on the network. The structure of the options object is:
 
 - options.**baseUrl** - Base URL of the network
 - options.**feederGatewayUrl** - Feeder Gateway Endpoint of the network
@@ -193,11 +214,11 @@ The options for the provider depends from the network. The structure of the opti
 
 or
 
-- options.**network** - One of 'mainnet-alpha' or 'goerli-alpha'
+- options.**network** - Either 'mainnet-alpha' or 'goerli-alpha'
 
 Example:
 
-```
+```typescript
 const provider = new starknet.Provider({
   baseUrl: 'https://alpha4.starknet.io',
   feederGatewayUrl: 'feeder_gateway',
@@ -207,11 +228,13 @@ const provider = new starknet.Provider({
 
 ## Methods
 
-Gets the smart contract address on the network
+Gets the smart contract address on the network.
 
 provider.**getContractAddresses**() => _Promise < GetContractAddressesResponse >_
 
-```
+###### _GetContractAddressesResponse_
+
+```typescript
 {
   Starknet: string;
   GpsStatementVerifier: string;
@@ -226,7 +249,7 @@ Gets the status of a transaction.
 
 ###### _GetTransactionStatusResponse_
 
-```
+```typescript
 {
   tx_status: 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
   block_hash: string;
@@ -246,7 +269,7 @@ Gets the transaction trace from a tx hash.
 
 ###### _GetTransactionTraceResponse_
 
-```
+```typescript
 {
   function_invocation: {
     caller_address: string;
@@ -254,7 +277,7 @@ Gets the transaction trace from a tx hash.
     code_address: string;
     selector: string;
     calldata: {
-        [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };
+      [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };
     };
     result: Array<any>;
     execution_resources: any;
@@ -276,7 +299,7 @@ Gets the transaction trace from a tx hash.
 
 Example:
 
-```
+```typescript
 const provider = new starknet.RpcProvider({
   nodeUrl: 'URL_TO_STARKNET_RPC_NODE',
 })
@@ -292,17 +315,17 @@ Gets the transaction count from a block.
 
 provider.**getBlockNumber**() => _Promise < number >_
 
-Gets the latest block number
+Gets the latest block number.
 
 <hr/>
 
 provider.**getSyncingStats**() => _Promise < GetSyncingStatsResponse >_
 
-Gets syncing status of the node
+Gets syncing status of the node.
 
-###### GetSyncingStatsResponse
+###### _GetSyncingStatsResponse_
 
-```
+```typescript
 boolean |
 {
   starting_block_hash: string;
@@ -318,9 +341,9 @@ boolean |
 
 provider.**getEvents**(eventFilter) => _Promise < GetEventsResponse >_
 
-##### EventFilter
+##### _EventFilter_
 
-```
+```typescript
 type EventFilter = {
   fromBlock: string;
   toBlock: string;
@@ -331,9 +354,9 @@ type EventFilter = {
 };
 ```
 
-###### GetSyncingStatsResponse
+###### _GetEventsResponse_
 
-```
+```typescript
 {
   events: StarknetEmittedEvent[];
   page_number: number;

package/www/docs/API/signer.md

@@ -10,21 +10,21 @@ The **Signer** API allows you to sign transactions and messages, and also allows
 
 `new starknet.Signer(keyPair)`
 
-## Signer Methods
+## Methods
 
 signer.**getPubKey**() => _Promise < string >_
 
-Returns public key of the signer
+Returns the public key of the signer.
 
 <hr />
 
 signer.**signTransaction**(transactions, transactionsDetail [ , abi ]) => _Promise < Signature >_
 
-Returns signature of the transaction
+Returns the signature of the transaction.
 
-###### Signature
+###### _Signature_
 
-```
+```typescript
 string[]
 ```
 
@@ -32,12 +32,10 @@ string[]
 
 signer.**signMessage**(typedData, accountAddress) => _Promise < Signature >_
 
-Returns signature of the transaction
+Returns the signature of the transaction.
 
-###### Signature
+###### _Signature_
 
-```
+```typescript
 string[]
 ```
-
-<hr />