Class.KeybanClient

Main client for interacting with the Keyban API and associated services. This class provides methods to initialize accounts, retrieve balances, query NFTs, and interact with the Keyban blockchain.

Remarks

The KeybanClient serves as the primary interface for developers to interact with the Keyban ecosystem. It handles authentication, communication with the Keyban API, and provides utility methods for common tasks.

Example

// Initialize the client
const client = new KeybanClient({
  apiUrl: "https://api.prod.keyban.io",
  appId: "your-app-id",
  network: KeybanNetwork.EthereumAnvil,
});

// Initialize an account
const account = await client.initialize();

See

KeybanAccount

Extends

• KeybanClientBase

Constructors

Constructor

new KeybanClient(config: KeybanClientConfig): KeybanClient

Creates a new instance of KeybanClient.

Parameters

Parameter	Type	Description
config	KeybanClientConfig	The configuration object to initialize the client.

Returns

KeybanClient

Throws

If the configuration is invalid.

Example

const client = new KeybanClient({
  apiUrl: "https://api.prod.keyban.io",
  appId: "your-app-id",
  network: KeybanNetwork.EthereumAnvil,
});

Overrides

KeybanClientBase.constructor

Properties

Property	Type	Description	Inherited from
apiUrl	URL	The Keyban API URL, defaulting to "https://api.prod.keyban.io".	KeybanClientBase.apiUrl
apolloClient	ApolloClient<NormalizedCacheObject>	The Apollo GraphQL client used for making API requests.	KeybanClientBase.apolloClient
appId	string	The application ID used for authentication with the Keyban API.	KeybanClientBase.appId
network	KeybanNetwork	The blockchain used by Keyban.	KeybanClientBase.network

Accessors

feesUnit

Get Signature

get feesUnit(): FeesUnit

Retrieves the fee unit configuration based on the current blockchain chain.

This getter returns an object that maps supported blockchain chains to their respective fee unit details, including the currency symbol and the number of decimal places. The fee unit is selected according to the chain specified in this.chain.

Remarks

Supported configurations include:

• EthereumAnvil & PolygonAmoy with unit "gwei" and 9 decimals.
• StarknetDevnet, StarknetSepolia, & StarknetMainnet with unit "FRI" and 18 decimals.
• StellarTestnet with unit "stroop" and 6 decimals.

Returns

FeesUnit

An object containing the fee unit configuration for the active chain.

Inherited from

KeybanClientBase.feesUnit

---

nativeCurrency

Get Signature

get nativeCurrency(): NativeCurrency

Retrieves the native currency details associated with the current chain.

This getter returns an object that includes the native currency's name, symbol, and decimal precision for the respective blockchain as defined by the this.chain property. Each blockchain in the supported list (e.g., EthereumAnvil, PolygonAmoy, StarknetDevnet, etc.) has its unique configuration, which is used to construct the returned object.

Returns

NativeCurrency

The native currency information for the current chain.

Inherited from

KeybanClientBase.nativeCurrency

Methods

apiStatus()

apiStatus(): Promise<KeybanApiStatus>

Performs a health check on the Keyban API to determine its operational status.

Returns

Promise<KeybanApiStatus>

• A promise resolving to the API status, either "operational" or "down".

Example

const status = await client.apiStatus();
console.log(`API Status: ${status}`);

Throws

Throws an error if the health check request fails.

See

KeybanApiStatus

Inherited from

KeybanClientBase.apiStatus

---

getUser()

getUser(): Promise<null | KeybanUser>

Retrieves the current user information.

Returns

Promise<null | KeybanUser>

A Promise resolving with the user data retrieved from the server.

Inherited from

KeybanClientBase.getUser

---

initialize()

initialize(): Promise<KeybanAccount>

Initializes a KeybanAccount associated with the current client. This method sets up the account by retrieving or generating the client share, and prepares the account for transactions and other operations.

Returns

Promise<KeybanAccount>

• A promise that resolves to an instance of KeybanAccount.

Throws

If initialization fails due to signing errors.

Example

const account = await client.initialize();
console.log(`Account address: ${account.address}`);

See

KeybanAccount

Overrides

KeybanClientBase.initialize

---

isAuthenticated()

isAuthenticated(): Promise<boolean>

Checks whether the client is authenticated.

Returns

Promise<boolean>

A Promise that resolves to the result of the authentication check.

Inherited from

KeybanClientBase.isAuthenticated

---

login()

login(connection?: AuthConnection): Promise<void>

Initiates the login process by opening a popup window for user authentication.

Parameters

Parameter	Type	Description
connection?	AuthConnection	Optional authentication connection details.

Returns

Promise<void>

• A promise that resolves when the user is authenticated or the popup is closed.

Inherited from

KeybanClientBase.login

---

logout()

logout(): Promise<void>

Returns

Promise<void>

Inherited from

KeybanClientBase.logout