Client

Class: Client

Client class initiates connection to the XMTP network. Should be created with await Client.create(options)

Constructors

constructor

new Client(keys, apiClient)

Parameters

Name	Type
keys	PrivateKeyBundleV1
apiClient	default

Defined in

Client.ts:136

Properties

_codecs

Private _codecs: Map<string, ContentCodec<any>>

Defined in

Client.ts:133

---

_conversations

Private _conversations: Conversations

Defined in

Client.ts:132

---

_maxContentSize

Private _maxContentSize: number

Defined in

Client.ts:134

---

address

address: string

Defined in

Client.ts:127

---

apiClient

apiClient: default

Defined in

Client.ts:129

---

contacts

Private contacts: Set<string>

Defined in

Client.ts:130

---

keys

keys: PrivateKeyBundleV1

Defined in

Client.ts:128

---

knownPublicKeyBundles

Private knownPublicKeyBundles: Map<string, PublicKeyBundle>

Defined in

Client.ts:131

Accessors

conversations

get conversations(): Conversations

Returns

Conversations

Defined in

Client.ts:150

Methods

canMessage

canMessage(peerAddress): Promise<boolean>

Check if

Peer Address

can be messaged, specifically it checks that a PublicKeyBundle can be found for the given address

Parameters

Name	Type
peerAddress	string

Returns

Promise<boolean>

Defined in

Client.ts:233

---

close

close(): Promise<void>

Returns

Promise<void>

Defined in

Client.ts:190

---

codecFor

codecFor(contentType): undefined | ContentCodec<any>

Parameters

Name	Type
contentType	ContentTypeId

Returns

undefined | ContentCodec<any>

Defined in

Client.ts:320

---

decodeMessage

decodeMessage(payload, contentTopic): Promise<Message>

Parameters

Name	Type
payload	Uint8Array
contentTopic	undefined | string

Returns

Promise<Message>

Defined in

Client.ts:355

---

encodeMessage

encodeMessage(recipient, timestamp, content, options?): Promise<Message>

Parameters

Name	Type
recipient	PublicKeyBundle
timestamp	Date
content	any
options?	SendOptions

Returns

Promise<Message>

Defined in

Client.ts:332

---

getUserContact

getUserContact(peerAddress): Promise<undefined | PublicKeyBundle>

Returns the cached PublicKeyBundle if one is known for the given address or fetches one from the network

Parameters

Name	Type
peerAddress	string

Returns

Promise<undefined | PublicKeyBundle>

Defined in

Client.ts:208

---

init

init(options): Promise<void>

Parameters

Name	Type
options	ClientOptions

Returns

Promise<void>

Defined in

Client.ts:181

---

listConversationMessages

listConversationMessages(peerAddress, opts?): Promise<Message[]>

Parameters

Name	Type
peerAddress	string
opts?	ListMessagesOptions

Returns

Promise<Message[]>

Defined in

Client.ts:411

---

listIntroductionMessages

listIntroductionMessages(opts?): Promise<Message[]>

Parameters

Name	Type
opts?	ListMessagesOptions

Returns

Promise<Message[]>

Defined in

Client.ts:406

---

listMessages

Private listMessages(topic, opts?): Promise<Message[]>

Parameters

Name	Type
topic	string
opts?	ListMessagesOptions

Returns

Promise<Message[]>

Defined in

Client.ts:422

---

publishEnvelope

publishEnvelope(env): Promise<void>

Parameters

Name	Type
env	Envelope

Returns

Promise<void>

Defined in

Client.ts:292

---

publishUserContact

Private publishUserContact(): Promise<void>

Returns

Promise<void>

Defined in

Client.ts:195

---

registerCodec

registerCodec(codec): void

Parameters

Name	Type
codec	ContentCodec<any>

Returns

void

Defined in

Client.ts:314

---

sendMessage

sendMessage(peerAddress, content, options?): Promise<Message>

Send a message to the wallet identified by

Peer Address

Parameters

Name	Type
peerAddress	string
content	any
options?	SendOptions

Returns

Promise<Message>

Defined in

Client.ts:253

---

streamConversationMessages

streamConversationMessages(peerAddress): Promise<Stream<Message>>

Parameters

Name	Type
peerAddress	string

Returns

Promise<Stream<Message>>

Defined in

Client.ts:395

---

streamIntroductionMessages

streamIntroductionMessages(): Promise<Stream<Message>>

Returns

Promise<Stream<Message>>

Defined in

Client.ts:387

---

canMessage

Static canMessage(peerAddress, opts?): Promise<boolean>

Parameters

Name	Type
peerAddress	string
opts?	Partial<NetworkOptions>

Returns

Promise<boolean>

Defined in

Client.ts:238

---

create

Static create(wallet, opts?): Promise<Client>

Create and start a client associated with given wallet.

Parameters

Name	Type	Description
wallet	null | Signer	the wallet as a Signer instance
opts?	Partial<ClientOptions>	specify how to to connect to the network

Returns

Promise<Client>

Defined in

Client.ts:160

---

getKeys

Static getKeys(wallet, opts?): Promise<Uint8Array>

Parameters

Name	Type
wallet	null | Signer
opts?	Partial<ClientOptions>

Returns

Promise<Uint8Array>

Defined in

Client.ts:173