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: Spell check #467

Merged
merged 1 commit into from
Dec 29, 2023
Merged
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: checksums
title: cacluting checksum is slow
title: calculating checksum is slow
order: 1
---

Expand All @@ -21,7 +21,7 @@ If not counting big files (how big is depending on the user's device), here are

Note, you don't have to have webworker or worker_threads on to get faster performance. Because running worker also has performance loss.

When calculating small files, using core is faster than using worker.
When calculating small files, using the core is faster than using the worker.

## Usage

Expand Down Expand Up @@ -126,7 +126,7 @@ If the file is larger, this method may cause the page to freeze when calculating
</TabItem>
<TabItem value="nodejs" label="Nodejs">

Nodejs can also be used in two ways, directly with core library, or with [worker_threads](https://nodejs.org/api/worker_threads.html) (calculating large files).
Nodejs can also be used in two ways, directly with the core library, or with [worker_threads](https://nodejs.org/api/worker_threads.html) (calculating large files).

```js title="core lib"
const { ReedSolomon } = require('@bnb-chain/reed-solomon')
Expand Down
2 changes: 1 addition & 1 deletion doc-site/docs/client/greenfield.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const client = Client.create(GRPC_URL, String(GREEN_CHAIN_ID), {

:::tip

Browser need load wasm manually.
The browser needs to load wasm manually.

:::

Expand Down
22 changes: 11 additions & 11 deletions doc-site/docs/client/query-client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: 'Query Client'
sidebar_position: 2
---

It's actually an encapsulation of the
It's an encapsulation of the
[Blockchain API](https://docs.bnbchain.org/greenfield-docs/docs/api/blockchain-rest).

:::info
Expand All @@ -22,7 +22,7 @@ await rpc.Account({
});
```

More apis: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/account-info
More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/account-info

## getBankQueryClient

Expand All @@ -34,7 +34,7 @@ await rpc.Balance({
});
```

More apis: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/account-info
More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/account-info

## getBridgeQueryClient

Expand All @@ -43,7 +43,7 @@ const rpc = await client.queryClient.getBridgeQueryClient();
await rpc.Params();
```

More apis: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/bridge-params
More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/bridge-params

## getChallengeQueryClient

Expand All @@ -52,7 +52,7 @@ const rpc = await client.queryClient.getChallengeQueryClient();
await rpc.Params();
```

More apis: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/attested-challenge
More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/attested-challenge

## getCrosschainQueryClient

Expand All @@ -70,7 +70,7 @@ const rpc = await client.queryClient.getFeeGrantQueryClient();
await rpc.Params();
```

More apis: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/allowance
More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/allowance

## getGashubClient

Expand All @@ -79,7 +79,7 @@ const rpc = await this.queryClient.getGashubClient();
await rpc.MsgGasParams(request);
```

More apis: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/msg-gas-params
More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/msg-gas-params

## getPaymentQueryClient

Expand All @@ -88,7 +88,7 @@ const rpc = await this.queryClient.getPaymentQueryClient();
await rpc.Params();
```

More apis: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/msg-gas-params
More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/msg-gas-params

## getSpQueryClient

Expand All @@ -97,7 +97,7 @@ const rpc = await this.queryClient.getSpQueryClient();
await rpc.Params();
```

More apis:
More APIs:
https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/query-global-sp-store-price-by-time

## getStorageQueryClient
Expand All @@ -109,7 +109,7 @@ await rpc.HeadBucketById({
});
```

More apis: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/query-group-members-exist
More APIs: https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/query-group-members-exist

## getVirtualGroupClient

Expand All @@ -118,5 +118,5 @@ const rpc = await client.queryClient.getVirtualGroupClient();
await rpc.Params();
```

More apis:
More APIs:
https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/available-global-virtual-group-families
4 changes: 2 additions & 2 deletions doc-site/docs/client/sp-client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: 'Storage Provider Client'
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

The api related to storage provider are some troublesome.
The API related to storage providers is troublesome.

## AuthType

Expand Down Expand Up @@ -43,7 +43,7 @@ This is the sp service information you want to use.

## OffchainAuth

If you use SDK in browser, you have to get it manually (because you can't get private key in
If you use SDK in the browser, you have to get it manually (because you can't get the private key in the
browser). -->

## Sp Api Example
Expand Down
6 changes: 3 additions & 3 deletions doc-site/docs/client/tx-client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@ import TabItem from '@theme/TabItem';

A transaction contains at least:

1. construct a transaction: The sdk already provides each transaction type
1. construct a transaction: The SDK already provides each transaction type
2. simulate: [txClient.simulate](#simulate)
3. broadcast [txClient.broadcast](#broadcast)

## simulate

Just Simulate a transaction and valid transaction.
Just Simulate a transaction and a valid transaction.

| params | description |
| ------ | ------------------------------------ |
| denom | the coin denom to query balances for |

```jsx title="simulate tx"
// `tx` is a transaction constructed by the sdk
// `tx` is a transaction constructed by the SDK
const simulateInfo = await tx.simulate({
denom: 'BNB',
});
Expand Down
4 changes: 2 additions & 2 deletions doc-site/docs/getting-started/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@ Create Bucket Tx:

<Image img={require('/img/quick-start/create-bucket.png')} />

### 5. Create a Object
### 5. Create an Object

Creat Object Tx / Upload File / Download File:
Create Object Tx / Upload File / Download File:

<Image img={require('/img/quick-start/create-object.png')} />
Loading