@reservoir0x/relay-kit-ui
Version:
Relay is the Fastest and Cheapest Way to Bridge and Transact Across Chains.
58 lines • 2.25 kB
TypeScript
import type { FC, ReactNode } from 'react';
import type { RelayClientOptions, paths } from '@reservoir0x/relay-sdk';
import type { RelayKitTheme } from '../themes/index.js';
export type AppFees = paths['/quote']['post']['requestBody']['content']['application/json']['appFees'];
type RelayKitProviderOptions = {
/**
* The name of the application
*/
appName?: string;
/**
* An array of fee objects composing of a recipient address and the fee in BPS
*/
appFees?: AppFees;
duneConfig?: {
/**
* The base url for the dune api, if omitted the default will be used. Override this config to protect your api key via a proxy.
*/
apiBaseUrl?: string;
/**
* This key is used to fetch token balances, to improve the general UX and suggest relevant tokens
* Can be omitted and the ui will continue to function. Refer to the dune docs on how to get an api key
*/
apiKey?: string;
};
/**
* Disable the powered by reservoir footer
*/
disablePoweredByReservoir?: boolean;
/**
* An objecting mapping either a VM type (evm, svm, bvm) or a chain id to a connector key (metamask, backpacksol, etc).
* Connector keys are used for differentiating which wallet maps to which vm/chain.
* Only relevant for eclipse/solana at the moment.
*/
vmConnectorKeyOverrides?: {
[key in number | 'evm' | 'svm' | 'bvm']?: string[];
};
/**
* An array of private chain ids to be used when querying the chains api within relay kit.
*/
privateChainIds?: string[];
/**
* The icon theme to use for the chain icons. Defaults to light.
*/
themeScheme?: 'dark' | 'light';
};
export interface RelayKitProviderProps {
children: ReactNode;
options: RelayClientOptions & RelayKitProviderOptions;
theme?: RelayKitTheme;
}
export declare const ProviderOptionsContext: import("react").Context<RelayKitProviderOptions>;
export type ThemeOverridesMap = {
[key: string]: string | ThemeOverridesMap;
};
export declare const themeOverrides: ThemeOverridesMap;
export declare const RelayKitProvider: FC<RelayKitProviderProps>;
export {};
//# sourceMappingURL=RelayKitProvider.d.ts.map