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. |
Classes
| Class | Description |
|---|---|
| KeybanAccount | The KeybanAccount class 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. |
| 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. |
| SdkError | Class representing an SDK-specific error. |
Interfaces
| Interface | Description |
|---|---|
| FeesUnit | Represents the unit of fees in a specific blockchain. |
Type Aliases
| Type alias | Description |
|---|---|
| Address | Represents an Ethereum address in hexadecimal format. |
| Balance | Represents a balance with optional metadata. |
| EncryptedData | Type representing the encrypted data. |
| 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. |
| 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 the Keyban client. |
| KeybanNftBalance | - |
| KeybanToken | - |
| KeybanTokenBalance | - |
| 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. |
Functions
| Function | Description |
|---|---|
| decrypt | Decrypts the given encrypted data using the provided key. |
| encrypt | Encrypts the given data using the provided JsonWebKey. |
| formatBalance | Formats the balance into a human-readable string with the appropriate decimals and symbol. |
| generateKey | Generates a cryptographic key and exports it in JSON Web Key (JWK) format. |