diff --git a/api-reference/jtw.mdx b/api-reference/jtw.mdx index 935c803..345212a 100644 --- a/api-reference/jtw.mdx +++ b/api-reference/jtw.mdx @@ -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). @@ -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. diff --git a/catalog/Base/Overview.mdx b/catalog/Base/Overview.mdx index 22d8784..6415bf4 100644 --- a/catalog/Base/Overview.mdx +++ b/catalog/Base/Overview.mdx @@ -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. @@ -23,4 +23,4 @@ Base is a Layer 2 scaling solution built on top of the Ethereum blockchain, desi The abstracted data tables are built on top of raw data tables and provide a high-level view of the data. - \ No newline at end of file + diff --git a/catalog/Sui/Overview.mdx b/catalog/Sui/Overview.mdx index 86f0ba8..bc70782 100644 --- a/catalog/Sui/Overview.mdx +++ b/catalog/Sui/Overview.mdx @@ -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. @@ -16,9 +16,9 @@ Sui is a decentralized blockchain platform designed to deliver high performance, - 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. The abstracted data tables are built on top of raw data tables and provide a high-level view of the data. - \ No newline at end of file + diff --git a/development.mdx b/development.mdx index 8783008..3145b3e 100644 --- a/development.mdx +++ b/development.mdx @@ -22,7 +22,7 @@ yarn global add mintlify -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 diff --git a/node/operator.mdx b/node/operator.mdx index a944830..4b10a65 100644 --- a/node/operator.mdx +++ b/node/operator.mdx @@ -1,5 +1,5 @@ --- -title: 'Run a Operator(Not released to mainnet yet)' +title: 'Run an Operator(Not released to mainnet yet)' --- ## Requirements @@ -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. @@ -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: ``` -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 diff --git a/quickstart.mdx b/quickstart.mdx index d7f3486..c44cfaa 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -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