From 8128294473de30ee229f81eca66033b335da1df9 Mon Sep 17 00:00:00 2001 From: Mircea Gavriliu Date: Mon, 8 Jan 2024 10:37:19 +0200 Subject: [PATCH] chore: update docs for url schemes --- docs/apps/05-url-schemes.mdx | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/docs/apps/05-url-schemes.mdx b/docs/apps/05-url-schemes.mdx index 676437c2..51c39c8a 100644 --- a/docs/apps/05-url-schemes.mdx +++ b/docs/apps/05-url-schemes.mdx @@ -65,19 +65,22 @@ level. For situations when an alias cannot be used, we fallback to the following Using URL query parameters, integrators can suggest a set of values for the fields of the Create Single Stream form. Here's a list of all supported values (to be appended to the create form link): -| Parameter | Type | Description | Example | -| :--------- | :------ | :-------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| shape | String | Type of payment | `linear`, `cliff`, `dynamicExponential`, `dynamicExponentialCliff`, `dynamicStepper` | -| chainId | Number | Defaults to the connected chain | `1`, `10`, `42161` or any other supported [chain](/contracts/v2/deployments) | -| token | String | Address of the asset | `0x6b17...1d0f` ([DAI](https://etherscan.io/token/0x6b175474e89094c44da98b954eedeac495271d0f)) | -| cancelable | Boolean | If a stream is cancelable or not, defaults to `true` | `true`, `false` | -| recipient | String | Recipient's address or ENS | `0x12...AB`, `vitalik.eth` | -| isDuration | Boolean | If the time is set to a duration or a fixed range, defaults to `true` | `true`, `false` | -| duration | Number | Stream duration in seconds, read only if `isDuration` is true | `86400` (1 day) | -| start | Number | Start date in seconds, read only if `isDuration` is false | `1692009403` | -| end | Number | End date in seconds, read only if `isDuration` is false | `1702000403` | -| cliff | Number | Cliff duration or the cliff end date as a Unix timestamp in seconds (depends on `isDuration` and `shape`) | `1296000` (12 hours) | -| steps | Number | Number of steps for the `dynamicStepper` shape. | `2`, `3`, `4`, etc. | +| Parameter | Description | Example | +| :----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- | +| shape | String - type of stream | `linear`, `cliff`, `dynamicExponential`, `dynamicExponentialCliff`, `dynamicStepper`, `dynamicTimelock`, `dynamicUnlockLinear`, `dynamicUnlockCliff` | +| chainId | Number - defaults to the connected chain | `1`, `10`, `42161` or any other support [chain](/contracts/v2/deployments). | +| token | String - address of the asset | `0x6b17...1d0f` ([DAI](https://etherscan.io/token/0x6b175474e89094c44da98b954eedeac495271d0f) on Ethereum) or any other ERC20 token address | +| cancelable | Boolean - if a stream is cancelable or not, defaults to `true` | `true`, `false` | +| transferable | Boolean - if a stream is transferable or not, defaults to `true` | `true`, `false` | +| recipient | String - recipient's address or the ENS | `0x12...AB`, `vitalik.eth` | +| isDuration | Boolean - if the time is set to a duration or a range, defaults to `true` | `true` (expecting duration), `false` (expecting range - start / end date) | +| duration | Number - stream duration **in seconds**, read only if `isDuration` is true | `86400` (1 day), `360` (1 hour) | +| start | Number - start date **in seconds**, read only if `isDuration` is false | `1692009403` | +| end | Number - end date **in seconds**, read only if `isDuration` is false | `1702000403` | +| cliff | Number - cliff duration or the cliff end date **in seconds** (depending on the `isDuration` flag, for the cliff-related shapes( `cliff`, `dynamicExponentialCliff`)) | `1296000` (12 hours) | +| steps | Number - number of steps for the `dynamicStepper` shape. | `2`, `3`, `4` etc. | +| months | Number - number of months for the `dynamicMonthly` shape. | `2`, `3`, `4` etc. | +| unlocks | Number - unlock sum for the `dynamicUnlockLinear`, `dynamicUnlockCliff` shapes. | `200`, `300`, `400` etc. | :::info