Skip to main content

KeybanClient

Main client for interacting with the Keyban API and associated services.

See​

useKeybanClient

Constructors​

new KeybanClient()​

new KeybanClient(config): KeybanClient

Creates a new instance of KeybanClient.

Parameters​

• config: KeybanClientConfig

The configuration object to initialize the client.

Returns​

KeybanClient

Defined in​

packages/sdk-base/src/client.ts:94

Properties​

apiUrl​

apiUrl: string;

The Keyban API URL, defaulting to "https://api.keyban.io".

Defined in​

packages/sdk-base/src/client.ts:71

appId​

appId: string;

Defined in​

packages/sdk-base/src/client.ts:72

chain​

chain: KeybanChain;

The blockchain used by Keyban.

Defined in​

packages/sdk-base/src/client.ts:73

nativeCurrency​

nativeCurrency: object;

decimals​

decimals: number;

name​

name: string;

symbol​

symbol: string;

Defined in​

packages/sdk-base/src/client.ts:74

Methods​

apiStatus()​

apiStatus(): Promise<KeybanApiStatus>

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

Returns​

Promise<KeybanApiStatus>

  • The API status, either "operational" or "down".

Defined in​

packages/sdk-base/src/client.ts:272

getBalance()​

getBalance(address): Promise<bigint>

Retrieves the balance for a given address.

Parameters​

• address: `0x${string}`

The address for which to retrieve the balance.

Returns​

Promise<bigint>

  • A promise resolving to the balance as a BigInt.

Defined in​

packages/sdk-base/src/client.ts:238

getNft()​

getNft(address): Promise<object[]>

Parameters​

• address: `0x${string}`

Returns​

Promise<object[]>

ERC721 and ERC1155 tokens of the account.

Defined in​

packages/sdk-base/src/client.ts:258

getTokenBalances()​

getTokenBalances(address): Promise<object[]>

Parameters​

• address: `0x${string}`

Returns​

Promise<object[]>

An account balance in ERC20 tokens.

Defined in​

packages/sdk-base/src/client.ts:246

initialize()​

initialize(): Promise<KeybanAccount>

Initializes a KeybanAccount associated with a specific key ID.

Returns​

Promise<KeybanAccount>

  • A promise that resolves to an instance of KeybanAccount.

Defined in​

packages/sdk-base/src/client.ts:133