Skip to main content

TypeAlias.KeybanClientConfig

type KeybanClientConfig: {
accessTokenProvider: () => string | Promise<string>;
apiUrl: string;
appId: string;
chain: KeybanChain;
clientShareKeyProvider: () => JsonWebKey | Promise<JsonWebKey>;
};

Configuration options for the Keyban client.

Type declaration

NameTypeDescription
accessTokenProvider() => string | Promise<string>A function that provides the access token, either synchronously or asynchronously.
apiUrl?stringThe base URL of the API. Optional. Defaults to "https://api.keyban.io" if not provided.
appIdstringThe application ID.
chainKeybanChainThe blockchain configuration for Keyban.
clientShareKeyProvider() => JsonWebKey | Promise<JsonWebKey>A function that provides the client share encryption key, either synchronously or asynchronously.