Skip to content

Commit

Permalink
docs(README): brand update
Browse files Browse the repository at this point in the history
  • Loading branch information
danijelTxFusion committed Jul 24, 2024
1 parent 36695fa commit 63e544d
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@

[![ZKsync Era Logo](logo.svg)](https://zksync.io/)

In order to provide easy access to all the features of zkSync Era, the `zksync-ethers` JavaScript SDK was created,
In order to provide easy access to all the features of ZKsync Era, the `zksync-ethers` JavaScript SDK was created,
which is made in a way that has an interface very similar to those of [ethers](https://docs.ethers.io/v6/). In
fact, `ethers` is a peer dependency of our library and most of the objects exported by `zksync-ethers` (
e.g. `Wallet`, `Provider` etc.) inherit from the corresponding `ethers` objects and override only the fields that need
to be changed.

While most of the existing SDKs should work out of the box, deploying smart contracts or using unique zkSync features,
While most of the existing SDKs should work out of the box, deploying smart contracts or using unique ZKsync features,
like account abstraction, requires providing additional fields to those that Ethereum transactions have by default.

The library is made in such a way that after replacing `ethers` with `zksync-ethers` most client apps will work out of
Expand All @@ -27,7 +27,7 @@ box.

To begin, it is useful to have a basic understanding of the types of objects available and what they are responsible for, at a high level:

- `Provider` provides connection to the zkSync Era blockchain, which allows querying the blockchain state, such as account, block or transaction details,
- `Provider` provides connection to the ZKsync Era blockchain, which allows querying the blockchain state, such as account, block or transaction details,
querying event logs or evaluating read-only code using call. Additionally, the client facilitates writing to the blockchain by sending
transactions.
- `Wallet` wraps all operations that interact with an account. An account generally has a private key, which can be used to sign a variety of
Expand All @@ -41,21 +41,21 @@ To begin, it is useful to have a basic understanding of the types of objects ava
## 📥 Installation & Setup

```bash
yarn add zksync-ethers
yarn add zksync-ethers@5
yarn add ethers@5 # ethers is a peer dependency of zksync-ethers
```

## 📝 Examples

The complete examples with various use cases are available [here](https://github.com/zksync-sdk/zksync2-examples/tree/main/js).

### Connect to the zkSync Era network:
### Connect to the ZKsync Era network:

```ts
import { Provider, utils, types } from "zksync-ethers";
import { ethers } from "ethers";

const provider = Provider.getDefaultProvider(types.Network.Sepolia); // zkSync Era testnet (L2)
const provider = Provider.getDefaultProvider(types.Network.Sepolia); // ZKsync Era testnet (L2)
const ethProvider = ethers.getDefaultProvider("sepolia"); // sepolia testnet (L1)
```

Expand All @@ -81,7 +81,7 @@ const wallet = new Wallet(PRIVATE_KEY, provider, ethProvider);
### Check account balances

```ts
const ethBalance = await wallet.getBalance(); // balance on zkSync Era network
const ethBalance = await wallet.getBalance(); // balance on ZKsync Era network

const ethBalanceL1 = await wallet.getBalanceL1(); // balance on Sepolia network
```
Expand Down

0 comments on commit 63e544d

Please sign in to comment.