From 7790931b0c14feb47531aaf9278ef48e1f141a0e Mon Sep 17 00:00:00 2001 From: Miles <2627273987@qq.com> Date: Mon, 22 Apr 2024 17:06:50 +0800 Subject: [PATCH] correct some issues --- CONTRIBUTING.md | 2 +- docs/chains/near-chain/near-node.md | 2 +- docs/chains/starknet-chain/starknet-node.md | 2 +- .../integrations/sdk-integrations.md | 2 +- docs/developer/sdk/examples/lava-bazaar.md | 4 +- docs/developer/sdk/sdk-backend.md | 2 +- docs/developer/sdk/sdk-prerequisites.md | 2 +- docs/intro/faq.md | 2 +- docs/intro/specs/spec-guide.md | 8 +-- docs/provider/lavavisor/lavavisor-wrap.md | 2 +- lava-api/openapi.yml | 60 +++++++++---------- 11 files changed, 44 insertions(+), 44 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41acf322..dfef06e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ Lava docs serves multiple user types in different lifecycle steps. We want to create a doc resource that will fit all, but have a common denominator of style. Styleguides are guidance and not a restriction, good articles we picked for this purpose are: -- When it comes to git opeartions, we recommend https://cbea.ms/git-commit/ +- When it comes to git operations, we recommend https://cbea.ms/git-commit/ - When it is docs actual content, we recommend https://medium.com/larimaza-en/how-to-write-good-documentation-e19c70dc67f0 ## Getting started diff --git a/docs/chains/near-chain/near-node.md b/docs/chains/near-chain/near-node.md index 575d62de..c53ac176 100644 --- a/docs/chains/near-chain/near-node.md +++ b/docs/chains/near-chain/near-node.md @@ -68,7 +68,7 @@ make release ``` :::caution -`make release` will cause the `nearcore` to compile. Compilation is a time-intensive process and can take ~30 minutes or longer on recommmended hardware. +`make release` will cause the `nearcore` to compile. Compilation is a time-intensive process and can take ~30 minutes or longer on recommended hardware. ::: ### Configure the release folder diff --git a/docs/chains/starknet-chain/starknet-node.md b/docs/chains/starknet-chain/starknet-node.md index b5812756..569d3c23 100644 --- a/docs/chains/starknet-chain/starknet-node.md +++ b/docs/chains/starknet-chain/starknet-node.md @@ -58,7 +58,7 @@ Compare your numbers with Starknet's Testnet_1 before proceeding. ## Install the Starknet L2 Package 📦 -> There are three posible nodes avaliable for [Starknet](https://www.starknet.io/en/ecosystem/fullnodes-and-rpc-services) +> There are three possible nodes available for [Starknet](https://www.starknet.io/en/ecosystem/fullnodes-and-rpc-services) ### Pathfinder node `Cd` into the starknet-stack project root and start the L2 execution client with this command: diff --git a/docs/developer/integrations/sdk-integrations.md b/docs/developer/integrations/sdk-integrations.md index c62c0cd2..7e9a4c16 100644 --- a/docs/developer/integrations/sdk-integrations.md +++ b/docs/developer/integrations/sdk-integrations.md @@ -14,7 +14,7 @@ It is possible and even encouraged to use Lava with popular web3 development lib ## Usage 🏗️ -Taking advantage of integrations is an important way to multi-chain and decentralize your application. Due to differences in architecture, each Lava integration has its idiosyncracies. However, all of them follow the same general flow: +Taking advantage of integrations is an important way to multi-chain and decentralize your application. Due to differences in architecture, each Lava integration has its idiosyncrasies. However, all of them follow the same general flow: 1. Install the supported web3 development package (i.e. `npm i viem`) in your project. 2. Install the Lava integration package into your project (i.e. `npm i @lavanet/lava-viem`) diff --git a/docs/developer/sdk/examples/lava-bazaar.md b/docs/developer/sdk/examples/lava-bazaar.md index 5af36c04..1e8c9a48 100644 --- a/docs/developer/sdk/examples/lava-bazaar.md +++ b/docs/developer/sdk/examples/lava-bazaar.md @@ -60,7 +60,7 @@ async function createClientForChain(chainID) { chainIds: chainID }); if (client) { - console.log(`${chainID} 🔩 intialized: `, client.name, client.transport.name, client.uid); + console.log(`${chainID} 🔩 initialized: `, client.name, client.transport.name, client.uid); return client; } else { console.log(`${chainID} ❌ failed to initialize!`); @@ -73,7 +73,7 @@ async function createClientForChain(chainID) { async function getClient(chainID) { const client = clientList[chainID]; if (!client) { - throw new Error(` Unsupported or unitialized chain: ${chainID}`); + throw new Error(` Unsupported or uninitialized chain: ${chainID}`); } return client; }; diff --git a/docs/developer/sdk/sdk-backend.md b/docs/developer/sdk/sdk-backend.md index aa57e3ae..7e4dda10 100644 --- a/docs/developer/sdk/sdk-backend.md +++ b/docs/developer/sdk/sdk-backend.md @@ -45,6 +45,6 @@ If you already have `lavad` installed - you can easily generate a lava address b - If you have an address that exists and no longer remember its private key, you can alwasy use `lavad keys export --unarmored-hex --unsafe` to see your privatekey printed as a string. Do not share the output with anyone! + If you have an address that exists and no longer remember its private key, you can always use `lavad keys export --unarmored-hex --unsafe` to see your privatekey printed as a string. Do not share the output with anyone! 🚀 Your private-key, public-key pair can be used for backend development provided you have a subscription! \ No newline at end of file diff --git a/docs/developer/sdk/sdk-prerequisites.md b/docs/developer/sdk/sdk-prerequisites.md index 710c1939..916f692b 100644 --- a/docs/developer/sdk/sdk-prerequisites.md +++ b/docs/developer/sdk/sdk-prerequisites.md @@ -13,4 +13,4 @@ import RoadmapItem from '@site/src/components/RoadmapItem'; [](/sdk-backend) -[](/sdk-frontend) \ No newline at end of file +[](/sdk-frontend) \ No newline at end of file diff --git a/docs/intro/faq.md b/docs/intro/faq.md index 4d12a80c..4ef86663 100644 --- a/docs/intro/faq.md +++ b/docs/intro/faq.md @@ -119,7 +119,7 @@ This error means that you have used different geolocations when using the `prov Lava easily integrates with other RPC clients. -1. **Gateway** - Simply create an account on the gateway, and replace your client's RPC URL with the appopriate one. Get started [immediately](/gateway-getting-started)! +1. **Gateway** - Simply create an account on the gateway, and replace your client's RPC URL with the appropriate one. Get started [immediately](/gateway-getting-started)! 2. **SDK** - You can also use the SDK library integrations to integrate with [viem](/viem), [cosmjs](/cosmjs), [web3.js](/web3js), or [ethers.js](/ethersjs5). ### 🟡 I'm already using another SDK. {#using-lava-with-other-sdks} diff --git a/docs/intro/specs/spec-guide.md b/docs/intro/specs/spec-guide.md index 6a79232b..63038877 100644 --- a/docs/intro/specs/spec-guide.md +++ b/docs/intro/specs/spec-guide.md @@ -112,7 +112,7 @@ The enabled field describes whether the spec is active. There are times when a s -
`reliability threshhold` +
`reliability threshold` Reliability threshold sets the frequency of reliability related messages. By default, we set this to `268435455` which is the minimum and efficient choice. If you’d like to set it higher - there are more details that can be learned here. [/spec-reference#terms] @@ -377,7 +377,7 @@ Each API collection is composed of various pieces. These pieces collectively giv
`internal_path` -This field gives the internal path of the node for this specific ApiCollection. This is **most likely unneeded** unless the API sets vary on internal paths on teh node. The best example is the [AVAX specification](https://raw.githubusercontent.com/lavanet/lava/main/cookbook/specs/spec_add_avalanche.json) which uses internal paths to distinguish between subnets with distinct ApiCollections. +This field gives the internal path of the node for this specific ApiCollection. This is **most likely unneeded** unless the API sets vary on internal paths on the node. The best example is the [AVAX specification](https://raw.githubusercontent.com/lavanet/lava/main/cookbook/specs/spec_add_avalanche.json) which uses internal paths to distinguish between subnets with distinct ApiCollections.
@@ -535,7 +535,7 @@ This area is used to describe how to extract the block number from the API reque ### Compute Units -Describes the number of compute units which each API call expends. This number is a proxy for the compute intensiveness/difficulty and therefore the cost of calling this API. Note: compute units are not just tethered to rewards - they also indirectly inform the protocol of the expected time to response; by default, each compute unit adds ~100 ms to the relay's timeout threshhold. +Describes the number of compute units which each API call expends. This number is a proxy for the compute intensiveness/difficulty and therefore the cost of calling this API. Note: compute units are not just tethered to rewards - they also indirectly inform the protocol of the expected time to response; by default, each compute unit adds ~100 ms to the relay's timeout threshold. There are a minimum of 10 CU per call - this should be sufficient for most calls. @@ -611,7 +611,7 @@ Earlier, we looked at Parse Directives as a means for understanding the type of ] ``` -The default behavior of verifications is to restrict a provider from serving the APIs if failed. This cna be altered with a field called `severity` but it is not recommended behavior unless specific to your usecase. +The default behavior of verifications is to restrict a provider from serving the APIs if failed. This can be altered with a field called `severity` but it is not recommended behavior unless specific to your usecase. 🔖REFERENCE: [`Verifications`](/spec-reference#verifications) diff --git a/docs/provider/lavavisor/lavavisor-wrap.md b/docs/provider/lavavisor/lavavisor-wrap.md index e08cd04e..b61ae144 100644 --- a/docs/provider/lavavisor/lavavisor-wrap.md +++ b/docs/provider/lavavisor/lavavisor-wrap.md @@ -31,7 +31,7 @@ Please make sure you are using the right `chainId` this document was written dur ### > `lavavisor init` LavaVisor `init` command initializes the environment for LavaVisor. It is generally the first command run when using LavaVisor. -If you're using [`lavavisor pod`](#-lavavisor-pod) this command is unnecesary and can be skipped. +If you're using [`lavavisor pod`](#-lavavisor-pod) this command is unnecessary and can be skipped. **Optional Flags:** diff --git a/lava-api/openapi.yml b/lava-api/openapi.yml index e811f80a..5f419d4d 100755 --- a/lava-api/openapi.yml +++ b/lava-api/openapi.yml @@ -2312,7 +2312,7 @@ paths: - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN title: >- - BlockIdFlag indicates which BlcokID the + BlockIdFlag indicates which BlockID the signature is for validator_address: type: string @@ -2465,7 +2465,7 @@ paths: - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN title: >- - BlockIdFlag indicates which BlcokID the + BlockIdFlag indicates which BlockID the signature is for validator_address: type: string @@ -3066,7 +3066,7 @@ paths: - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN title: >- - BlockIdFlag indicates which BlcokID the + BlockIdFlag indicates which BlockID the signature is for validator_address: type: string @@ -3219,7 +3219,7 @@ paths: - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN title: >- - BlockIdFlag indicates which BlcokID the + BlockIdFlag indicates which BlockID the signature is for validator_address: type: string @@ -5192,7 +5192,7 @@ paths: type: object properties: commission: - description: commission defines the commision the validator received. + description: commission defines the commission the validator received. type: object properties: commission: @@ -26163,7 +26163,7 @@ paths: format: uint64 - name: latest_height description: >- - latest_height overrrides the height field and queries the latest + latest_height overrides the height field and queries the latest stored ConsensusState @@ -27196,7 +27196,7 @@ paths: identifier description: >- Version defines the versioning scheme used to - negotiate the IBC verison in + negotiate the IBC version in the connection handshake. title: >- @@ -27585,7 +27585,7 @@ paths: identifier description: >- Version defines the versioning scheme used to negotiate - the IBC verison in + the IBC version in the connection handshake. description: >- @@ -32087,7 +32087,7 @@ definitions: - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN title: >- - BlockIdFlag indicates which BlcokID the + BlockIdFlag indicates which BlockID the signature is for validator_address: type: string @@ -32237,7 +32237,7 @@ definitions: - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN - title: BlockIdFlag indicates which BlcokID the signature is for + title: BlockIdFlag indicates which BlockID the signature is for validator_address: type: string format: byte @@ -32638,7 +32638,7 @@ definitions: - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN title: >- - BlockIdFlag indicates which BlcokID the + BlockIdFlag indicates which BlockID the signature is for validator_address: type: string @@ -32788,7 +32788,7 @@ definitions: - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN - title: BlockIdFlag indicates which BlcokID the signature is for + title: BlockIdFlag indicates which BlockID the signature is for validator_address: type: string format: byte @@ -33947,7 +33947,7 @@ definitions: - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN title: >- - BlockIdFlag indicates which BlcokID the + BlockIdFlag indicates which BlockID the signature is for validator_address: type: string @@ -34097,7 +34097,7 @@ definitions: - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN - title: BlockIdFlag indicates which BlcokID the signature is for + title: BlockIdFlag indicates which BlockID the signature is for validator_address: type: string format: byte @@ -34136,7 +34136,7 @@ definitions: - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN - title: BlockIdFlag indicates which BlcokID the signature is for + title: BlockIdFlag indicates which BlockID the signature is for tendermint.types.Commit: type: object properties: @@ -34176,7 +34176,7 @@ definitions: - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN - title: BlockIdFlag indicates which BlcokID the signature is for + title: BlockIdFlag indicates which BlockID the signature is for validator_address: type: string format: byte @@ -34201,7 +34201,7 @@ definitions: - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN - title: BlockIdFlag indicates which BlcokID the signature is for + title: BlockIdFlag indicates which BlockID the signature is for validator_address: type: string format: byte @@ -34611,7 +34611,7 @@ definitions: - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN title: >- - BlockIdFlag indicates which BlcokID the + BlockIdFlag indicates which BlockID the signature is for validator_address: type: string @@ -34987,7 +34987,7 @@ definitions: - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN title: >- - BlockIdFlag indicates which BlcokID the + BlockIdFlag indicates which BlockID the signature is for validator_address: type: string @@ -35297,7 +35297,7 @@ definitions: - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN - title: BlockIdFlag indicates which BlcokID the signature is for + title: BlockIdFlag indicates which BlockID the signature is for validator_address: type: string format: byte @@ -35493,7 +35493,7 @@ definitions: - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN title: >- - BlockIdFlag indicates which BlcokID the signature is + BlockIdFlag indicates which BlockID the signature is for validator_address: type: string @@ -35731,7 +35731,7 @@ definitions: - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN - title: BlockIdFlag indicates which BlcokID the signature is for + title: BlockIdFlag indicates which BlockID the signature is for validator_address: type: string format: byte @@ -36112,7 +36112,7 @@ definitions: type: object properties: commission: - description: commission defines the commision the validator received. + description: commission defines the commission the validator received. type: object properties: commission: @@ -43244,7 +43244,7 @@ definitions: - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN title: >- - BlockIdFlag indicates which BlcokID the + BlockIdFlag indicates which BlockID the signature is for validator_address: type: string @@ -43394,7 +43394,7 @@ definitions: - BLOCK_ID_FLAG_COMMIT - BLOCK_ID_FLAG_NIL default: BLOCK_ID_FLAG_UNKNOWN - title: BlockIdFlag indicates which BlcokID the signature is for + title: BlockIdFlag indicates which BlockID the signature is for validator_address: type: string format: byte @@ -49615,7 +49615,7 @@ definitions: title: list of features compatible with the specified identifier description: >- Version defines the versioning scheme used to negotiate the IBC - verison in + version in the connection handshake. description: >- @@ -49737,7 +49737,7 @@ definitions: title: list of features compatible with the specified identifier description: >- Version defines the versioning scheme used to negotiate the IBC - verison in + version in the connection handshake. title: >- @@ -50292,7 +50292,7 @@ definitions: title: list of features compatible with the specified identifier description: >- Version defines the versioning scheme used to negotiate the IBC - verison in + version in the connection handshake. description: >- @@ -50429,7 +50429,7 @@ definitions: title: list of features compatible with the specified identifier description: >- Version defines the versioning scheme used to negotiate the - IBC verison in + IBC version in the connection handshake. title: >- @@ -50574,7 +50574,7 @@ definitions: type: string title: list of features compatible with the specified identifier description: |- - Version defines the versioning scheme used to negotiate the IBC verison in + Version defines the versioning scheme used to negotiate the IBC version in the connection handshake. lavanet.lava.epochstorage.Endpoint: type: object