Skip to main content

TypeAlias.KeybanClientConfig

type KeybanClientConfig = {
api?: IKeybanApi;
apiUrl?: URL | string;
appId: string;
clientShareProvider?: ClientShareProvider;
network: Network;
};

Configuration options for initializing the Keyban client.

Properties

PropertyTypeDescription
api?IKeybanApiAn optional API implementation to use instead of the default iframe-based one. Pass this to use the SDK in non-browser environments (e.g., Node.js).
apiUrl?URL | stringThe base URL of the API. Optional. Defaults to "https://api.prod.keyban.io" if not provided.
appIdstringThe application ID.
clientShareProvider?ClientShareProviderThe client share provider.
networkNetworkThe blockchain configuration for Keyban.