UI
RelayKitProvider
UI
RelayKitProvider
The provider to setup RelayKit UI
Parameters
| Parameter | Description | Required |
|---|---|---|
| options | An object representing options that customize the underlying RelayKit SDK and RelayKit UI. A full list of options can be found below. | ✅ |
| theme | A theme object representing overrides for the default styles | ❌ |
Options
| Option | Description | Required |
|---|---|---|
| duneConfig.apiKey | This key is used to fetch token balances to improve the general user experience and suggest relevant tokens to the user. If omitted the flow will continue to work but balances may be missing from the token selection flow. Refer to the Dune docs on how to get an API key. | ❌ |
| duneConfig.apiBaseUrl | If you prefer to obfuscate and protect your api key, you can pass in a custom endpoint which will be used to fetch the data. In your proxy you can then add the api key and do any additional checks before sending to the dune api. | ❌ |
| disablePoweredByReservoir | A boolean which disables the powered by Reservoir footer | ❌ |
| appName | The name of your application, used in the ui to contextualize actions | ❌ |
| appFees | An array of objects representing fees. Each object should contains a recipient wallet address and a fee in bps (e.g. 100 = 1%). | ❌ |
The options are also a combination of all the parameters passed to the RelayKit SDK. An sdk instance with these options is created when using this provider.