diff --git a/doc-site/docs/FAQs/caclute-checksum-is-slow.mdx b/doc-site/docs/FAQs/calculating-checksum-is-slow.mdx similarity index 94% rename from doc-site/docs/FAQs/caclute-checksum-is-slow.mdx rename to doc-site/docs/FAQs/calculating-checksum-is-slow.mdx index fe946163..5928e14e 100644 --- a/doc-site/docs/FAQs/caclute-checksum-is-slow.mdx +++ b/doc-site/docs/FAQs/calculating-checksum-is-slow.mdx @@ -1,6 +1,6 @@ --- id: checksums -title: cacluting checksum is slow +title: calculating checksum is slow order: 1 --- @@ -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 @@ -126,7 +126,7 @@ If the file is larger, this method may cause the page to freeze when calculating -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') diff --git a/doc-site/docs/client/greenfield.mdx b/doc-site/docs/client/greenfield.mdx index 2db85d11..cbb03c7b 100644 --- a/doc-site/docs/client/greenfield.mdx +++ b/doc-site/docs/client/greenfield.mdx @@ -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. ::: diff --git a/doc-site/docs/client/query-client.mdx b/doc-site/docs/client/query-client.mdx index a8b0722b..83bee74f 100644 --- a/doc-site/docs/client/query-client.mdx +++ b/doc-site/docs/client/query-client.mdx @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/doc-site/docs/client/sp-client.mdx b/doc-site/docs/client/sp-client.mdx index abed83b0..fbed06a9 100644 --- a/doc-site/docs/client/sp-client.mdx +++ b/doc-site/docs/client/sp-client.mdx @@ -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 @@ -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 diff --git a/doc-site/docs/client/tx-client.mdx b/doc-site/docs/client/tx-client.mdx index 7bd9e843..3bccfc51 100644 --- a/doc-site/docs/client/tx-client.mdx +++ b/doc-site/docs/client/tx-client.mdx @@ -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', }); diff --git a/doc-site/docs/getting-started/quick-start.mdx b/doc-site/docs/getting-started/quick-start.mdx index c98152dd..f09e36d0 100644 --- a/doc-site/docs/getting-started/quick-start.mdx +++ b/doc-site/docs/getting-started/quick-start.mdx @@ -116,8 +116,8 @@ Create Bucket Tx: -### 5. Create a Object +### 5. Create an Object -Creat Object Tx / Upload File / Download File: +Create Object Tx / Upload File / Download File: