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.

Sign up for GitHub

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 fix spelling issues #1297

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Docs fix spelling issues #1297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4686bc8
Update 01-intro.md
nnsW3 Jan 22, 2025
6a30e33
Update 02-basic-api.md
nnsW3 Jan 22, 2025
4c7689e
Update 04-secretjs.md
nnsW3 Jan 22, 2025
69445bd
Update 05-suggest-chain.md
nnsW3 Jan 22, 2025
e2e7883
Update README.md
nnsW3 Jan 22, 2025
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ For help using Keplr Wallet, Visit our [User Support Site](https://help.keplr.ap
- protoc v21.3 (recommended)

```sh
# This script is example for mac arm64 user. for other OS, replace URL(starts with https://..) to be matched with your OS from https://github.com/protocolbuffers/protobuf/releases/tag/v21.3
# This script is an example for mac arm64 user. for other OS, replace URL(starts with https://..) to be matched with your OS from https://github.com/protocolbuffers/protobuf/releases/tag/v21.3
curl -Lo protoc-21.3.zip https://github.com/protocolbuffers/protobuf/releases/download/v21.3/protoc-21.3-osx-aarch_64.zip
unzip protoc-21.3.zip -d $HOME/protoc
cp -r $HOME/protoc/include /usr/local
Expand Down Expand Up @@ -71,7 +71,7 @@ Usage of any other packages besides @keplr-wallet/types is not recommended.
- Any other packages besides @keplr-wallet/types are actively being developed, backward compatibility is not in the scope of support.
- Since there are active changes being made, documentation is not being updated to the most recent version of the package as of right now. Documentations would be updated as packages get stable.

Also, this repo contains submodules that are not open sourced and are only available through the Chainapsis’ official Keplr Browser Extension release. However, all primary features of the extension will work without the closed sourced submodules.
Also, this repo contains submodules that are not open-sourced and are only available through the Chainapsis’ official Keplr Browser Extension release. However, all primary features of the extension will work without the closed-sourced submodules.

## License

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/01-intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Keplr is a non-custodial blockchain wallets for webpages that allow users to int

[Use with cosmjs](./03-cosmjs.md) describes how to use cosmjs with Keplr.

[Use with secretjs](./04-secretjs.md) describes how to use secretjs with Keplr if you need to use secret-wasm feature.
[Use with secretjs](./04-secretjs.md) describes how to use secretjs with Keplr if you need to use the secret-wasm feature.

[Suggest chain](./05-suggest-chain.md) describes how to suggest the chain to Keplr if the chain is not supported natively in Keplr.

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/02-basic-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ order: 1

## How to detect Keplr

You can determine whether Keplr is installed on the user device by checking `window.keplr`. If `window.keplr` returns `undefined` after document.load, Keplr is not installed. There are several ways to wait for the load event to check the status. Refer to the examples below:
You can determine whether Keplr is installed on the user's device by checking `window.keplr`. If `window.keplr` returns `undefined` after document.load, Keplr is not installed. There are several ways to wait for the load event to check the status. Refer to the examples below:

You can register the function to `window.onload`:

Expand Down Expand Up @@ -73,7 +73,7 @@ There may be multiple ways to achieve the same result, and no preferred method.

If you were able to connect Keplr with CosmJS, you may skip to the [Use Keplr with CosmJS](./03-cosmjs.md) section.

While Keplr supports an easy way to connect to CosmJS, there are additional functions specific to Keplr which provide additional features.
While Keplr supports an easy way to connect to CosmJS, there are additional functions specific to Keplr that provide additional features.

### Using with Typescript
**`window.d.ts`**
Expand All @@ -88,7 +88,7 @@ declare global {

The `@keplr-wallet/types` package has the type definition related to Keplr.
If you're using TypeScript, run `npm install --save-dev @keplr-wallet/types` or `yarn add -D @keplr-wallet/types` to install `@keplr-wallet/types`.
Then, you can add the `@keplr-wallet/types` window to a global window object and register the Keplr related types.
Then, you can add the `@keplr-wallet/types` window to a global window object and register the Keplr-related types.

> Usage of any other packages besides @keplr-wallet/types is not recommended.
> - Any other packages besides @keplr-wallet/types are actively being developed, backward compatibility is not in the scope of support.
Expand Down Expand Up @@ -133,7 +133,7 @@ If the webpage has permission and Keplr is unlocked, this function will return t
}
```

It also returns the nickname for the key store currently selected, which should allow the webpage to display the current key store selected to the user in a more convenient mane.
It also returns the nickname for the key store currently selected, which should allow the webpage to display the current key store selected to the user in a more convenient manner.
`isNanoLedger` field in the return type is used to indicate whether the selected account is from the Ledger Nano. Because current Cosmos app in the Ledger Nano doesn't support the direct (protobuf) format msgs, this field can be used to select the amino or direct signer. [Ref](./03-cosmjs.md#types-of-offline-signers)

### Sign Amino
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/04-secretjs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ const cosmJS = new SigningCosmWasmClient(
async suggestToken(chainId: string, contractAddress: string): Promise<void>
```

The webpage can request the user permission to add a SNIP-20 token to Keplr's token list. Will throw an error if the user rejects the request.
If a SNIP-20 with the same contract address already exists, nothing will happen.
The webpage can request the user's permission to add a SNIP-20 token to Keplr's token list. Will throw an error if the user rejects the request.
If an SNIP-20 with the same contract address already exists, nothing will happen.

### Get SNIP-20 Viewing Key
```javascript
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/05-suggest-chain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ order: 4

*Warning: This is an experimental feature.*

Keplr's 'suggest chain' feature allows front-ends to request adding new Cosmos-SDK based blockchains that aren't natively integrated to Keplr extension.
Keplr's 'suggest chain' feature allows front-ends to request adding new Cosmos-SDK based blockchains that aren't natively integrated into Keplr extension.
If the same chain is already added to Keplr, nothing will happen. If the user rejects the request, an error will be thrown.

This allows all Cosmos-SDK blockchains to have permissionless, instant wallet and transaction signing support for front-ends.
Expand Down Expand Up @@ -55,7 +55,7 @@ experimentalSuggestChain(chainInfo: SuggestingChainInfo): Promise<void>
|-|-|-|
| `rpc` | `http://123.456.789.012:26657` | Address of RPC endpoint of the chain. Default port is 26657 |
| `rest` | `http://123.456.789.012:1317` | Address of REST/API endpoint of the chain. Default port is 1317. Must be enabled in `app.toml` |
| `chainId` | mychain-1 | Keplr has a feature which automatically detects when the chain-id has changed, and automatically update to support new chain. However, it should be noted that this functionality will only work when the chain-id follows the \{identifier\}-\{version\}(ex.cosmoshub-4) format. Therefore, it is recommended that the chain follows the chain-id format. |
| `chainId` | mychain-1 | Keplr has a feature which automatically detects when the chain-id has changed, and automatically updates to support new chain. However, it should be noted that this functionality will only work when the chain-id follows the \{identifier\}-\{version\}(ex.cosmoshub-4) format. Therefore, it is recommended that the chain follows the chain-id format. |
| `stakeCurrency` | ```{ coinDenom: "ATOM", coinMinimalDenom: "uatom", coinDecimals: 6, coinGeckoId: "cosmos", }``` | Information on the staking token of the chain |
| `walletUrlForStaking` | https://wallet.keplr.app/chains/cosmos-hub | The URL for the staking interface frontend for the chain. If you don't have a staking interface built, you can use [Lunie Light](https://github.com/luniehq/lunie-light) which supports Keplr. |
| `bip44.coinType` | 118 | BIP44 coin type for address derivation. We recommend using `118`(Cosmos Hub) as this would provide good Ledger hardware wallet compatibility by utilizing the Cosmos Ledger app. |
Expand Down