Skip to content

Commit

Permalink
feat: update deeplinks docs (#7760)
Browse files Browse the repository at this point in the history
* feat: update docs

* fix: improve text

---------

Co-authored-by: Begoña Álvarez de la Cruz <[email protected]>
  • Loading branch information
evavirseda and begonaalvarezd authored Jan 25, 2024
1 parent 7d5fd2d commit cc460ad
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions docs/specifications/deep-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,21 @@ confirmation on behalf of the user.

## Scheme

The Firefly deep link scheme can be broken down to the following (simple) syntax:
Our system incorporates two specific deeplink schemes—namely IOTA and SHIMMER. Breaking down the Firefly deep link scheme reveals the following simple syntax:


**IOTA**

```
iota[-<stage>]://<context>/<operation>[?param=<param>]
```

**Shimmer**

```
firefly[-<stage>]://<context>/<operation>[?param=<param>]
```

The parameters are as follows:

- `stage` - indicates a specific stage of the app to target, options are:
Expand All @@ -40,15 +49,14 @@ The parameters are as follows:
- `operation` - an operation within a specific context (see below for more detail)
- `param` - query parameter(s) relevant for the specified operation

If you wish to target the production version, simply omit this from the prefix:
To target the production version simply don't specify any stages, example for Shimmer:

```
firefly://
```

:::caution
This deep link scheme is **NOT** compatible with Firefly V1, as that version of the application is in maintenance mode.
:::
This prefix is specifically meant for the production version of Firefly. You don't need to add anything else after ``firefly://``


## Contexts

Expand Down Expand Up @@ -115,7 +123,7 @@ The following parameters are **required**:

The following parameters are **optional**:

- `unit` - a specified denomination of the token to use, if applicable (default for IOTA is `Mi`, SMR is `SMR`)
- `unit` - a specified denomination of the token to use, if applicable (default for IOTA is `micro`, SMR is `glow`)
- `assetId` - the identifier of the asset to send, e.g. `4218` (IOTA), `4219` (SMR), or a native token ID (default is base token of the network, i.e. IOTA or SMR)
- `metadata` - a string of text to embed as metadata in the transaction
- `tag` - a string to tag the transaction for indexing purposes
Expand Down
Binary file modified docs/static/send-confirmation-popup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/send-form-popup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit cc460ad

@kamilo08
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

como puedo reestablecer mi contraseña para eviar dinero de la wallet la que tengo no me da yo tengo las 24 palabras y tengo el pin pero no meda la contraseña

Please sign in to comment.