Class PKPClient

Hierarchy

PKPClient

Index

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:19

Properties

`Private` _wallets

_wallets: Map<string, PKPBase<PKPBaseDefaultParams>> = ...

`Readonly` pkpPubKey

pkpPubKey: string

Methods

`Private` _registerSupportedWallets

_registerSupportedWallets(prop: PKPClientProp): void
Private
Registers supported wallets using the WalletFactory.
Parameters
- prop: PKPClientProp
  
  The properties required for the PKPClient instance.
Returns void
- Defined in packages/pkp-client/src/lib/pkp-client.ts:30

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:98

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:85

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:76

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:67

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:42

getWallet

getWallet<T>(chain: string): T
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.
Type Parameters
- T extends PKPBase<PKPBaseDefaultParams, T> = PKPBase<PKPBaseDefaultParams>
  
  The wallet type, defaults to PKPBase if not provided.
Parameters
- chain: string
  
  The name of the chain for which to retrieve the wallet instance.
Returns T
- Defined in packages/pkp-client/src/lib/pkp-client.ts:54

Class PKPClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

prop: PKPClientProp

Returns PKPClient

Properties

Private _wallets

Readonly pkpPubKey

Methods

Private _registerSupportedWallets

Parameters

prop: PKPClientProp

Returns void

connect

Returns

Returns Promise<{ ready: boolean; res: { chain: string; success: boolean; }[]; }>

getBtcWallet

Returns

Returns never

getCosmosWallet

Returns

Returns PKPCosmosWallet

getEthWallet

Returns

Returns PKPEthersWallet

getSupportedChains

Returns

Returns string[]

getWallet

Returns

Throws

Type Parameters

T extends PKPBase<PKPBaseDefaultParams, T> = PKPBase<PKPBaseDefaultParams>

Parameters

chain: string

Returns T

Settings

Member Visibility

Theme

`Private` _wallets

`Readonly` pkpPubKey

`Private` _registerSupportedWallets

Returns Promise<{
ready: boolean;
res: {
chain: string;
success: boolean;
}[];
}>