Class PKPClient

Hierarchy

PKPClient

Index

Constructors

Properties

cosmosWallet ethWallet pkpPubKey

Methods

connect getBtcWallet getCosmosWallet getEthWallet getSupportedChains getWallet

Constructors

constructor

new PKPClient(prop: PKPClientProp): PKPClient
Constructs a new PKPClient instance with the provided properties. Automatically registers supported wallets.
Parameters
- prop: PKPClientProp
  
  The properties required for the PKPClient instance.
Returns PKPClient
- Defined in packages/pkp-client/src/lib/pkp-client.ts:23

Properties

`Private` cosmosWallet

cosmosWallet: PKPCosmosWallet

`Private` ethWallet

ethWallet: PKPEthersWallet

`Readonly` pkpPubKey

pkpPubKey: string

Methods

connect

connect(): Promise<{
    ready: boolean;
    res: {
        chain: string;
        success: boolean;
    }[];
}>
Connects all wallets and returns an object containing the overall readiness status and an array of the initialization status for each wallet.

Returns
An object containing the overall readiness status (ready) and an array (res) with the initialization status for each wallet.

Returns Promise<{
    ready: boolean;
    res: {
        chain: string;
        success: boolean;
    }[];
}>
- Defined in packages/pkp-client/src/lib/pkp-client.ts:104

getBtcWallet

getBtcWallet(): never
Retrieves the Bitcoin wallet instance.

Returns
Will throw an error as Bitcoin is not supported yet.

Returns never
- Defined in packages/pkp-client/src/lib/pkp-client.ts:91

getCosmosWallet

getCosmosWallet(): PKPCosmosWallet
Retrieves the Cosmos wallet instance.

Returns
The Cosmos wallet instance.

Returns PKPCosmosWallet
- Defined in packages/pkp-client/src/lib/pkp-client.ts:82

getEthWallet

getEthWallet(): PKPEthersWallet
Retrieves the Ethereum wallet instance.

Returns
The Ethereum wallet instance.

Returns PKPEthersWallet
- Defined in packages/pkp-client/src/lib/pkp-client.ts:73

getSupportedChains

getSupportedChains(): string[]
Returns a list of supported chains.

Returns
An array of supported chain names.

Returns string[]
- Defined in packages/pkp-client/src/lib/pkp-client.ts:35

getWallet

getWallet(chain: "eth"): PKPEthersWallet
Retrieves the wallet instance for a specific chain.

Returns
The wallet instance for the specified chain.

Throws
Will throw an error if the chain is not supported.
Parameters
- chain: "eth"
  
  The name of the chain for which to retrieve the wallet instance.
Returns PKPEthersWallet
- Defined in packages/pkp-client/src/lib/pkp-client.ts:47
getWallet(chain: "cosmos"): PKPCosmosWallet
Parameters
- chain: "cosmos"
Returns PKPCosmosWallet
- Defined in packages/pkp-client/src/lib/pkp-client.ts:48

Generated using TypeDoc