Skip to content

Commit

Permalink
fix: add text
Browse files Browse the repository at this point in the history
  • Loading branch information
IsaccoSordo committed Feb 8, 2024
1 parent b0ae480 commit 268721b
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/docs/guides/active-account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Active Account
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

The 'Active Account' feature in the Beacon SDK is crucial for your dApp to interact effectively with the user's wallet.
The `Active Account` feature in the Beacon SDK is crucial for your dApp to interact effectively with the user's wallet.
Here's how it works:

- `getActiveAccount`: This function returns the current active account. Use it to check the user's active account when they first start using your dApp.
Expand Down
2 changes: 2 additions & 0 deletions src/docs/guides/broadcast-request.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ title: Broadcast Request
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

Broadcast Request is a feature in Beacon SDK that enables applications to send transaction requests to the blockchain. This is primarily used for broadcasting signed transactions to the network.

<Tabs
groupId="beaconOrTaquitoBR"
defaultValue="beacon"
Expand Down
2 changes: 2 additions & 0 deletions src/docs/guides/fa1.2-transfer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ title: FA1.2 Transfer
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

The FA1.2 Transfer feature in Beacon SDK allows token transfers following the FA1.2 standard in Tezos blockchain applications. This standard pertains to fungible tokens, similar to ERC-20 in the Ethereum ecosystem.

<Tabs
groupId="beaconOrTaquitoFA1"
defaultValue="taquito"
Expand Down
2 changes: 2 additions & 0 deletions src/docs/guides/fa2-transfer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ title: FA2 Transfer
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

The FA2 Transfer feature in the Beacon SDK is designed for handling token transfers using the FA2 standard on the Tezos blockchain. FA2 is a multi-asset interface, enabling a wide range of token types and configurations, including fungible, non-fungible, and multi-asset tokens.

<Tabs
groupId="beaconOrTaquitoFA2"
defaultValue="taquito"
Expand Down
3 changes: 3 additions & 0 deletions src/docs/guides/network.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
title: Network
---

The Network configuration in Beacon SDK allows developers to specify the blockchain network their application will interact with.
This includes using predefined networks like Mainnet or Testnet, as well as defining custom networks and RPC endpoints.

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

Expand Down
3 changes: 3 additions & 0 deletions src/docs/guides/sign-payload.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ title: Sign Payload
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

The `SignPayload` functionality in Beacon allows developers to sign various types of payloads.
This page provides some examples for signing payloads in different formats: HEX Prefixed with 05, HEX Prefixed with 03, and RAW.

## HEX Prefixed With 05

<Tabs
Expand Down
40 changes: 40 additions & 0 deletions src/docs/guides/subscribe-to-event.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,46 @@ title: Subscribe To Event
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

In Beacon SDK, various events are emitted to signal different states and actions in the application's lifecycle. <br />
These events provide developers with hooks to respond to changes, errors, user interactions, and other significant occurrences in the application flow.<br />
Understanding and handling these events correctly is crucial for building robust and user-friendly decentralized applications. <br />
Below is a list of events that the Beacon SDK can emit, each representing a specific scenario or response in the application's interaction with the blockchain and its users.<br />

### Events

This list serves as a guide to comprehensively manage application behavior and user experience in various situations:

1. `PERMISSION_REQUEST_SENT`: Fired when a permission request is sent to the user.
2. `PERMISSION_REQUEST_SUCCESS`: Triggered when a permission request is successfully granted by the user.
3. `PERMISSION_REQUEST_ERROR`: Occurs when there is an error in the permission request process.
4. `PROOF_OF_EVENT_CHALLENGE_REQUEST_SENT`: Emitted when a request for a proof of event challenge is sent.
5. `PROOF_OF_EVENT_CHALLENGE_REQUEST_SUCCESS`: Triggered when a proof of event challenge request is successfully completed.
6. `PROOF_OF_EVENT_CHALLENGE_REQUEST_ERROR`: Occurs when there is an error in the proof of event challenge request process.
7. `OPERATION_REQUEST_SENT`: Fired when an operation request (like a transaction) is sent.
8. `OPERATION_REQUEST_SUCCESS`: Triggered when an operation request is successfully processed.
9. `OPERATION_REQUEST_ERROR`: Occurs when there is an error in processing an operation request.
10. `SIGN_REQUEST_SENT`: Emitted when a request to sign a payload is sent.
11. `SIGN_REQUEST_SUCCESS`: Triggered when a sign request is successfully completed.
12. `SIGN_REQUEST_ERROR`: Occurs when there is an error in the sign request process.
13. `BROADCAST_REQUEST_SENT`: Fired when a request to broadcast a transaction to the network is sent.
14. `BROADCAST_REQUEST_SUCCESS`: Triggered when a broadcast request is successfully completed.
15. `BROADCAST_REQUEST_ERROR`: Occurs when there is an error in the broadcast request process.
16. `ACKNOWLEDGE_RECEIVED`: Emitted when an acknowledgement from the user is received.
17. `LOCAL_RATE_LIMIT_REACHED`: Triggered when a local rate limit is reached.
18. `NO_PERMISSIONS`: Occurs when no permissions are granted for the requested operation.
19. `ACTIVE_ACCOUNT_SET`: Fired when an active account is set in the application.
20. `ACTIVE_TRANSPORT_SET`: Triggered when an active transport layer is set.
21. `SHOW_PREPARE`: Emitted when the UI is being prepared to show some content or process.
22. `HIDE_UI`: Occurs when the UI is hidden.
23. `INVALID_ACTIVE_ACCOUNT_STATE`: Fired when there's an invalid state in the active account.
24. `PAIR_INIT`: Emitted at the initiation of a pairing process.
25. `PAIR_SUCCESS`: Triggered when a pairing process completes successfully.
26. `CHANNEL_CLOSED`: Occurs when a communication channel is closed.
27. `INTERNAL_ERROR`: Fired when an internal error occurs within the SDK.
28. `UNKNOWN`: Triggered for any unknown events.

### Example

<Tabs
groupId="beaconOrTaquitoSTE"
defaultValue="beacon"
Expand Down

0 comments on commit 268721b

Please sign in to comment.