Class PKPWalletConnect

Hierarchy

PKPWalletConnect

Constructors

constructor

new PKPWalletConnect(debug?: boolean): PKPWalletConnect
Parameters
- Optional debug: boolean
Returns PKPWalletConnect
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:56

Properties

`Private` `Readonly` PREFIX

PREFIX: "[PKPWalletConnect]" = '[PKPWalletConnect]'

approveSession

approveSession: ((params: {
    id: number;
    namespaces: Record<string, BaseNamespace>;
    relayProtocol?: string;
}) => Promise<Struct>) = ...

Type declaration

- (params: {
      id: number;
      namespaces: Record<string, BaseNamespace>;
      relayProtocol?: string;
  }): Promise<Struct>
- Approve a session proposal from a dapp
  
  Property
  The session ID
  
  Property
  The session namespace
  
  Property
  The relay protocol
  
  Returns
  - The session data
  Parameters
  - params: {
        id: number;
        namespaces: Record<string, BaseNamespace>;
        relayProtocol?: string;
    }
    - id: number
    - namespaces: Record<string, BaseNamespace>
    - Optional relayProtocol?: string
  Returns Promise<Struct>

`Private` client

client: IWeb3Wallet

`Private` `Readonly` debug

debug: boolean = false

disconnectSession

disconnectSession: ((params: {
reason: ErrorResponse;
topic: string;
}) => Promise<void>) = ...

Type declaration

- (params: {
  reason: ErrorResponse;
  topic: string;
  }): Promise<void>
- Disconnect a WalletConnect session
  
  Property
  The session topic
  
  Property
  The reason for disconnecting the session
  
  Returns
  Parameters
  - params: {
    reason: ErrorResponse;
    topic: string;
    }
    - reason: ErrorResponse
    - topic: string
  Returns Promise<void>

emitSessionEvent

emitSessionEvent: ((params: {
    chainId: string;
    event: any;
    topic: string;
}) => Promise<void>) = ...

Type declaration

- (params: {
      chainId: string;
      event: any;
      topic: string;
  }): Promise<void>
- Emit session events
  
  Property
  The session topic
  
  Property
  The session event
  
  Returns
  Parameters
  - params: {
        chainId: string;
        event: any;
        topic: string;
    }
    - chainId: string
    - event: any
    - topic: string
  Returns Promise<void>

extendSession

extendSession: ((params: {
topic: string;
}) => Promise<void>) = ...

Type declaration

- (params: {
  topic: string;
  }): Promise<void>
- Extend WalletConnect session by updating session expiry
  
  Property
  The session topic
  
  Returns
  Parameters
  - params: {
    topic: string;
    }
    - topic: string
  Returns Promise<void>

getActiveSessions

getActiveSessions: (() => Record<string, Struct>) = ...

Type declaration

- (): Record<string, Struct>
- Get active sessions
  
  Returns
  
  Returns Record<string, Struct>

getPendingSessionProposals

getPendingSessionProposals: (() => Record<number, Struct>) = ...

Type declaration

- (): Record<number, Struct>
- Get pending session proposals
  
  Returns
  
  Returns Record<number, Struct>

getPendingSessionRequests

getPendingSessionRequests: (() => Struct[]) = ...

Type declaration

- (): Struct[]
- Get pending session requests
  
  Returns
  
  Returns Struct[]

`Private` `Readonly` orange

orange: "\u001b[33m" = '\x1b[33m'

pair

pair: ((params: {
activatePairing?: boolean;
uri: string;
}) => Promise<void>) = ...

Type declaration

- (params: {
  activatePairing?: boolean;
  uri: string;
  }): Promise<void>
- Pair with the given URI received from a dapp
  Parameters
  - params: {
    activatePairing?: boolean;
    uri: string;
    }
    - Optional activatePairing?: boolean
    - uri: string
  Returns Promise<void>

`Private` pkpClients

pkpClients: PKPClient[] = []

`Private` `Readonly` red

red: "\u001b[31m" = '\x1b[31m'

rejectSession

rejectSession: ((params: {
id: number;
reason: ErrorResponse;
}) => Promise<void>) = ...

Type declaration

- (params: {
  id: number;
  reason: ErrorResponse;
  }): Promise<void>
- Reject a session proposal from a dapp
  
  Property
  The session ID
  
  Property
  The reason for rejecting the session proposal
  
  Returns
  Parameters
  - params: {
    id: number;
    reason: ErrorResponse;
    }
    - id: number
    - reason: ErrorResponse
  Returns Promise<void>

`Private` `Readonly` reset

reset: "\u001b[0m" = '\x1b[0m'

respondSessionRequest

respondSessionRequest: ((params: {
response: JsonRpcResponse<any>;
topic: string;
}) => Promise<void>) = ...

