Check if @peerAddress can be messaged, specifically it checks that a PublicKeyBundle can be found for the given address
Check if @peerAddress can be messaged, specifically it checks that a PublicKeyBundle can be found for the given address
Find a matching codec for a given ContentTypeId
from the
client's codec registry
Convert arbitrary content into a serialized EncodedContent
instance
with the given options
Used to force getUserContact fetch contact from the network.
Returns the cached PublicKeyBundle if one is known for the given address or fetches one from the network
This throws if either the address is invalid or the contact is not published. See also [#canMessage].
Identical to getUserContact but for multiple peer addresses
List stored messages from the specified topic.
A specified mapper function will be applied to each envelope. If the mapper function throws an error during processing, the envelope will be discarded.
List messages on a given set of content topics, yielding one page at a time
Low level method for publishing envelopes to the XMTP network with no pre-processing or encryption applied.
Primarily used internally
PublishParams[]
Register a codec to be automatically used for encoding/decoding messages of the given Content Type
Create and start a client associated with given wallet.
the wallet as a Signer instance
specify how to to connect to the network
Export the XMTP PrivateKeyBundle from the SDK as a Uint8Array
.
This bundle can then be provided as privateKeyOverride
in a
subsequent call to Client.create(...)
Be very careful with these keys, as they can be used to impersonate a user on the XMTP network and read the user's messages.
Generated using TypeDoc
Client class initiates connection to the XMTP network. Should be created with
await Client.create(options)