Class PKPWalletConnect

Constructors

constructor

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

Properties

approveSession

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

Approve a session proposal from a dapp

Type declaration

- (params): Promise<Struct>
- Parameters
  - params: {
        id: number;
        namespaces: Record<string, BaseNamespace>;
        relayProtocol?: string;
    }
    - id: number
    - namespaces: Record<string, BaseNamespace>
    - OptionalrelayProtocol?: string
  Returns Promise<Struct>
  - The session data

disconnectSession

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

Disconnect a WalletConnect session

Type declaration

- (params): Promise<void>
- Parameters
  - params: {
    reason: ErrorResponse;
    topic: string;
    }
    - reason: ErrorResponse
    - topic: string
  Returns Promise<void>

emitSessionEvent

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

Emit session events

Type declaration

- (params): Promise<void>
- Parameters
  - params: {
        chainId: string;
        event: any;
        topic: string;
    }
    - chainId: string
    - event: any
    - topic: string
  Returns Promise<void>

extendSession

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

Extend WalletConnect session by updating session expiry

Type declaration

- (params): Promise<void>
- Parameters
  - params: {
    topic: string;
    }
    - topic: string
  Returns Promise<void>

getActiveSessions

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

Get active sessions

Type declaration

- (): Record<string, Struct>
- Returns Record<string, Struct>

getPendingSessionProposals

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

Get pending session proposals

Type declaration

- (): Record<number, Struct>
- Returns Record<number, Struct>

getPendingSessionRequests

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

Get pending session requests

Type declaration

- (): Struct[]
- Returns Struct[]

pair

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

Pair with the given URI received from a dapp

rejectSession

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

Reject a session proposal from a dapp

Type declaration

- (params): Promise<void>
- Parameters
  - params: {
    id: number;
    reason: ErrorResponse;
    }
    - id: number
    - reason: ErrorResponse
  Returns Promise<void>

respondSessionRequest

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

Respond to a session request received from a dapp

updateSession

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

Update WalletConnect session namespaces

Type declaration

- (params): Promise<void>
- Parameters
  - params: {
    namespaces: Namespaces;
    topic: string;
    }
    - namespaces: Namespaces
    - topic: string
  Returns Promise<void>

Methods

addPKPEthersWallet

addPKPEthersWallet(pkpEthersWallet): void
Add a PKPEthersWallet to list of PKPEthersWallet if not already added
Parameters
- pkpEthersWallet: PKPEthersWallet
  The PKPEthersWallet instance
Returns void
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:650

approveSessionProposal

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

approveSessionRequest

approveSessionRequest(requestEvent): 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:305

checkIfChainIsSupported

checkIfChainIsSupported(chain): boolean
Check if chain is supported by Lit
Parameters
- chain: string
  Chain in CAIP-2 format
Returns boolean
- True if chain is supported, false otherwise
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:602

filterUnsupportedMethods

filterUnsupportedMethods(methods): string[]
Parameters
- methods: string[]
Returns string[]
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:619

findPKPEthersWalletByRequestParams

findPKPEthersWalletByRequestParams(params): Promise<PKPEthersWallet>
Find PKPEthersWallet by request event params
Parameters
- params: unknown
  Request event params
Returns Promise<PKPEthersWallet>
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:629

getAccounts

getAccounts(chainName): Promise<string[]>
Get addresses by chain name
Parameters
- chainName: string
  Chain in CAIP-2 namespace
Returns Promise<string[]>
- Array of addresses
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:553

getAccountsWithPrefix

getAccountsWithPrefix(chain): Promise<string[]>
Return list of addresses with namespace prefix given a chain
Parameters
- chain: string
  Chain in CAIP-2 format
Returns Promise<string[]>
- List of addresses with namespace prefix
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:576

getPKPEthersWallets

getPKPEthersWallets(): PKPEthersWallet[]
Get current list of PKPEthersWallet

Returns PKPEthersWallet[]
- List of PKPEthersWallet
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:664

getSignClient

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

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

initWalletConnect

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

off

off<E>(name, listener): EventEmitter
Type Parameters
- E extends Event
Parameters
- name: E
- listener: ((args: EventArguments[E]) => void)
  - - (args): void
    - Parameters
      args: EventArguments[E]
      Returns void
Returns EventEmitter
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:528

on

on<E>(name, listener): EventEmitter
Type Parameters
- E extends Event
Parameters
- name: E
- listener: ((args: EventArguments[E]) => void)
  - - (args): void
    - Parameters
      args: EventArguments[E]
      Returns void
Returns EventEmitter
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:512

once

once<E>(name, listener): EventEmitter
Type Parameters
- E extends Event
Parameters
- name: E
- listener: ((args: EventArguments[E]) => void)
  - - (args): void
    - Parameters
      args: EventArguments[E]
      Returns void
Returns EventEmitter
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:520

rejectSessionProposal

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

rejectSessionRequest

rejectSessionRequest(requestEvent, reason?): 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
- Optionalreason: ErrorResponse
  The reason for rejecting the session request
Returns Promise<void>
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:375

removeListener

removeListener<E>(name, listener): EventEmitter
Type Parameters
- E extends Event
Parameters
- name: E
- listener: ((args: EventArguments[E]) => void)
  - - (args): void
    - Parameters
      args: EventArguments[E]
      Returns void
Returns EventEmitter
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:536

setPKPEthersWallets

setPKPEthersWallets(pkpEthersWallets): void
Replace list of PKPEthersWallet
Parameters
- pkpEthersWallets: PKPEthersWallet[]
  List of PKPEthersWallet
Returns void
- Defined in packages/pkp-walletconnect/src/lib/pkp-walletconnect.ts:673

Class PKPWalletConnect

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PKPWalletConnect

Properties

approveSession

Type declaration

Parameters

id: number

namespaces: Record<string, BaseNamespace>

OptionalrelayProtocol?: string

Returns Promise<Struct>

disconnectSession

Type declaration

Parameters

reason: ErrorResponse

topic: string

Returns Promise<void>

emitSessionEvent

Type declaration

Parameters

chainId: string

event: any

topic: string

Returns Promise<void>

extendSession

Type declaration

Parameters

topic: string

Returns Promise<void>

getActiveSessions

Type declaration

Returns Record<string, Struct>

getPendingSessionProposals

Type declaration

Returns Record<number, Struct>

getPendingSessionRequests

Type declaration

Returns Struct[]

pair

rejectSession

Type declaration

Parameters

id: number

reason: ErrorResponse

Returns Promise<void>

respondSessionRequest

updateSession

Type declaration

Parameters

namespaces: Namespaces

topic: string

Returns Promise<void>

Methods

addPKPEthersWallet

Parameters

Returns void

approveSessionProposal

Parameters

Returns Promise<void | Struct>

approveSessionRequest

Parameters

Returns Promise<void>

checkIfChainIsSupported

Parameters

Returns boolean

filterUnsupportedMethods

Parameters

Returns string[]

findPKPEthersWalletByRequestParams

Parameters

Returns Promise<PKPEthersWallet>

getAccounts

Parameters

Returns Promise<string[]>

`Optional`relayProtocol?: string