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

correct some issues #285

Open
wants to merge 2 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 CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/chains/near-chain/near-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/chains/starknet-chain/starknet-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/integrations/sdk-integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand Down
4 changes: 2 additions & 2 deletions docs/developer/sdk/examples/lava-bazaar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!`);
Expand All @@ -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;
};
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/sdk/sdk-backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ If you already have `lavad` installed - you can easily generate a lava address b

<iframe width="100%" height="480" src="/img/tutorial/sdk/adding_lava_key.mp4" frameborder="0" allow="autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

If you have an address that exists and no longer remember its private key, you can alwasy use `lavad keys export <key-name> --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 <key-name> --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!
2 changes: 1 addition & 1 deletion docs/developer/sdk/sdk-prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ import RoadmapItem from '@site/src/components/RoadmapItem';

[<RoadmapItem icon="🖥️" title="Learn more about Backend Use" description="use LavaSDK with dotenv for secure & performant API access"/>](/sdk-backend)

[<RoadmapItem icon="📱" title="Learn more about Frontend Use" description="use LavaSDK with badge server for seemless frontend API access"/>](/sdk-frontend)
[<RoadmapItem icon="📱" title="Learn more about Frontend Use" description="use LavaSDK with badge server for seamless frontend API access"/>](/sdk-frontend)
2 changes: 1 addition & 1 deletion docs/intro/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
8 changes: 4 additions & 4 deletions docs/intro/specs/spec-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ The enabled field describes whether the spec is active. There are times when a s

</details>

<details> <summary> `reliability threshhold` </summary>
<details> <summary> `reliability threshold` </summary>

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]

Expand Down Expand Up @@ -377,7 +377,7 @@ Each API collection is composed of various pieces. These pieces collectively giv

<details><summary> `internal_path`</summary>

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.

</details>

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion docs/provider/lavavisor/lavavisor-wrap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down
Loading