References

Enumerations

Enumeration	Description
KeybanChain	The `KeybanChain` enumeration defines the various blockchain networks supported by the Keyban SDK. Each member of the enumeration represents a specific blockchain network identified by its unique name.
SdkErrorTypes	Enum representing all possible SDK error types.

Class	Description
KeybanBaseError	The `KeybanBaseError` class serves as the foundational structure for all custom errors within the Keyban SDK. It extends the native JavaScript `Error` class, providing additional properties to enrich error handling with more context and information.
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.
KeybanClientShareProvider	A client share provider implementation for the Keyban client.
SdkError	Class representing an SDK-specific error.

Interface	Description
ClientShareProvider	Represents a storage provider for the client share.
KeybanAccount	A `KeybanAccount` represents a user's account in the Keyban system. It provides methods to interact with the blockchain, including signing messages, fetching balances, transferring tokens, and estimating transaction costs.

Type alias	Description
Address	Represents an Ethereum address in hexadecimal format.
AuthConnection	Represents the types of authentication connections available.
Balance	Represents a balance with optional metadata.
EstimateERC20TransferParams	Represents the parameters required to estimate an ERC20 token transfer, excluding the transaction options.
EstimateNftTransferParams	Parameters required to estimate the transfer of an NFT, excluding transaction options.
FeesEstimation	Represents the estimation of fees for a transaction.
FeesUnit	Represents the unit of fees in a specific blockchain.
GqlwalletTokenBalancesQuery	-
Hash	Represents a cryptographic hash value in hexadecimal format.
Hex	Represents a hexadecimal value in blockchain-related contexts.
KeybanApiStatus	Represents the status of the Keyban API.
KeybanAssetTransfer	-
KeybanClientConfig	Configuration options for initializing the Keyban client.
KeybanNftBalance	-
KeybanToken	-
KeybanTokenBalance	-
KeybanUser	-
NativeCurrency	Represents the native currency of a blockchain network.
PaginationArgs	Arguments for paginating a collection.
TransactionOptions	Represents the options for a transaction. see KeybanAccount#transfer
TransferERC20Params	Represents the parameters for transferring ERC20 tokens.
TransferNftParams	Represents the parameters for transferring ERC721 and ERC1155 tokens.

Function	Description
formatBalance	Formats the balance into a human-readable string with the appropriate decimals and symbol.