Skip to content

Commit

Permalink
feat: earn section - wording update
Browse files Browse the repository at this point in the history
  • Loading branch information
brit-ledger committed Oct 23, 2024
1 parent 8e447b7 commit 77b202d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
14 changes: 9 additions & 5 deletions pages/docs/ledger-live/exchange/earn.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
import Zoom from "react-medium-image-zoom";
import "react-medium-image-zoom/dist/styles.css";
import { Steps } from "nextra/components";
import { Callout } from 'nextra/components'

# What do we need

An Earn application lets Ledger Live users stake their crypto assets to earn rewards.

To integrate your staking services into Ledger Live, your Earn application requires the integration of three key components:
To integrate your Earn application into Ledger Live, three key components are required:

- A **LiveApp**: a LiveApp is a web application loaded within Ledger Live that can interact with Ledger wallet devices (for instance, to sign a transaction) and access information from the connected Ledger wallet (such as the wallet address).
1. A **LiveApp**: a LiveApp is a web application loaded within Ledger Live that can interact with Ledger wallet devices (for instance, to sign a transaction) and access information from the connected Ledger wallet (such as the wallet address).
Your LiveApp provides a user interface that displays information, accepts user inputs, and communicates with your application's backend and smart contracts.
- A **plugin**: ensures that instead of signing raw and often unintelligible blockchain data (blind signing), the user will be provided with a clear, human-readable summary of the transaction details on his Ledger device (clear signing).
2. A **plugin**: ensures that instead of signing raw and often unintelligible blockchain data (blind signing), the user will be provided with a clear, human-readable summary of the transaction details on his Ledger device (clear signing).
To integrate clear signing in your LiveApp, you must write a specific Ledger plugin that translates raw blockchain transaction data into understandable summaries, displaying it on the Ledger device itself. This step is required for your LiveApp to be integrated within Ledger Live.
- **Earn dashboard integration**: The Earn section in Ledger Live allows users to track their staking positions (APY, rewards, etc.). Users staking assets through your service must be able to view their positions in the Earn dashboard.
3. **Earn dashboard integration**: The Earn section in Ledger Live allows users to track their staking positions (APY, rewards, etc.). Users staking assets through your service must be able to view their positions in the Earn dashboard.

<Callout type="info" emoji="ℹ️">
Each component can be developed simultaneously. For example, you can work on your plugin even if your LiveApp isn't finished yet. However, all components must be fully developped (and tested) for your Earn application to be deployed to Ledger Live.
</Callout>

In the following pages, you will find:

Expand Down
10 changes: 5 additions & 5 deletions pages/docs/ledger-live/exchange/earn/liveapp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ To learn how to create (or embed if already existing) your user interface for Le

## LiveApp UX requirements

Your LiveApp must respect some general UX requirements:
- 0-click connect to the wallet (user's wallet must be automatically connected when opening your LiveApp)
Your LiveApp must respect some UX requirements:
- 0-click connect to the wallet (users wallet must be automatically connected when opening your LiveApp)
- Login through other wallets must not be possible
- Design must be responsive for optimal display on all devices
- After a successful transaction (staking/unstaking, delegation, rewards claiming..), a confirmation page with the transaction hash must be displayed to users, allowing them to easily confirm its status.
Expand All @@ -33,14 +33,14 @@ Your LiveApp must respect some general UX requirements:
The Ledger team will review and validate your LiveApp’s user flow and ensure compliance with the guidelines mentioned above.

<Callout type="info" emoji="👉">
If a token representing the staking position is issued to users (wether it is liquid or not), please inform Ledger of the token's name and address.
If a token (wether it is liquid or not) representing the staking position is issued to users, please inform Ledger of the token's name and address.
</Callout>

## Manifest update

If your liveApp interacts with smart contracts that you don't own and are already clear signed by another LiveApp, you must update your manifest to specify this dependency.
In some cases, your LiveApp might interact with third-party smart contracts that you don't own and are already clear signed. If that is the case, you must update your manifest to specify this dependency.

For example, if your LiveApp interacts with eigenlayer smart contracts (that have already been clear signed and used by other LiveApps), then your LiveApp's manifest must include the following:
For example, if your LiveApp interacts with eigenlayer smart contracts (that are already clear signed and used by other LiveApps), then your LiveApp's manifest must include the following:

```json
"dependency": [
Expand Down

0 comments on commit 77b202d

Please sign in to comment.