Skip to content

Commit

Permalink
fix: typos (#666)
Browse files Browse the repository at this point in the history 
Co-authored-by: Antonio <aug@matterlabs.dev>
  • Loading branch information
@omahs @uF4No
omahs and uF4No committed Aug 17, 2023
1 parent 4ff2857 commit 7fa239b
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/api/java/accounts-l1-l2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This section explores the methods which allow the [account](./accounts.md) classes to send transactions from L1 to L2.

If you want to some background on how L1->L2 interaction works on zkSync Era, go through the [L1 / L2 interoperability doc](../../reference/concepts/l1-l2-interop.md).
If you want some background on how L1->L2 interaction works on zkSync Era, go through the [L1 / L2 interoperability doc](../../reference/concepts/l1-l2-interop.md).

## EthereumProvider

Expand Down
2 changes: 1 addition & 1 deletion docs/api/java/getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1050,7 +1050,7 @@ public class Main {
}
```

#### Get price of the transaction execution (currently not wokring properly)
#### Get price of the transaction execution (currently not working properly)

::: warning
Feature currently unsupported. Under development
Expand Down
12 changes: 6 additions & 6 deletions docs/api/js/accounts-l1-l2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,10 @@ async finalizeWithdrawal(withdrawalHash: BytesLike, index: number = 0): Promise<

#### Inputs and outputs

| Name | Description |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| withdrawalHash | Hash of the L2 transaction where the withdrawal was initiated. |
| index? | In case there where multiple withdrawals in one transaction, you may pass an index of the withdrawal you want to finalize (defaults to 0). |
| Name | Description |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| withdrawalHash | Hash of the L2 transaction where the withdrawal was initiated. |
| index? | In case there were multiple withdrawals in one transaction, you may pass an index of the withdrawal you want to finalize (defaults to 0). |

## Force-executing transactions on L2

Expand All @@ -150,7 +150,7 @@ async getBaseCost(params: {

| Name | Description |
| ------------------------ | ------------------------------------------------------------------------------------- |
| params.gasLimit | The `gasLimit` for the the L2 contract call. |
| params.gasLimit | The `gasLimit` for the L2 contract call. |
| params.gasPerPubdataByte | The L2 gas price for each published L1 calldata byte. |
| params.gasPrice? | The L1 gas price of the L1 transaction that will send the request for an execute call |
| returns | The base cost in ETH for requesting the L2 contract call. |
Expand Down Expand Up @@ -217,7 +217,7 @@ const wallet = new Wallet(PRIVATE_KEY, zkSyncProvider, ethereumProvider);
const gasPrice = await wallet.providerL1.getGasPrice();

// The calldata can be encoded the same way as for Ethereum.
// Here is an example on how to get the calldata from an ABI:
// Here is an example of how to get the calldata from an ABI:
const abi = [
{
inputs: [],
Expand Down
2 changes: 1 addition & 1 deletion docs/api/js/front-end.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This section describes how to make the most of zkSync to provide the best UX.

## Going to production rightaway
## Going to production right away

If your front-end code does not deploy new smart contracts, then no changes to the codebase are required! All the existing SDKs/infrastructure will work out-of-box.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/js/getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ const withdrawL2 = await zkSyncWallet.withdraw({
});
```

Assets will be withdrawn to the target wallet(if do not define the `to` address in the `withdraw` method's argument - the sender address will be chosen as a destination) after the validity proof of the zkSync block with this transaction is enerated and verified by the mainnet contract.
Assets will be withdrawn to the target wallet(if do not define the `to` address in the `withdraw` method's argument - the sender address will be chosen as a destination) after the validity proof of the zkSync block with this transaction is generated and verified by the mainnet contract.

It is possible to wait until the validity proof verification is complete:

Expand Down
2 changes: 1 addition & 1 deletion docs/api/js/providers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -557,7 +557,7 @@ console.log(await provider.getTestnetPaymasterAddress());
- This method is deprecated and will be removed in the near future.
:::

Returns the USD price for a token. Please note that that this is the price that is used by the zkSync team and can be a bit different from the current market price. On testnets, token prices can be very different from the actual market price.
Returns the USD price for a token. Please note that this is the price that is used by the zkSync team and can be a bit different from the current market price. On testnets, token prices can be very different from the actual market price.

Calls the [`zks_getTokenPrice`](../api.md#zks-gettokenprice) JSON-RPC method.

Expand Down
10 changes: 5 additions & 5 deletions docs/api/python/accounts.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Accounts: overview

The zkSync Python SDK has a method that generates a signature and a method that verify messages.
The zkSync Python SDK has a method that generates a signature and a method that verifies messages.

- `sign_typed_data` : used to sign EIP712-typed zkSync transactions.
- `verify_typed_data` : used to verify the signed EIP712-typed zkSync transactions.
Expand Down Expand Up @@ -47,7 +47,7 @@ It's used to verify the provided transaction, whose signature is added to the fi

The signer class also has the following properties:

| Attribute | Description |
| --------- | --------------------------------------------------------------------------------- |
| address | Account address |
| domain | Domain that is used to generate signature. It's depends on `chain_id` of network. |
| Attribute | Description |
| --------- | ------------------------------------------------------------------------------- |
| address | Account address |
| domain | Domain that is used to generate signature. It depends on `chain_id` of network. |
18 changes: 9 additions & 9 deletions docs/api/python/contracts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ Methods:

### ERC20Contract

This is system contract that is used internally as a part of the implementation methods of `EthereumProvider`<br>
This is a system contract that is used internally as a part of the implementation methods of `EthereumProvider`<br>

More interested type include the `ERC20FunctionEncoder`. it's used to provide method encoding in the case of sending non-native tokens inside the network.
A more interesting type includes the `ERC20FunctionEncoder`. It's used to provide method encoding in the case of sending non-native tokens inside the network.

Construction needs only Web3 object with appended zksync module(ZkSyncBuilder)

It has only 1 single method: `python encode_method` with arguments of function name, and it's args
It has only 1 single method: `python encode_method` with arguments of function name, and its args

### ContractDeployer

Expand All @@ -64,9 +64,9 @@ deployer = ContractDeployer(zksync_web3)

**Parameter and Methods:**

| Method | Parameters | Return value | Description |
| -------------------------- | ------------------------------------------ | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| encode_create | bytecode, optional `call_data` & `salt` | HexStr | Creates binary representation of a contract in an internal deploying format.<br/> bytecode - contract binary representation, `call_data` is used for `ctor` bytecode only, `salt` is used to generate unique identifier of deploying contract. |
| encode_create2 | bytecode, optional `call_data` & `salt` | HexStr | Creates binary representation of contract in an internal deploying format.<br/> bytecode - contract binary representation, `call_data` is used for `ctor` bytecode only, `salt` is used to generate unique identifier of deploying contract. |
| compute_l2_create_address | Address, Nonce | Address | Accepts address of deployer and current deployed nonce and returns address of contract that is going to be deployed by the`encode_create` method. |
| compute_l2_create2_address | Address, bytecode, `ctor` bytecode, `salt` | Address | Accepts address of the deployer, binary representation of contract, it's constructor in binary format and salt. By default constructor can be `b'0'` value. It returns the address of the contract that is going to be deployed by an`encode_create2` method. |
| Method | Parameters | Return value | Description |
| -------------------------- | ------------------------------------------ | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| encode_create | bytecode, optional `call_data` & `salt` | HexStr | Creates binary representation of a contract in an internal deploying format.<br/> bytecode - contract binary representation, `call_data` is used for `ctor` bytecode only, `salt` is used to generate unique identifier of deploying contract. |
| encode_create2 | bytecode, optional `call_data` & `salt` | HexStr | Creates binary representation of contract in an internal deploying format.<br/> bytecode - contract binary representation, `call_data` is used for `ctor` bytecode only, `salt` is used to generate unique identifier of deploying contract. |
| compute_l2_create_address | Address, Nonce | Address | Accepts address of deployer and current deployed nonce and returns address of contract that is going to be deployed by the`encode_create` method. |
| compute_l2_create2_address | Address, bytecode, `ctor` bytecode, `salt` | Address | Accepts address of the deployer, binary representation of contract, its constructor in binary format and salt. By default constructor can be `b'0'` value. It returns the address of the contract that is going to be deployed by an`encode_create2` method. |

0 comments on commit 7fa239b

Please sign in to comment.