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

chore: fix typos and refine texts #31

Open
wants to merge 6 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
4 changes: 2 additions & 2 deletions api-reference/jtw.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Json Web Token(JWT)"

## What is a JWT?

JSON Web Tokens (JWTs), also known as JOTs, were created to establish a standard and secure method for two parties to communicate. They offer the advantage of stateless session management, eliminating the need for communication between a backend server and an authorization server.
JSON Web Tokens (JWTs), also known as JWTs, were created to establish a standard and secure method for two parties to communicate. They offer the advantage of stateless session management, eliminating the need for communication between a backend server and an authorization server.

JWTs can be transmitted via an HTTP header, URL, or POST parameter, and their compact size contributes to their efficiency. A JWT comprises three parts: a **Header**, **Payload**, and **Signature**, each separated by a period and derived from a JSON object that is encoded into a text string using BASE64. Further information on this standard is available in [RFC-7519](https://tools.ietf.org/html/rfc7519).

Expand Down Expand Up @@ -125,7 +125,7 @@ In the event that the JWT feature has been activated but requests are sent witho
>
>A: Yes. If multiple JWTs are active, the request should only match one of the available keys to succeed. Chainbase now supports up to 3 keys.

>Q: Which cipher does Chanbase support?
>Q: Which cipher does Chainbase support?
>
>A: RSA 256 (RS256) is supported at this time.

Expand Down
4 changes: 2 additions & 2 deletions catalog/Base/Overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: '☆ Overview'
---

Base is a Layer 2 scaling solution built on top of the Ethereum blockchain, designed to enhance scalability, reduce transaction costs, and provide a robust environment for decentralized applications (DApps). Developed to address the limitations of Ethereum's main chain, Base utilizes advanced rollup technology to offer fast, secure, and cost-effective transactions while maintaining the security and decentralization of the Ethereum network.
### The Major Features of the Arbitrum Blockchain
### The Major Features of the Base Blockchain

1. **Scalability**: Base significantly increases Ethereum's scalability by aggregating multiple transactions into a single batch processed off-chain, which is then committed to the Ethereum main chain. This rollup technique allows Base to handle thousands of transactions per second, reducing congestion and improving network performance.

Expand All @@ -23,4 +23,4 @@ Base is a Layer 2 scaling solution built on top of the Ethereum blockchain, desi
<Card title="Abstracted" icon="head-side-gear" href="./Abstracted/token_metas">
The abstracted data tables are built on top of raw data tables and provide a high-level view of the data.
</Card>
</CardGroup>
</CardGroup>
6 changes: 3 additions & 3 deletions catalog/Sui/Overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: '☆ Overview'
---

Sui is a decentralized blockchain platform designed to deliver high performance, scalability, and security, making it an ideal choice for developing and deploying decentralized applications (DApps). Leveraging innovative consensus mechanisms and advanced architecture, Sui aims to overcome the limitations of traditional blockchain networks while providing a seamless and efficient user experience.
### The Major Features of the Ethereum Blockchain
### The Major Features of the Sui Blockchain

1. **High Performance**: Sui is built to handle a high volume of transactions with low latency, enabling it to process thousands of transactions per second. This high throughput ensures that the network can support a growing number of users and applications without experiencing congestion or delays.

Expand All @@ -16,9 +16,9 @@ Sui is a decentralized blockchain platform designed to deliver high performance,

<CardGroup cols={3}>
<Card title="Raw" icon="binary" href="./Raw/blocks">
Ethereum Sui, unprocessed data on the Sui chain, including blocks, transactions, and logs.
Sui, unprocessed data on the Sui chain, including blocks, transactions, and logs.
</Card>
<Card title="Abstracted" icon="head-side-gear" href="./Abstracted/token_metas">
The abstracted data tables are built on top of raw data tables and provide a high-level view of the data.
</Card>
</CardGroup>
</CardGroup>
2 changes: 1 addition & 1 deletion development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ yarn global add mintlify

</CodeGroup>

Step 2. Go to the docs are located (where you can find `mint.json`) and run the following command:
Step 2. Go to where the docs are located (where you can find `mint.json`) and run the following command:

```bash
mintlify dev
Expand Down
14 changes: 7 additions & 7 deletions node/operator.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Run a Operator(Not released to mainnet yet)'
title: 'Run an Operator(Not released to mainnet yet)'
---

## Requirements
Expand All @@ -19,12 +19,12 @@ For reference, see [here](https://docs.eigenlayer.xyz/eigenlayer/operator-guides

## Chainbase AVS Contract Registration

1. download chainbase avs setup [repo](https://github.com/chainbase-labs/chainbase-avs-setup)
1. Download chainbase avs setup [repo](https://github.com/chainbase-labs/chainbase-avs-setup)
```
git clone https://github.com/chainbase-labs/chainbase-avs-setup && cd chainbase-avs-setup/holesky
```

2. rename `.env.example` to `.env`
2. Rename `.env.example` to `.env`

The provided `.env` contains many default configuration settings for the node. All sections marked with TODO must be updated to match your environment. We recommend that operators follow the steps in the next section to configure their node to run without access to their ECDSA private key.

Expand All @@ -48,22 +48,22 @@ NODE_ECDSA_KEY_FILE_HOST=${EIGENLAYER_HOME}/operator_keys/opr.ecdsa.key.json
NODE_ECDSA_KEY_PASSWORD=''
```

3. ensure that the specific folders exist that the docker user has the correct write permissions
3. Ensure that the specific folders exist that the docker user has the correct write permissions
```
source .env && mkdir -pv ${EIGENLAYER_HOME} ${CHAINBASE_AVS_HOME} ${NODE_LOG_PATH_HOST}
```

4. confirm the latest chainbase avs image version and modify it in the `.env` file
4. Confirm the latest chainbase avs image version and modify it in the `.env` file
```shell
MAIN_SERVICE_IMAGE=repository.chainbase.com/network/chainbase-node:<latest version>
```

5. change `chainbase-avs.sh` file permissions
5. Change `chainbase-avs.sh` file permissions
```shell
chmod +x ./chainbase-avs.sh
```

6. update `holesky/prometheus.yml`'s `${YOUR_OPERATOR_NAME}`
6. Update `holesky/prometheus.yml`'s `${YOUR_OPERATOR_NAME}`

replace this with your Operator name you want to be identified by, it helps us route alerts and metrics to your notification channels easily

Expand Down
2 changes: 1 addition & 1 deletion quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 'Start building awesome documentation in under 5 minutes'

## Setup your development

Learn how to update your docs locally and and deploy them to the public.
Learn how to update your docs locally and deploy them to the public.

### Edit and preview

Expand Down