Skip to content

Commit 240e3f6

Browse files
committed
feat: update docs
1 parent aae0ad8 commit 240e3f6

File tree

3 files changed

+18
-9
lines changed

3 files changed

+18
-9
lines changed

docs/specifications/deep-links.md

+18-9
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,21 @@ confirmation on behalf of the user.
2222

2323
## Scheme
2424

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

2730
```
2831
iota[-<stage>]://<context>/<operation>[?param=<param>]
2932
```
3033

34+
**SHIMMER**
35+
36+
```
37+
firefly[-<stage>]://<context>/<operation>[?param=<param>]
38+
```
39+
3140
The parameters are as follows:
3241

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

43-
If you wish to target the production version, simply omit this from the prefix:
52+
To target the production version, use the following deeplink prefix:
4453

4554
```
4655
firefly://
4756
```
4857

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

5361
## Contexts
5462

@@ -103,7 +111,7 @@ This operation brings the user to the send confirmation popup:
103111
The deep link structure is as follows:
104112

105113
```
106-
firefly://wallet/sendConfirmation?address=<address>&amount=<amount>[&unit=<unit>][&assetId=<assetId>][&metadata=<metadata>][&tag=<tag>][&giftStorageDeposit=<true|false>][&disableToggleGift=<true|false>][&disableChangeExpiration=<true|false>][&surplus=<surplus>]
114+
firefly://wallet/sendConfirmation?address=<address>&amount=<amount>[&unit=<unit>][&assetId=<assetId>][&metadata=<metadata>][&tag=<tag>][&giftStorageDeposit=<true|false>][&disableToggleGift=<true|false>][&disableChangeExpiration=<true|false>][&surplus=<surplus>][&expiration=<expiration>]
107115
```
108116

109117
The following parameters are **required**:
@@ -115,23 +123,24 @@ The following parameters are **required**:
115123

116124
The following parameters are **optional**:
117125

118-
- `unit` - a specified denomination of the token to use, if applicable (default for IOTA is `Mi`, SMR is `SMR`)
126+
- `unit` - a specified denomination of the token to use, if applicable (default for IOTA is `micro`, SMR is `glow`)
119127
- `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)
120128
- `metadata` - a string of text to embed as metadata in the transaction
121129
- `tag` - a string to tag the transaction for indexing purposes
122130
- `giftStorageDeposit` - gifts the tokens used in funding the storage deposit for a transaction
123131
- `disableToggleGift` - prevents the user from being able to toggle the option to gift the storage deposit
124132
- `disableChangeExpiration` - prevents the user from being able to change the expiration time of the transaction
125133
- `surplus` - send additional amounts of the base token when transferring native tokens
134+
- `expiration` - the expiration time of the transaction, e.g. `1w`, `2d`, `5h` or `10m`. Also accepts a UNIX timestamp in milliseconds.
126135

127136
Example:
128137

129-
[!button Click me!](firefly://wallet/sendForm?address=iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx&amount=10&unit=Gi&giftStorageDeposit=true&surplus=1&metadata=Take%20my%20money)
138+
[!button Click me!](firefly://wallet/sendConfirmation?address=iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx&amount=10&unit=Gi&giftStorageDeposit=true&surplus=1&metadata=Take%20my%20money&expiration=1h)
130139

131140
Source:
132141

133142
```
134-
firefly://wallet/sendConfirmation?address=iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx&amount=10&unit=Gi&giftStorageDeposit=true&disableToggleGift=true&surplus=1&metadata=Take%20my%20money
143+
firefly://wallet/sendConfirmation?address=iota1qrhacyfwlcnzkvzteumekfkrrwks98mpdm37cj4xx3drvmjvnep6xqgyzyx&amount=10&unit=Gi&giftStorageDeposit=true&disableToggleGift=true&surplus=1&metadata=Take%20my%20money&expiration=1h
135144
```
136145

137146
### Collectibles
-70.8 KB
Loading

docs/static/send-form-popup.png

-39.3 KB
Loading

0 commit comments

Comments
 (0)