Type declaration

- (params: {
  response: JsonRpcResponse<any>;
  topic: string;
  }): Promise<void>
- Respond to a session request received from a dapp
  Parameters
  - params: {
    response: JsonRpcResponse<any>;
    topic: string;
    }
    - response: JsonRpcResponse<any>
    - topic: string
  Returns Promise<void>

`Private` supportedChains

supportedChains: string[] = ...

updateSession

updateSession: ((params: {
namespaces: Namespaces;
topic: string;
}) => Promise<void>) = ...

Type declaration

- (params: {
  namespaces: Namespaces;
  topic: string;
  }): Promise<void>
- Update WalletConnect session namespaces
  
  Property
  The session topic
  
  Property
  The session namespace
  
  Returns
  Parameters
  - params: {
    namespaces: Namespaces;
    topic: string;
    }
    - namespaces: Namespaces
    - topic: string
  Returns Promise<void>

Methods

`Private` _isWalletConnectInitialized

_isWalletConnectInitialized(client: IWeb3Wallet): IWeb3Wallet
Private
Checks if the given WalletConnect client is initialized and returns it. If it's not initialized, throws an error.

Returns
- The initialized WalletConnect client instance
Throws
- If the WalletConnect client instance is not initialized
Parameters
- client: IWeb3Wallet
  
  The WalletConnect client instance to check for initialization
Returns IWeb3Wallet
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:616

`Private` _log

_log(...args: any[]): void
Private
Logs the provided arguments to the console if the debug property is set to true.
Parameters
- Rest ...args: any[]
  
  The arguments to log to the console.
Returns void
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:634

`Private` _throwError

_throwError(message: string): never
Logs an error message to the console and throws an Error with the same message.

Returns
- This function does not return a value since it always throws an Error.
Parameters
- message: string
  
  The error message to be logged and thrown.
Returns never
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:647

addPKPClient

addPKPClient(pkpClient: PKPClient): void
Add a PKPClient to list of PKPClients if not already added
Parameters
- pkpClient: PKPClient
  
  The PKPClient instance
Returns void
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:579

approveSessionProposal

approveSessionProposal(proposal: {
verifyContext: Context;
} & Omit<BaseEventArgs<Struct>, "topic">): Promise<void | Struct>
Parse the session proposal received from a dapp, construct the session namespace, and approve the session proposal if the chain is supported.

Returns
- The session data if approved
Parameters
- proposal: {
  verifyContext: Context;
  } & Omit<BaseEventArgs<Struct>, "topic">
  
  The session proposal
Returns Promise<void | Struct>
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:107

approveSessionRequest

approveSessionRequest(requestEvent: {
    verifyContext: Context;
} & BaseEventArgs<{
    chainId: string;
    request: {
        method: string;
        params: any;
    };
}>): Promise<void>
Approves a session request received from a dapp, processes the request using the wallet corresponding to the account in the request, and sends a response with the result or an error.
Parameters
- requestEvent: {
      verifyContext: Context;
  } & BaseEventArgs<{
      chainId: string;
      request: {
          method: string;
          params: any;
      };
  }>
  
  The session request
Returns Promise<void>
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:244

checkIfChainIsSupported

checkIfChainIsSupported(chain: string): boolean
Check if chain is supported by Lit

Returns
- True if chain is supported, false otherwise
Parameters
- chain: string
  
  Chain in CAIP-2 format
Returns boolean
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:535

findPKPClientByRequestParams

findPKPClientByRequestParams(params: any): Promise<PKPClient>
Find PKPClient by request event params
Parameters
- params: any
  
  Request event params
Returns Promise<PKPClient>
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:557

getAccounts

getAccounts(chainName: string): Promise<string[]>
Get addresses by chain name

Returns
- Array of addresses
Parameters
- chainName: string
  
  Chain in CAIP-2 namespace
Returns Promise<string[]>
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:475

getAccountsWithPrefix

getAccountsWithPrefix(chain: string): Promise<string[]>
Return list of addresses with namespace prefix given a chain

Returns
- List of addresses with namespace prefix
Parameters
- chain: string
  
  Chain in CAIP-2 format
Returns Promise<string[]>
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:504

getPKPClients

getPKPClients(): PKPClient[]
Get current list of PKPClients

Returns
- List of PKPClients
Returns PKPClient[]
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:593

getSignClient

getSignClient(): ISignClient
Get the Sign Client that is initialized on the WalletConnect client

Returns
- SignClient instance
Returns ISignClient
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:436

initWalletConnect

initWalletConnect(params: InitWalletConnectParams): Promise<void>
Initializes the WalletConnect client
Parameters
- params: InitWalletConnectParams
Returns Promise<void>
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:67

off

