Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix typos and cleanup the texts. #331

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/berps/content/learn/tokens/bgt.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Berachain Governance Token (`$BGT`) is a soulbound <a target="_blank" :href="con

## How Does Berps Use $BGT

Berps is a native Berachain dApp that is an elligible reward vault for validators to distribute `$BGT` emissions to.
Berps is a native Berachain dApp that is an eligible reward vault for validators to distribute `$BGT` emissions to.

## How Do I Get $BGT?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ If templated correctly, we should see the following structure:
└── Counter.t.sol
```

Now that all the code has been setup, install the dependencies needed for an ERC20 contract from [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts), by funning the following:
Now that all the code has been setup, install the dependencies needed for an ERC20 contract from [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts), by running the following:

```bash
# FROM: ./create-erc20-contract-using-foundry
Expand Down Expand Up @@ -110,7 +110,7 @@ contract BingBongToken is ERC20 {
}
```

Confirm that this compiles correctly by running the following:
Confirm that this compile correctly by running the following:

```bash
# FROM: ./create-erc20-contract-using-foundry
Expand Down Expand Up @@ -165,7 +165,7 @@ forge compile;

With our newly renamed `BingBongToken.t.sol` file, add the following tests that cover a wide range of ERC20 tests.

Feel free to look at each individual test to get a better idea on how revert and successful scenarios are handled.
Feel free to look at each individual test to get a better idea on how reverts and successful scenarios are handled.

**File:** `./test/BingBongToken.t.sol`

Expand Down Expand Up @@ -400,15 +400,15 @@ forge test -vvv; # v stands for verbose and multiple vvv allow for more details

## Configuring Foundry for Berachain Contract Deployment

Now that the code and tests have all be defined, the next step is to create the deployment script needed to deploy the `BingBongToken.sol` file. To accomplish this, simply repurpose the script file `Course.s.sol` file as our new `BingBongToken.s.sol`.
Now that the code and tests have all been defined, the next step is to create the deployment script needed to deploy the `BingBongToken.sol` file. To accomplish this, simply repurpose the script file `Course.s.sol` file as our new `BingBongToken.s.sol`.

```bash
# FROM: ./create-erc20-contract-using-foundry

mv script/Counter.s.sol script/BingBongToken.s.sol;
```

Next, replace the existing code the following to handle importing the wallet private key, and deploying the contract.
Next, replace the existing code the following to handle importing the wallet's private key, and deploying the contract.

**File:** `./script/BingBongToken.s.sol`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,15 +161,15 @@ pnpm compile; # npm run compile or yarn run compil;

## Testing the HelloWorld Contract

Now that we have our contract, let's make sure it's working correctly by writting some tests.
Now that we have our contract, let's make sure it's working correctly by writing some tests.

Hardhat already created a test file in our `/test` directory, and we're going to rename it.

```bash
# FROM ./create-helloworld-contract-using-hardhat;

# Renames `Lock.ts` to `HelloWorld.test.ts`
mv test/Lock.ts test/HellWorld.test.ts;
mv test/Lock.ts test/HelloWorld.test.ts;
```

In our new `HelloWorld.test.ts` file, we'll replace the existing code with the following:
Expand Down
2 changes: 1 addition & 1 deletion apps/core/content/learn/dapps/bend.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ Bend is Berachain's non-custodial lending protocol. Lenders participate by depos

Berachain's native stablecoin [`$HONEY`](/learn/pol/tokens/honey), serves as the primary and exclusive token available for borrowing.

In addition, Bend is an implementation of [Proof-of-Liquidity Reward Vaults](/learn/pol/rewardvaults) which which allows borrowers to become eligible to receive [`$BGT`](/learn/pol/tokens/bgt) emissions. It also demonstrates how PoL can incentivize users to take different types of liquidity actions with dApps.
In addition, Bend is an implementation of [Proof-of-Liquidity Reward Vaults](/learn/pol/rewardvaults) which allows borrowers to become eligible to receive [`$BGT`](/learn/pol/tokens/bgt) emissions. It also demonstrates how PoL can incentivize users to take different types of liquidity actions with dApps.

> To learn more, check out the <a :href="config.websites.docsBend.name">{{config.websites.docsBend.name}}</a>.