Skip to content

Commit

Permalink
fix: typos (#42)
Browse files Browse the repository at this point in the history
Co-authored-by: Isacco <[email protected]>
  • Loading branch information
IsaccoSordo and isordo authored Oct 9, 2023
1 parent 5ec493e commit bd73ba7
Show file tree
Hide file tree
Showing 19 changed files with 31 additions and 31 deletions.
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ const config = {
type: "doc",
position: "left",
docId: "getting-started/simple-example",
label: "DApps",
label: "dApps",
},
{
type: "doc",
Expand Down
2 changes: 1 addition & 1 deletion src/components/DAppTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ const DAppTable = () => {
<table>
<thead>
<tr>
<th>DApp</th>
<th>dApp</th>
<th>SDK Version</th>
<th>Last Updated</th>
<th>Source Code</th>
Expand Down
4 changes: 2 additions & 2 deletions src/docs/advanced/debug-wallet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ title: Debug Wallet
---

:::caution
This wallet is intended for developers to debug their DApps.
This wallet is intended for developers to debug their dApps.
:::

A common issue with DApps is that users report that a certain functionality doesn't work for them. It is often cumbersome to reproduce this in a development environment because the dev team doesn't have access to the account. The Debug Wallet can help debug those cases.
A common issue with dApps is that users report that a certain functionality doesn't work for them. It is often cumbersome to reproduce this in a development environment because the dev team doesn't have access to the account. The Debug Wallet can help debug those cases.

[Beacon Debug Wallet](https://debug.walletbeacon.io)

Expand Down
2 changes: 1 addition & 1 deletion src/docs/advanced/different-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Different Beacon Node
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

You can configure the DApp or Wallet to connect to a different beacon node.
You can configure the dApp or Wallet to connect to a different beacon node.
Make sure the servers you use are whitelisted in the beacon network and federation is working correctly.

<Tabs
Expand Down
2 changes: 1 addition & 1 deletion src/docs/advanced/ui-elements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import DynamicImage from "@site/src/components/DynamicImage";

:::caution
We strongly recommend keeping the default UI Elements.
Consistent UI helps users to interact with different DApps more easily.
Consistent UI helps users to interact with different dApps more easily.
:::

The default UI elements have been designed with all wallets and user setups in mind.
Expand Down
2 changes: 1 addition & 1 deletion src/docs/blockchains/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export interface PermissionRequestV3<T extends string = string>
blockchainIdentifier: T;
type: BeaconMessageType.PermissionRequest;
blockchainData: {
appMetadata: AppMetadata; // Some additional information about the DApp
appMetadata: AppMetadata; // Some additional information about the dApp
scopes: string[];

}
Expand Down
6 changes: 3 additions & 3 deletions src/docs/blockchains/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { DAppClient } from "@airgap/beacon-dapp";
import { SubstrateBlockchain } from "@airgap/beacon-blockchain-substrate";

const client = new DAppClient({
name: "Example DApp",
name: "Example dApp",
});

const substrateBlockchain = new SubstrateBlockchain();
Expand Down Expand Up @@ -60,7 +60,7 @@ client.connect(async (message) => {
throw new Error("Only KSM supported");
}
console.log("SUBSTRATE MESSAGE");
// Show a UI to the user where he can confirm sharing an account with the DApp
// Show a UI to the user where he can confirm sharing an account with the dApp

const response = {
id: message.id,
Expand All @@ -82,7 +82,7 @@ client.connect(async (message) => {
},


// Send response back to DApp
// Send response back to dApp
client.respond(response);
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/docs/getting-started/best-practices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import DynamicImage from "@site/src/components/DynamicImage";

## Connect Wallet

The following best practice outlines recommendations for the user interface to create a uniform user experience across DApps in the ecosystem.
The following best practice outlines recommendations for the user interface to create a uniform user experience across dApps in the ecosystem.

Before being able to interact with a wallet through Beacon, the user first needs to perform an action to trigger the wallet connection.

Expand Down
6 changes: 3 additions & 3 deletions src/docs/getting-started/first-dapp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ wallet.client.subscribeToEvent(
async (account) => {
// An active account has been set, update the dApp UI
console.log(`${BeaconEvent.ACTIVE_ACCOUNT_SET} triggered: `, account);
}
},
);

try {
Expand Down Expand Up @@ -176,7 +176,7 @@ if (activeAccount) {
</Tabs>
The `beacon-sdk` is now fully set up and ready to receive operation requests.

> If you want to add reactivity to your DApp when an active account changes, then you have to subscribe to `BeaconEvent.ACTIVE_ACCOUNT_SET`.
> If you want to add reactivity to your dApp when an active account changes, then you have to subscribe to `BeaconEvent.ACTIVE_ACCOUNT_SET`.
<Tabs
groupId="beaconOrTaquito4"
Expand Down Expand Up @@ -410,7 +410,7 @@ wallet.client.subscribeToEvent(
]);

console.log(response);
}
},
);

// Check if we are connected. If not, do a permission request first.
Expand Down
2 changes: 1 addition & 1 deletion src/docs/getting-started/high-performance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: High Performance
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

There are a few best practices dApp developers can follow to make their DApps more performant. We will go into a few of those here. Which ones are relevant to your dApp is always depending on the type of dApp. If you need help, feel free to reach out to us on [Discord](https://discord.gg/vuf4Gtnqh7) in the #beacon channel.
There are a few best practices dApp developers can follow to make their dApps more performant. We will go into a few of those here. Which ones are relevant to your dApp is always depending on the type of dApp. If you need help, feel free to reach out to us on [Discord](https://discord.gg/vuf4Gtnqh7) in the #beacon channel.

## Make sure beacon-sdk is up to date

Expand Down
2 changes: 1 addition & 1 deletion src/docs/guides/active-account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ if (activeAccount) {
</TabItem>
</Tabs>

> If you want to add reactivity to your DApp when an active account changes, then you have to subscribe to `BeaconEvent.ACTIVE_ACCOUNT_SET`.
> If you want to add reactivity to your dApp when an active account changes, then you have to subscribe to `BeaconEvent.ACTIVE_ACCOUNT_SET`.
<Tabs
groupId="beaconOrTaquitoAA2"
Expand Down
2 changes: 1 addition & 1 deletion src/docs/guides/standalone-delegation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ You can do this with python: `python -m SimpleHTTPServer 8080`

<script>
const bakerAddress = "tz1MJx9vhaNRSimcuXPK2rW4fLccQnDAnVKJ"; // Replace with baker address
const bakerName = "Delegation Example DApp"; // Replace with baker name / website
const bakerName = "Delegation Example dApp"; // Replace with baker name / website
// Initiate DAppClient
const client = new beacon.DAppClient({
Expand Down
6 changes: 3 additions & 3 deletions src/docs/introduction/dapps.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: DApps
title: dApps
slug: /dapps
---

import DAppTable from "@site/src/components/DAppTable";

This is a list of all the DApps that are using beacon and their version. If a dApp is missing, please let us know.
This is a list of all the dApps that are using beacon and their version. If a dApp is missing, please let us know.

DApps should always use the latest `beacon-sdk` version for the latest features and fixes.
dApps should always use the latest `beacon-sdk` version for the latest features and fixes.

<DAppTable />
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ myCoroutineScope.launch {
}
```

## Disconnect from all DApps
## Disconnect from all dApps

To disconnect from all subscribed DApps remove all peers that were previously registered in the client.
To disconnect from all subscribed dApps remove all peers that were previously registered in the client.

```kotlin
myCoroutineScope.launch {
Expand Down
4 changes: 2 additions & 2 deletions src/docs/wallet/getting-started/ios/disconnect-from-dapp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ beaconWallet.getPeers { result in
}
```

## Disconnect from all DApps
## Disconnect from all dApps

To disconnect from all subscribed DApps remove all peers that were previously registered in the client.
To disconnect from all subscribed dApps remove all peers that were previously registered in the client.

```swift
beaconWallet.removeAllPeers { result in
Expand Down
8 changes: 4 additions & 4 deletions src/docs/wallet/getting-started/web/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ After that you need to import the Beacon SDK in your code and initialize the Wal
The `beacon-sdk` will automatically establish a connection and listen to all Beacon messages.

:::caution
The RPC URL that is provided by the DApp can be an insecure http:// connection. The reason for this is because it allows for easy development with a local node, without setting up a local SSL certificate.
The RPC URL that is provided by the dApp can be an insecure http:// connection. The reason for this is because it allows for easy development with a local node, without setting up a local SSL certificate.

Especially the wallet should care about this and potentially show a warning to the user if the RPC URL is not a secure https:// URL.
:::

```ts live
```ts
import {
WalletClient,
BeaconMessageType,
Expand Down Expand Up @@ -122,7 +122,7 @@ const connectApp = async (): Promise<void> => {
connectApp().catch((error) => console.error("connect error", error));
```
By adding the code above, our app is now ready to receive messages. Now all that is left for us to do is connecting to a DApp.
By adding the code above, our app is now ready to receive messages. Now all that is left for us to do is connecting to a dApp.
To establish a connection over the P2P network, a handshake message has to be given from the dApp to the wallet. How this is done depends on the platform.
It can be through QR scanning, Deeplinks or Copy-Pasting the handshake message. Once the handshake is received, the new peer has to be added:
Expand Down Expand Up @@ -150,6 +150,6 @@ if (isBeaconMessage(deserialized)) {
That's it, now the dApp and the Wallet are connected.
There are some additional features that the `WalletClient` provides, such as `client.getPermissions()` or `client.getPeers()` to listing all the connected peers and permissions that were granted to DApps.
There are some additional features that the `WalletClient` provides, such as `client.getPermissions()` or `client.getPeers()` to listing all the connected peers and permissions that were granted to dApps.
Using `client.removePeer(peer)` the wallet can disconnect from a peer. If this is done, the dApp will receive a message that the wallet has disconnected.
2 changes: 1 addition & 1 deletion src/docs/wallet/messages/substrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Substrate
---

See [DApp docs](/blockchains/substrate)
See [dApp docs](/blockchains/substrate)
2 changes: 1 addition & 1 deletion src/docs/wallet/messages/tezos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Tezos
---

See [DApp docs](/blockchains/tezos)
See [dApp docs](/blockchains/tezos)
2 changes: 1 addition & 1 deletion src/docs/wallet/security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
title: Security
---

The RPC URL that is provided by the DApp can be an insecure http:// connection. The reason for this is because it allows for easy development with a local node, without setting up a local SSL certificate.
The RPC URL that is provided by the dApp can be an insecure http:// connection. The reason for this is because it allows for easy development with a local node, without setting up a local SSL certificate.

Especially the wallet should care about this and potentially show a warning to the user if the RPC URL is not a secure https:// URL.

0 comments on commit bd73ba7

Please sign in to comment.