off(name: Event, listener: ((args: any) => void)): any
Parameters
- name: Event
- listener: ((args: any) => void)
  - - (args: any): void
    - Parameters
      
      args: any
      
      Returns void
Returns any
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:453

on

on(name: Event, listener: ((args: any) => void)): any
Parameters
- name: Event
- listener: ((args: any) => void)
  - - (args: any): void
    - Parameters
      
      args: any
      
      Returns void
Returns any
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:443

once

once(name: Event, listener: ((args: any) => void)): any
Parameters
- name: Event
- listener: ((args: any) => void)
  - - (args: any): void
    - Parameters
      
      args: any
      
      Returns void
Returns any
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:448

rejectSessionProposal

rejectSessionProposal(proposal: {
verifyContext: Context;
} & Omit<BaseEventArgs<Struct>, "topic">, reason?: ErrorResponse): Promise<void>
Parse and reject the session proposal
Parameters
- proposal: {
  verifyContext: Context;
  } & Omit<BaseEventArgs<Struct>, "topic">
  
  The session proposal
- Optional reason: ErrorResponse
  
  The reason for rejecting the session proposal
Returns Promise<void>
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:210

rejectSessionRequest

rejectSessionRequest(requestEvent: {
    verifyContext: Context;
} & BaseEventArgs<{
    chainId: string;
    request: {
        method: string;
        params: any;
    };
}>, reason?: ErrorResponse): Promise<void>
Reject a session request received from a dapp
Parameters
- requestEvent: {
      verifyContext: Context;
  } & BaseEventArgs<{
      chainId: string;
      request: {
          method: string;
          params: any;
      };
  }>
  
  The session request
- Optional reason: ErrorResponse
  
  The reason for rejecting the session request
Returns Promise<void>
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:306

removeListener

removeListener(name: Event, listener: ((args: any) => void)): any
Parameters
- name: Event
- listener: ((args: any) => void)
  - - (args: any): void
    - Parameters
      
      args: any
      
      Returns void
Returns any
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:458

setPKPClients

setPKPClients(clients: PKPClient[]): void
Replace list of PKPClients
Parameters
- clients: PKPClient[]
  
  List of PKPClients
Returns void
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:602

Class PKPWalletConnect

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional debug: boolean

Returns PKPWalletConnect

Properties

Private Readonly PREFIX

approveSession

Type declaration

Property

Property

Property

Returns

Parameters

params: { id: number; namespaces: Record<string, BaseNamespace>; relayProtocol?: string; }

id: number

namespaces: Record<string, BaseNamespace>

Optional relayProtocol?: string

Returns Promise<Struct>

Private client

Private Readonly debug

disconnectSession

Type declaration

Property

Property

Returns

Parameters

params: { reason: ErrorResponse; topic: string; }

reason: ErrorResponse

topic: string

Returns Promise<void>

emitSessionEvent

Type declaration

Property

Property

Returns

Parameters

params: { chainId: string; event: any; topic: string; }

chainId: string

event: any

topic: string

Returns Promise<void>

extendSession

Type declaration

Property

Returns

Parameters

params: { topic: string; }

topic: string

Returns Promise<void>

getActiveSessions

Type declaration

Returns

Returns Record<string, Struct>

getPendingSessionProposals

Type declaration

Returns

Returns Record<number, Struct>

getPendingSessionRequests

Type declaration

Returns

Returns Struct[]

Private Readonly orange

pair

Type declaration

Parameters

params: { activatePairing?: boolean; uri: string; }

Optional activatePairing?: boolean

uri: string

Returns Promise<void>

Private pkpClients

Private Readonly red

rejectSession

Type declaration

`Optional` debug: boolean

`Private` `Readonly` PREFIX

params: {
id: number;
namespaces: Record<string, BaseNamespace>;
relayProtocol?: string;
}

`Optional` relayProtocol?: string

`Private` client

`Private` `Readonly` debug

params: {
reason: ErrorResponse;
topic: string;
}

params: {
chainId: string;
event: any;
topic: string;
}

params: {
topic: string;
}

`Private` `Readonly` orange

params: {
activatePairing?: boolean;
uri: string;
}

`Optional` activatePairing?: boolean

`Private` pkpClients

`Private` `Readonly` red

params: {
id: number;
reason: ErrorResponse;
}

`Private` `Readonly` reset

params: {
response: JsonRpcResponse<any>;
topic: string;
}

`Private` supportedChains

params: {
namespaces: Namespaces;
topic: string;
}

`Private` _isWalletConnectInitialized

`Private` _log

`Rest` ...args: any[]

`Private` _throwError

proposal: {
verifyContext: Context;
} & Omit<BaseEventArgs<Struct>, "topic">

requestEvent: {
verifyContext: Context;
} & BaseEventArgs<{
chainId: string;
request: {
method: string;
params: any;
};
}>