Class: SignClient

Hierarchy

• ISignClient

  ↳ SignClient

Constructors

constructor

• new SignClient(opts?): SignClient

Parameters

Name	Type
opts?	Options

Returns

SignClient

Overrides

ISignClient.constructor

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:15

Properties

approve

• approve: (params: ApproveParams) => Promise<{ acknowledged: () => Promise<Struct> ; topic: string }>

Type declaration

▸ (params): Promise<{ acknowledged: () => Promise<Struct> ; topic: string }>

Parameters

Name	Type
params	ApproveParams

Returns

Promise<{ acknowledged: () => Promise<Struct> ; topic: string }>

Overrides

ISignClient.approve

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:25

---

connect

• connect: (params: ConnectParams) => Promise<{ approval: () => Promise<Struct> ; uri?: string }>

Type declaration

▸ (params): Promise<{ approval: () => Promise<Struct> ; uri?: string }>

Parameters

Name	Type
params	ConnectParams

Returns

Promise<{ approval: () => Promise<Struct> ; uri?: string }>

Overrides

ISignClient.connect

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:23

---

core

• core: ICore

Overrides

ISignClient.core

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:7

---

disconnect

• disconnect: (params: DisconnectParams) => Promise<void>

Type declaration

▸ (params): Promise<void>

Parameters

Name	Type
params	DisconnectParams

Returns

Promise<void>

Overrides

ISignClient.disconnect

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:33

---

emit

• emit: (params: EmitParams) => Promise<void>

Type declaration

▸ (params): Promise<void>

Parameters

Name	Type
params	EmitParams

Returns

Promise<void>

Overrides

ISignClient.emit

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:32

---

engine

• engine: IEngine

Overrides

ISignClient.engine

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:10

---

events

• events: ISignClientEvents

Overrides

ISignClient.events

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:9

---

extend

• extend: (params: ExtendParams) => AcknowledgedPromise

Type declaration

▸ (params): AcknowledgedPromise

Parameters

Name	Type
params	ExtendParams

Returns

AcknowledgedPromise

Overrides

ISignClient.extend

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:28

---

find

• find: (params: FindParams) => Struct[]

Type declaration

▸ (params): Struct[]

Parameters

Name	Type
params	FindParams

Returns

Struct[]

Overrides

ISignClient.find

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:34

---

getPendingSessionRequests

• getPendingSessionRequests: () => Struct[]

Type declaration

▸ (): Struct[]

Returns

Struct[]

Overrides

ISignClient.getPendingSessionRequests

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:35

---

initialize

• Private initialize: any

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:36

---

logger

• logger: Logger

Overrides

ISignClient.logger

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:8

---

metadata

• Readonly metadata: Metadata

Overrides

ISignClient.metadata

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:6

---

name

• Readonly name: string

Overrides

ISignClient.name

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:5

---

off

• off: <E>(event: E, listener: (args: EventArguments[E]) => any) => this

Type declaration

▸ <E>(event, listener): this

Type parameters

Name	Type
E	extends Event

Parameters

Name	Type
event	E
listener	(args: EventArguments[E]) => any

Returns

this

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:20

---

on

• on: <E>(event: E, listener: (args: EventArguments[E]) => any) => this

Type declaration

▸ <E>(event, listener): this

Type parameters

Name	Type
E	extends Event

Parameters

Name	Type
event	E
listener	(args: EventArguments[E]) => any

Returns

this

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:18

---

once

• once: <E>(event: E, listener: (args: EventArguments[E]) => any) => this

Type declaration

▸ <E>(event, listener): this

Type parameters

Name	Type
E	extends Event

Parameters

Name	Type
event	E
listener	(args: EventArguments[E]) => any

Returns

this

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:19

---

opts

• Optional opts: Options

Inherited from

ISignClient.opts

Defined in

node_modules/@walletconnect/sign-client/node_modules/@walletconnect/types/dist/types/sign-client/client.d.ts:79

---

pair

• pair: (params: PairParams) => Promise<Struct>

Type declaration

▸ (params): Promise<Struct>

Parameters

Name	Type
params	PairParams

Returns

Promise<Struct>

Overrides

ISignClient.pair

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:24

---

pendingRequest

• pendingRequest: IPendingRequest

Overrides

ISignClient.pendingRequest

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:13

---

ping

• ping: (params: PingParams) => Promise<void>

Type declaration

▸ (params): Promise<void>

Parameters

Name	Type
params	PingParams

Returns

Promise<void>

Overrides

ISignClient.ping

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:31

---

proposal

• proposal: IProposal

Overrides

ISignClient.proposal

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:12

---

protocol

• Readonly protocol: "wc"

Overrides

ISignClient.protocol

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:3

---

reject

• reject: (params: RejectParams) => Promise<void>

Type declaration

▸ (params): Promise<void>

Parameters

Name	Type
params	RejectParams

Returns

Promise<void>

Overrides

ISignClient.reject

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:26

---

removeAllListeners

• removeAllListeners: <E>(event: E) => this

Type declaration

▸ <E>(event): this

Type parameters

Name	Type
E	extends Event

Parameters

Name	Type
event	E

Returns

this

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:22

---

removeListener

• removeListener: <E>(event: E, listener: (args: EventArguments[E]) => any) => this

Type declaration

▸ <E>(event, listener): this

Type parameters

Name	Type
E	extends Event

Parameters

Name	Type
event	E
listener	(args: EventArguments[E]) => any

Returns

this

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:21

---

request

• request: <T>(params: RequestParams) => Promise<T>

Type declaration

▸ <T>(params): Promise<T>

Type parameters

Name
T

Parameters

Name	Type
params	RequestParams

Returns

Promise<T>

Overrides

ISignClient.request

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:29

---

respond

• respond: (params: RespondParams) => Promise<void>

Type declaration

▸ (params): Promise<void>

Parameters

Name	Type
params	RespondParams

Returns

Promise<void>

Overrides

ISignClient.respond

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:30

---

session

• session: ISession

Overrides

ISignClient.session

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:11

---

update

• update: (params: UpdateParams) => AcknowledgedPromise

Type declaration

▸ (params): AcknowledgedPromise

Parameters

Name	Type
params	UpdateParams

Returns

AcknowledgedPromise

Overrides

ISignClient.update

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:27

---

version

• Readonly version: 2

Overrides

ISignClient.version

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:4

Accessors

context

• get context(): string

Returns

string

Overrides

ISignClient.context

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:16

---

pairing

• get pairing(): IPairingStore

Returns

IPairingStore

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:17

Methods

init

▸ init(opts?): Promise<SignClient>

Parameters

Name	Type
opts?	Options

Returns

Promise<SignClient>

Defined in

node_modules/@walletconnect/sign-client/dist/types/client.d.ts:14