ext

package
v0.179.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 18, 2024 License: MPL-2.0 Imports: 70 Imported by: 0

README

Whisper API Extension

API

shhext_getNewFilterMessages

Accepts the same input as shh_getFilterMessages.

Returns

Returns a list of whisper messages matching the specified filter. Filters out the messages already confirmed received by shhext_confirmMessagesProcessed

Deduplication is made using the whisper envelope content and topic only, so the same content received in different whisper envelopes will be deduplicated.

shhext_confirmMessagesProcessed

Confirms whisper messages received and processed on the client side. These messages won't appear anymore when shhext_getNewFilterMessages is called.

Parameters

Gets a list of whisper envelopes.

shhext_post

Accepts same input as shh_post.

Returns

DATA, 32 Bytes - the envelope hash

shhext_requestMessages

Sends a request for historic messages to a mail server.

Parameters
  1. Object - The message request object:
  • mailServerPeer:URL - Mail servers' enode addess
  • from:QUANTITY - (optional) Lower bound of time range as unix timestamp, default is 24 hours back from now
  • to:QUANTITY- (optional) Upper bound of time range as unix timestamp, default is now
  • topic:DATA, 4 Bytes - Regular whisper topic
  • symKeyID:DATA- ID of a symmetric key to authenticate to mail server, derived from mail server password
Returns

Boolean - returns true if the request was send, otherwise false.

Signals

Sends sent signal once per envelope.

{
  "type": "envelope.sent",
  "event": {
    "hash": "0xea0b93079ed32588628f1cabbbb5ed9e4d50b7571064c2962c3853972db67790"
  }
}

Sends expired signal if envelope dropped from whisper local queue before it was sent to any peer on the network.

{
  "type": "envelope.expired",
  "event": {
    "hash": "0x754f4c12dccb14886f791abfeb77ffb86330d03d5a4ba6f37a8c21281988b69e"
  }
}

Documentation

Index

Constants

View Source 
const (
	// DefaultRequestsDelay will be used in RequestsRegistry if no other was provided.
	DefaultRequestsDelay = 3 * time.Second
)

Variables

View Source 
var (
	// ErrInvalidMailServerPeer is returned when it fails to parse enode from params.
	ErrInvalidMailServerPeer = errors.New("invalid mailServerPeer value")
	// ErrInvalidSymKeyID is returned when it fails to get a symmetric key.
	ErrInvalidSymKeyID = errors.New("invalid symKeyID value")
	// ErrInvalidPublicKey is returned when public key can't be extracted
	// from MailServer's nodeID.
	ErrInvalidPublicKey = errors.New("can't extract public key")
	// ErrPFSNotEnabled is returned when an endpoint PFS only is called but
	// PFS is disabled
	ErrPFSNotEnabled = errors.New("pfs not enabled")
)

Functions

func MakeMessagesRequestPayload 

func MakeMessagesRequestPayload(r MessagesRequest) ([]byte, error)

MakeMessagesRequestPayload makes a specific payload for MailServer to request historic messages. DEPRECATED

func TopicsToBloom 

func TopicsToBloom(topics ...types.TopicType) []byte

TopicsToBloom squashes all topics into a single bloom filter.

func WaitForExpiredOrCompleted 

func WaitForExpiredOrCompleted(requestID types.Hash, events chan types.EnvelopeEvent, timeout time.Duration) (*types.MailServerResponse, error)

Types

type ApplicationMessagesResponse 

type ApplicationMessagesResponse struct {
	Messages []*common.Message `json:"messages"`
	Cursor   string            `json:"cursor"`
}

type ApplicationPinnedMessagesResponse added in v0.78.0 

type ApplicationPinnedMessagesResponse struct {
	PinnedMessages []*common.PinnedMessage `json:"pinnedMessages"`
	Cursor         string                  `json:"cursor"`
}

type ApplicationStatusUpdatesResponse added in v0.83.2 

type ApplicationStatusUpdatesResponse struct {
	StatusUpdates []protocol.UserStatus `json:"statusUpdates"`
}

type ApplicationSwitcherCardsResponse added in v0.117.3 

type ApplicationSwitcherCardsResponse struct {
	SwitcherCards []protocol.SwitcherCard `json:"switcherCards"`
}

type Author 

type Author struct {
	PublicKey types.HexBytes `json:"publicKey"`
	Alias     string         `json:"alias"`
	Identicon string         `json:"identicon"`
}

type Context 

type Context struct {
	context.Context
}

Context provides access to request-scoped values.

func NewContext 

func NewContext(ctx context.Context, source TimeSource, registry *RequestsRegistry, storage db.Storage) Context

NewContext creates Context with all required fields.

func (Context) HistoryStore 

func (c Context) HistoryStore() db.HistoryStore

HistoryStore returns db.HistoryStore instance associated with this request.

func (Context) RequestRegistry 

func (c Context) RequestRegistry() *RequestsRegistry

RequestRegistry returns RequestRegistry that tracks each request life-span.

func (Context) Time 

func (c Context) Time() time.Time

Time returns current time using time function associated with this request.

type ContextKey 

type ContextKey struct {
	Name string
}

ContextKey is a type used for keys in ext Context.

func NewContextKey 

func NewContextKey(name string) ContextKey

NewContextKey returns new ContextKey instance.

type EnvelopeEventsHandler 

type EnvelopeEventsHandler interface {
	EnvelopeSent([][]byte)
	EnvelopeExpired([][]byte, error)
	MailServerRequestCompleted(types.Hash, types.Hash, []byte, error)
	MailServerRequestExpired(types.Hash)
}

EnvelopeEventsHandler used for two different event types.

type EnvelopeSignalHandler 

type EnvelopeSignalHandler struct{}

EnvelopeSignalHandler sends signals when envelope is sent or expired.

func (EnvelopeSignalHandler) EnvelopeExpired 

func (h EnvelopeSignalHandler) EnvelopeExpired(identifiers [][]byte, err error)

EnvelopeExpired triggered when envelope is expired but wasn't delivered to any peer.

func (EnvelopeSignalHandler) EnvelopeSent 

func (h EnvelopeSignalHandler) EnvelopeSent(identifiers [][]byte)

EnvelopeSent triggered when envelope delivered atleast to 1 peer.

func (EnvelopeSignalHandler) MailServerRequestCompleted 

func (h EnvelopeSignalHandler) MailServerRequestCompleted(requestID types.Hash, lastEnvelopeHash types.Hash, cursor []byte, err error)

MailServerRequestCompleted triggered when the mailserver sends a message to notify that the request has been completed

func (EnvelopeSignalHandler) MailServerRequestExpired 

func (h EnvelopeSignalHandler) MailServerRequestExpired(hash types.Hash)

MailServerRequestExpired triggered when the mailserver request expires

type EnvelopeState 

type EnvelopeState int

EnvelopeState in local tracker 

const (
	// NotRegistered returned if asked hash wasn't registered in the tracker.
	NotRegistered EnvelopeState = -1
	// MailServerRequestSent is set when p2p request is sent to the mailserver
	MailServerRequestSent
)

type HandlerMock 

type HandlerMock struct {
	// contains filtered or unexported fields
}

func NewHandlerMock 

func NewHandlerMock(buf int) HandlerMock

func (HandlerMock) EnvelopeExpired 

func (t HandlerMock) EnvelopeExpired(ids [][]byte, err error)

func (HandlerMock) EnvelopeSent 

func (t HandlerMock) EnvelopeSent(ids [][]byte)

func (HandlerMock) MailServerRequestCompleted 

func (t HandlerMock) MailServerRequestCompleted(requestID types.Hash, lastEnvelopeHash types.Hash, cursor []byte, err error)

func (HandlerMock) MailServerRequestExpired 

func (t HandlerMock) MailServerRequestExpired(hash types.Hash)

type JoinRPC 

type JoinRPC struct {
	Chat    string
	PubKey  types.HexBytes
	Payload types.HexBytes
}

func (JoinRPC) ID 

func (m JoinRPC) ID() string

func (JoinRPC) PublicKey 

func (m JoinRPC) PublicKey() *ecdsa.PublicKey

func (JoinRPC) PublicName 

func (m JoinRPC) PublicName() string

type MailRequestMonitor 

type MailRequestMonitor struct {
	// contains filtered or unexported fields
}

MailRequestMonitor is responsible for monitoring history request to mailservers.

func NewMailRequestMonitor 

func NewMailRequestMonitor(eventSub mailservers.EnvelopeEventSubscriber, h EnvelopeEventsHandler, reg *RequestsRegistry) *MailRequestMonitor

func (*MailRequestMonitor) GetState 

func (m *MailRequestMonitor) GetState(hash types.Hash) EnvelopeState

func (*MailRequestMonitor) Start 

func (m *MailRequestMonitor) Start()

Start processing events.

func (*MailRequestMonitor) Stop 

func (m *MailRequestMonitor) Stop()

Stop process events.

type MarkMessageSeenResponse added in v0.171.21 

type MarkMessageSeenResponse struct {
	Count                       uint64                                 `json:"count"`
	CountWithMentions           uint64                                 `json:"countWithMentions"`
	ActivityCenterNotifications []*protocol.ActivityCenterNotification `json:"activityCenterNotifications,omitempty"`
}

type MessagesRequest 

type MessagesRequest struct {
	// MailServerPeer is MailServer's enode address.
	MailServerPeer string `json:"mailServerPeer"`

	// From is a lower bound of time range (optional).
	// Default is 24 hours back from now.
	From uint32 `json:"from"`

	// To is a upper bound of time range (optional).
	// Default is now.
	To uint32 `json:"to"`

	// Limit determines the number of messages sent by the mail server
	// for the current paginated request
	Limit uint32 `json:"limit"`

	// Cursor is used as starting point for paginated requests
	Cursor string `json:"cursor"`

	// StoreCursor is used as starting point for WAKUV2 paginatedRequests
	StoreCursor *StoreRequestCursor `json:"storeCursor"`

	// Topic is a regular Whisper topic.
	// DEPRECATED
	Topic types.TopicType `json:"topic"`

	// Topics is a list of Whisper topics.
	Topics []types.TopicType `json:"topics"`

	// SymKeyID is an ID of a symmetric key to authenticate to MailServer.
	// It's derived from MailServer password.
	SymKeyID string `json:"symKeyID"`

	// Timeout is the time to live of the request specified in seconds.
	// Default is 10 seconds
	Timeout time.Duration `json:"timeout"`

	// Force ensures that requests will bypass enforced delay.
	Force bool `json:"force"`
}

MessagesRequest is a RequestMessages() request payload.

func (*MessagesRequest) SetDefaults 

func (r *MessagesRequest) SetDefaults(now time.Time)

type MessagesResponse 

type MessagesResponse struct {
	// Cursor from the response can be used to retrieve more messages
	// for the previous request.
	Cursor string `json:"cursor"`

	// Error indicates that something wrong happened when sending messages
	// to the requester.
	Error error `json:"error"`
}

MessagesResponse is a response for requestMessages2 method.

type MessengerSignalsHandler added in v0.76.3 

type MessengerSignalsHandler struct{}

MessengerSignalHandler sends signals on messenger events

func (MessengerSignalsHandler) BackupPerformed added in v0.90.0 

func (m MessengerSignalsHandler) BackupPerformed(lastBackup uint64)

BackupPerformed passes information that a backup was performed

func (MessengerSignalsHandler) CommunityInfoFound added in v0.76.3 

func (m MessengerSignalsHandler) CommunityInfoFound(community *communities.Community)

MessageDelivered passes info about community that was requested before

func (*MessengerSignalsHandler) CreatingHistoryArchives added in v0.98.1 

func (m *MessengerSignalsHandler) CreatingHistoryArchives(communityID string)

func (*MessengerSignalsHandler) DiscordCategoriesAndChannelsExtracted added in v0.105.1 

func (m *MessengerSignalsHandler) DiscordCategoriesAndChannelsExtracted(categories []*discord.Category, channels []*discord.Channel, oldestMessageTimestamp int64, errors map[string]*discord.ImportError)

func (*MessengerSignalsHandler) DiscordChannelImportCancelled added in v0.171.11 

func (m *MessengerSignalsHandler) DiscordChannelImportCancelled(id string)

func (*MessengerSignalsHandler) DiscordChannelImportFinished added in v0.171.11 

func (m *MessengerSignalsHandler) DiscordChannelImportFinished(communityID string, channelID string)

func (*MessengerSignalsHandler) DiscordChannelImportProgress added in v0.171.11 

func (m *MessengerSignalsHandler) DiscordChannelImportProgress(importProgress *discord.ImportProgress)

func (*MessengerSignalsHandler) DiscordCommunityImportCancelled added in v0.114.1 

func (m *MessengerSignalsHandler) DiscordCommunityImportCancelled(id string)

func (*MessengerSignalsHandler) DiscordCommunityImportCleanedUp added in v0.174.5 

func (m *MessengerSignalsHandler) DiscordCommunityImportCleanedUp(id string)

func (*MessengerSignalsHandler) DiscordCommunityImportFinished added in v0.114.1 

func (m *MessengerSignalsHandler) DiscordCommunityImportFinished(id string)

func (*MessengerSignalsHandler) DiscordCommunityImportProgress added in v0.114.1 

func (m *MessengerSignalsHandler) DiscordCommunityImportProgress(importProgress *discord.ImportProgress)

func (*MessengerSignalsHandler) DownloadingHistoryArchivesFinished added in v0.109.4 

func (m *MessengerSignalsHandler) DownloadingHistoryArchivesFinished(communityID string)

func (*MessengerSignalsHandler) DownloadingHistoryArchivesStarted added in v0.115.5 

func (m *MessengerSignalsHandler) DownloadingHistoryArchivesStarted(communityID string)

func (*MessengerSignalsHandler) HistoryArchiveDownloaded added in v0.98.1 

func (m *MessengerSignalsHandler) HistoryArchiveDownloaded(communityID string, from int, to int)

func (*MessengerSignalsHandler) HistoryArchivesCreated added in v0.98.1 

func (m *MessengerSignalsHandler) HistoryArchivesCreated(communityID string, from int, to int)

func (*MessengerSignalsHandler) HistoryArchivesProtocolDisabled added in v0.98.1 

func (m *MessengerSignalsHandler) HistoryArchivesProtocolDisabled()

func (*MessengerSignalsHandler) HistoryArchivesProtocolEnabled added in v0.98.1 

func (m *MessengerSignalsHandler) HistoryArchivesProtocolEnabled()

func (*MessengerSignalsHandler) HistoryArchivesSeeding added in v0.98.1 

func (m *MessengerSignalsHandler) HistoryArchivesSeeding(communityID string)

func (*MessengerSignalsHandler) HistoryArchivesUnseeded added in v0.98.1 

func (m *MessengerSignalsHandler) HistoryArchivesUnseeded(communityID string)

func (*MessengerSignalsHandler) HistoryRequestCompleted added in v0.89.2 

func (m *MessengerSignalsHandler) HistoryRequestCompleted()

func (*MessengerSignalsHandler) HistoryRequestStarted added in v0.89.2 

func (m *MessengerSignalsHandler) HistoryRequestStarted(numBatches int)

func (*MessengerSignalsHandler) ImportingHistoryArchiveMessages added in v0.115.6 

func (m *MessengerSignalsHandler) ImportingHistoryArchiveMessages(communityID string)

func (MessengerSignalsHandler) MessageDelivered added in v0.76.3 

func (m MessengerSignalsHandler) MessageDelivered(chatID string, messageID string)

MessageDelivered passes information that message was delivered

func (*MessengerSignalsHandler) MessengerResponse added in v0.79.0 

func (m *MessengerSignalsHandler) MessengerResponse(response *protocol.MessengerResponse)

func (*MessengerSignalsHandler) NoHistoryArchivesCreated added in v0.98.1 

func (m *MessengerSignalsHandler) NoHistoryArchivesCreated(communityID string, from int, to int)

func (*MessengerSignalsHandler) SendCuratedCommunitiesUpdate added in v0.162.15 

func (m *MessengerSignalsHandler) SendCuratedCommunitiesUpdate(response *communities.KnownCommunitiesResponse)

func (*MessengerSignalsHandler) SendWakuBackedUpKeypair added in v0.152.2 

func (m *MessengerSignalsHandler) SendWakuBackedUpKeypair(response *wakusync.WakuBackedUpDataResponse)

func (*MessengerSignalsHandler) SendWakuBackedUpProfile added in v0.117.3 

func (m *MessengerSignalsHandler) SendWakuBackedUpProfile(response *wakusync.WakuBackedUpDataResponse)

func (*MessengerSignalsHandler) SendWakuBackedUpSettings added in v0.117.3 

func (m *MessengerSignalsHandler) SendWakuBackedUpSettings(response *wakusync.WakuBackedUpDataResponse)

func (*MessengerSignalsHandler) SendWakuBackedUpWatchOnlyAccount added in v0.152.2 

func (m *MessengerSignalsHandler) SendWakuBackedUpWatchOnlyAccount(response *wakusync.WakuBackedUpDataResponse)

func (*MessengerSignalsHandler) SendWakuFetchingBackupProgress added in v0.117.3 

func (m *MessengerSignalsHandler) SendWakuFetchingBackupProgress(response *wakusync.WakuBackedUpDataResponse)

func (*MessengerSignalsHandler) StatusUpdatesTimedOut added in v0.104.1 

func (m *MessengerSignalsHandler) StatusUpdatesTimedOut(statusUpdates *[]protocol.UserStatus)

type Metadata 

type Metadata struct {
	DedupID      []byte         `json:"dedupId"`
	EncryptionID types.HexBytes `json:"encryptionId"`
	MessageID    types.HexBytes `json:"messageId"`
	Author       Author         `json:"author"`
}

type PublicAPI 

type PublicAPI struct {
	// contains filtered or unexported fields
}

PublicAPI extends whisper public API.

func NewPublicAPI 

func NewPublicAPI(s *Service, eventSub mailservers.EnvelopeEventSubscriber) *PublicAPI

NewPublicAPI returns instance of the public API.

func (*PublicAPI) AcceptActivityCenterNotifications added in v0.76.0 

func (api *PublicAPI) AcceptActivityCenterNotifications(ctx context.Context, ids []types.HexBytes) (*protocol.MessengerResponse, error)

func (*PublicAPI) AcceptContactRequest added in v0.100.0 

func (api *PublicAPI) AcceptContactRequest(ctx context.Context, request *requests.AcceptContactRequest) (*protocol.MessengerResponse, error)

func (*PublicAPI) AcceptContactVerificationRequest added in v0.102.6 

func (api *PublicAPI) AcceptContactVerificationRequest(ctx context.Context, id string, response string) (*protocol.MessengerResponse, error)

func (*PublicAPI) AcceptLatestContactRequestForContact added in v0.102.2 

func (api *PublicAPI) AcceptLatestContactRequestForContact(ctx context.Context, request *requests.AcceptLatestContactRequestForContact) (*protocol.MessengerResponse, error)

func (*PublicAPI) AcceptRequestAddressForTransaction 

func (api *PublicAPI) AcceptRequestAddressForTransaction(ctx context.Context, messageID, address string) (*protocol.MessengerResponse, error)

func (*PublicAPI) AcceptRequestToJoinCommunity added in v0.72.0 

func (api *PublicAPI) AcceptRequestToJoinCommunity(request *requests.AcceptRequestToJoinCommunity) (*protocol.MessengerResponse, error)

AcceptRequestToJoinCommunity accepts a pending request to join a community

func (*PublicAPI) AcceptRequestTransaction 

func (api *PublicAPI) AcceptRequestTransaction(ctx context.Context, transactionHash, messageID string, signature types.HexBytes) (*protocol.MessengerResponse, error)

func (*PublicAPI) ActiveChats added in v0.76.0 

func (api *PublicAPI) ActiveChats(parent context.Context) []*protocol.Chat

func (*PublicAPI) ActivityCenterNotifications added in v0.76.0 

func (api *PublicAPI) ActivityCenterNotifications(request protocol.ActivityCenterNotificationsRequest) (*protocol.ActivityCenterPaginationResponse, error)

func (*PublicAPI) ActivityCenterNotificationsCount added in v0.136.0 

func (api *PublicAPI) ActivityCenterNotificationsCount(request protocol.ActivityCenterCountRequest) (*protocol.ActivityCenterCountResponse, error)

func (*PublicAPI) AddAdminsToGroupChat 

func (api *PublicAPI) AddAdminsToGroupChat(ctx Context, chatID string, members []string) (*protocol.MessengerResponse, error)

func (*PublicAPI) AddBookmark added in v0.102.2 

func (api *PublicAPI) AddBookmark(ctx context.Context, bookmark browsers.Bookmark) error

func (*PublicAPI) AddBrowser added in v0.106.1 

func (api *PublicAPI) AddBrowser(ctx context.Context, browser browsers.Browser) error

func (*PublicAPI) AddCommunityToken added in v0.133.2 

func (api *PublicAPI) AddCommunityToken(communityID string, chainID int, address string) error

func (*PublicAPI) AddContact added in v0.68.4 

func (api *PublicAPI) AddContact(ctx context.Context, request *requests.AddContact) (*protocol.MessengerResponse, error)

func (*PublicAPI) AddMembersToGroupChat 

func (api *PublicAPI) AddMembersToGroupChat(ctx Context, chatID string, members []string) (*protocol.MessengerResponse, error)

func (*PublicAPI) AddPushNotificationsServer added in v0.56.1 

func (api *PublicAPI) AddPushNotificationsServer(ctx context.Context, publicKeyBytes types.HexBytes) error

func (*PublicAPI) AddRelayPeer added in v0.88.4 

func (api *PublicAPI) AddRelayPeer(address string) (string, error)

func (*PublicAPI) AddRoleToMember added in v0.115.5 

func (api *PublicAPI) AddRoleToMember(request *requests.AddRoleToMember) (*protocol.MessengerResponse, error)

func (*PublicAPI) AddStorePeer added in v0.88.4 

func (api *PublicAPI) AddStorePeer(address string) (string, error)

func (*PublicAPI) AddWalletConnectSession added in v0.105.1 

func (api *PublicAPI) AddWalletConnectSession(ctx context.Context, request *requests.AddWalletConnectSession) error

wallet connect session apis

func (*PublicAPI) AllMessagesFromChatWhichMatchTerm added in v0.83.14 

func (api *PublicAPI) AllMessagesFromChatWhichMatchTerm(chatID, searchTerm string, caseSensitive bool) (*ApplicationMessagesResponse, error)

func (*PublicAPI) AllMessagesFromChatsAndCommunitiesWhichMatchTerm added in v0.83.14 

func (api *PublicAPI) AllMessagesFromChatsAndCommunitiesWhichMatchTerm(communityIds []string, chatIds []string, searchTerm string, caseSensitive bool) (*ApplicationMessagesResponse, error)

func (*PublicAPI) AllNonApprovedCommunitiesRequestsToJoin added in v0.171.30 

func (api *PublicAPI) AllNonApprovedCommunitiesRequestsToJoin() ([]*communities.RequestToJoin, error)

AllNonApprovedCommunitiesRequestsToJoin returns the all non-approved requests to join for all communities

func (*PublicAPI) BackupData added in v0.90.0 

func (api *PublicAPI) BackupData() (uint64, error)

func (*PublicAPI) BanUserFromCommunity added in v0.73.9 

func (api *PublicAPI) BanUserFromCommunity(ctx context.Context, request *requests.BanUserFromCommunity) (*protocol.MessengerResponse, error)

BanUserFromCommunity removes the user with pk from the community with ID

func (*PublicAPI) BlockContact 

func (api *PublicAPI) BlockContact(ctx context.Context, contactID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) BlockContactDesktop added in v0.98.3 

func (api *PublicAPI) BlockContactDesktop(ctx context.Context, contactID string) (*protocol.MessengerResponse, error)

This function is the same as the one above, but used only on the desktop side, since at the end it doesn't set `Added` flag to `false`, but only `Blocked` to `true`

func (*PublicAPI) BloomFilter added in v0.85.0 

func (api *PublicAPI) BloomFilter() string

BloomFilter returns the current bloom filter bytes

func (*PublicAPI) BuildContact added in v0.125.4 

func (api *PublicAPI) BuildContact(request *requests.BuildContact) (*protocol.Contact, error)

func (*PublicAPI) CancelRequestToJoinCommunity added in v0.114.1 

func (api *PublicAPI) CancelRequestToJoinCommunity(ctx context.Context, request *requests.CancelRequestToJoinCommunity) (*protocol.MessengerResponse, error)

CancelRequestToJoinCommunity accepts a pending request to join a community

func (*PublicAPI) CancelVerificationRequest added in v0.102.6 

func (api *PublicAPI) CancelVerificationRequest(ctx context.Context, id string) (*protocol.MessengerResponse, error)

func (*PublicAPI) CanceledRequestsToJoinForCommunity added in v0.114.1 

func (api *PublicAPI) CanceledRequestsToJoinForCommunity(id types.HexBytes) ([]*communities.RequestToJoin, error)

CanceledRequestsToJoinForCommunity returns the declined requests to join for a given community

func (*PublicAPI) ChangeGroupChatName added in v0.52.1 

func (api *PublicAPI) ChangeGroupChatName(ctx Context, chatID string, name string) (*protocol.MessengerResponse, error)

func (*PublicAPI) ChangeIdentityImageShowTo added in v0.89.10 

func (api *PublicAPI) ChangeIdentityImageShowTo(showTo settings.ProfilePicturesShowToType) error

func (*PublicAPI) Chat added in v0.87.1 

func (api *PublicAPI) Chat(parent context.Context, chatID string) *protocol.Chat

func (*PublicAPI) ChatMentionClearMentions added in v0.143.1 

func (api *PublicAPI) ChatMentionClearMentions(chatID string)

func (*PublicAPI) ChatMentionOnChangeText added in v0.148.3 

func (api *PublicAPI) ChatMentionOnChangeText(chatID, text string) (*protocol.ChatMentionContext, error)

ChatMentionOnChangeText chatID: chat id text: the full text user input in the chat input field as performance consideration, we don't need to call this function each time after user input a character, say user input "abc", we don't need to call this function 3 times, instead, we can call this function 2 times as following: 1. user input "a", call this function with text "a" 2. user input "c", call this function with text "abc" whatever, we should ensure ChatMentionOnChangeText know(invoked) the latest full text. ChatMentionOnChangeText will maintain state of fulltext and diff between previous/latest full text internally.

func (*PublicAPI) ChatMentionReplaceWithPublicKey added in v0.151.5 

func (api *PublicAPI) ChatMentionReplaceWithPublicKey(chatID, text string) (string, error)

ChatMentionReplaceWithPublicKey checks if the text contains mentions and replace mention with user public key. e.g. abc @alice -> abc 0x123

func (*PublicAPI) ChatMentionSelectMention added in v0.151.5 

func (api *PublicAPI) ChatMentionSelectMention(chatID, text, primaryName, publicKey string) (*protocol.ChatMentionContext, error)

ChatMentionSelectMention select mention from mention suggestion list

func (*PublicAPI) ChatMentionToInputField added in v0.143.1 

func (api *PublicAPI) ChatMentionToInputField(chatID, text string) (*protocol.ChatMentionContext, error)

ChatMentionToInputField checks if the text contains mentions and replace mention with readable username. generally, this function is invoked before user editing a sent message.

func (*PublicAPI) ChatMessages 

func (api *PublicAPI) ChatMessages(chatID, cursor string, limit int) (*ApplicationMessagesResponse, error)

func (*PublicAPI) ChatPinnedMessages added in v0.78.0 

func (api *PublicAPI) ChatPinnedMessages(chatID, cursor string, limit int) (*ApplicationPinnedMessagesResponse, error)

func (*PublicAPI) Chats 

func (api *PublicAPI) Chats(parent context.Context) []*protocol.Chat

func (*PublicAPI) ChatsPreview added in v0.87.1 

func (api *PublicAPI) ChatsPreview(parent context.Context) []*protocol.ChatPreview

func (*PublicAPI) CheckAllCommunityChannelsPermissions added in v0.159.2 

func (api *PublicAPI) CheckAllCommunityChannelsPermissions(request *requests.CheckAllCommunityChannelsPermissions) (*communities.CheckAllChannelsPermissionsResponse, error)

func (*PublicAPI) CheckAndDeletePendingRequestToJoinCommunity added in v0.146.4 

func (api *PublicAPI) CheckAndDeletePendingRequestToJoinCommunity(ctx context.Context) (*protocol.MessengerResponse, error)

CheckAndClearPendingRequestToJoinCommunity to delete pending request to join a community which are older than 7 days

func (*PublicAPI) CheckCommunityChannelPermissions added in v0.159.2 

func (api *PublicAPI) CheckCommunityChannelPermissions(request *requests.CheckCommunityChannelPermissions) (*communities.CheckChannelPermissionsResponse, error)

func (*PublicAPI) CheckPermissionsToJoinCommunity added in v0.151.13 

func (api *PublicAPI) CheckPermissionsToJoinCommunity(request *requests.CheckPermissionToJoinCommunity) (*communities.CheckPermissionToJoinResponse, error)

func (*PublicAPI) ClearHistory added in v0.68.4 

func (api *PublicAPI) ClearHistory(request *requests.ClearHistory) (*protocol.MessengerResponse, error)

func (*PublicAPI) CollapsedCommunityCategories added in v0.138.4 

func (api *PublicAPI) CollapsedCommunityCategories() ([]protocol.CollapsedCommunityCategory, error)

func (*PublicAPI) CollectCommunityMetrics added in v0.162.14 

func (api *PublicAPI) CollectCommunityMetrics(request *requests.CommunityMetricsRequest) (*protocol.CommunityMetricsResponse, error)

func (*PublicAPI) Communities added in v0.67.0 

func (api *PublicAPI) Communities(parent context.Context) ([]*communities.Community, error)

Communities returns a list of communities that are stored

func (*PublicAPI) CommunityTags added in v0.102.5 

func (api *PublicAPI) CommunityTags(parent context.Context) map[string]string

CommunityTags return the list of possible community tags

func (*PublicAPI) CommunityUpdateLastOpenedAt added in v0.172.8 

func (api *PublicAPI) CommunityUpdateLastOpenedAt(communityID string) (int64, error)

Updates the lastOpenedAt key of a community

func (*PublicAPI) ConfirmJoiningGroup 

func (api *PublicAPI) ConfirmJoiningGroup(ctx context.Context, chatID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) Contacts 

func (api *PublicAPI) Contacts(parent context.Context) []*protocol.Contact

func (*PublicAPI) CreateClosedCommunity added in v0.162.14 

func (api *PublicAPI) CreateClosedCommunity() (*protocol.MessengerResponse, error)

CreateClosedCommunity used only for test purposes

func (*PublicAPI) CreateCommunity added in v0.67.0 

func (api *PublicAPI) CreateCommunity(request *requests.CreateCommunity) (*protocol.MessengerResponse, error)

CreateCommunity creates a new community with the provided description

func (*PublicAPI) CreateCommunityCategory added in v0.79.3 

func (api *PublicAPI) CreateCommunityCategory(request *requests.CreateCommunityCategory) (*protocol.MessengerResponse, error)

CreateCommunityCategory creates a category within a particular community

func (*PublicAPI) CreateCommunityChat added in v0.67.0 

func (api *PublicAPI) CreateCommunityChat(communityID types.HexBytes, c *protobuf.CommunityChat) (*protocol.MessengerResponse, error)

CreateCommunityChat creates a community chat in the given community

func (*PublicAPI) CreateCommunityTokenDeploymentSignature added in v0.168.1 

func (api *PublicAPI) CreateCommunityTokenDeploymentSignature(ctx context.Context, chainID uint64, addressFrom string, communityID string) (types.HexBytes, error)

func (*PublicAPI) CreateCommunityTokenPermission added in v0.136.0 

func (api *PublicAPI) CreateCommunityTokenPermission(request *requests.CreateCommunityTokenPermission) (*protocol.MessengerResponse, error)

func (*PublicAPI) CreateGroupChatFromInvitation added in v0.60.0 

func (api *PublicAPI) CreateGroupChatFromInvitation(name string, chatID string, adminPK string) (*protocol.MessengerResponse, error)

func (*PublicAPI) CreateGroupChatWithMembers 

func (api *PublicAPI) CreateGroupChatWithMembers(ctx Context, name string, members []string) (*protocol.MessengerResponse, error)

func (*PublicAPI) CreateOneToOneChat added in v0.72.0 

func (api *PublicAPI) CreateOneToOneChat(parent context.Context, request *requests.CreateOneToOneChat) (*protocol.MessengerResponse, error)

func (*PublicAPI) CreateOpenCommunity added in v0.162.14 

func (api *PublicAPI) CreateOpenCommunity() (*protocol.MessengerResponse, error)

CreateOpenCommunity used only for test purposes

func (*PublicAPI) CreateProfileChat added in v0.79.0 

func (api *PublicAPI) CreateProfileChat(parent context.Context, request *requests.CreateProfileChat) (*protocol.MessengerResponse, error)

func (*PublicAPI) CreatePublicChat added in v0.79.0 

func (api *PublicAPI) CreatePublicChat(parent context.Context, request *requests.CreatePublicChat) (*protocol.MessengerResponse, error)

func (*PublicAPI) CreateTokenGatedCommunity added in v0.162.14 

func (api *PublicAPI) CreateTokenGatedCommunity() (*protocol.MessengerResponse, error)

CreateTokenGatedCommunity used only for test purposes

func (*PublicAPI) CuratedCommunities added in v0.100.1 

func (api *PublicAPI) CuratedCommunities(parent context.Context) (*communities.KnownCommunitiesResponse, error)

CuratedCommunities returns the list of curated communities stored in the smart contract. If a community is already known by the node, its description will be returned and and will asynchronously retrieve the description for the communities it does not know

func (*PublicAPI) DeactivateChat added in v0.68.4 

func (api *PublicAPI) DeactivateChat(request *requests.DeactivateChat) (*protocol.MessengerResponse, error)

func (*PublicAPI) DeclineContactRequest added in v0.131.11 

func (api *PublicAPI) DeclineContactRequest(ctx context.Context, request *requests.DeclineContactRequest) (*protocol.MessengerResponse, error)

func (*PublicAPI) DeclineContactVerificationRequest added in v0.102.6 

func (api *PublicAPI) DeclineContactVerificationRequest(ctx context.Context, id string) (*protocol.MessengerResponse, error)

func (*PublicAPI) DeclineRequestAddressForTransaction 

func (api *PublicAPI) DeclineRequestAddressForTransaction(ctx context.Context, messageID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) DeclineRequestToJoinCommunity added in v0.72.0 

func (api *PublicAPI) DeclineRequestToJoinCommunity(request *requests.DeclineRequestToJoinCommunity) (*protocol.MessengerResponse, error)

DeclineRequestToJoinCommunity accepts a pending request to join a community

func (*PublicAPI) DeclineRequestTransaction 

func (api *PublicAPI) DeclineRequestTransaction(ctx context.Context, messageID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) DeclinedRequestsToJoinForCommunity added in v0.106.1 

func (api *PublicAPI) DeclinedRequestsToJoinForCommunity(id types.HexBytes) ([]*communities.RequestToJoin, error)

DeclinedRequestsToJoinForCommunity returns the declined requests to join for a given community

func (*PublicAPI) DeleteActivityCenterNotifications added in v0.132.3 

func (api *PublicAPI) DeleteActivityCenterNotifications(ctx context.Context, ids []types.HexBytes) error

func (*PublicAPI) DeleteBrowser added in v0.106.1 

func (api *PublicAPI) DeleteBrowser(ctx context.Context, id string) error

func (*PublicAPI) DeleteChat 

func (api *PublicAPI) DeleteChat(parent context.Context, chatID string) error

func (*PublicAPI) DeleteCommunityCategory added in v0.79.3 

func (api *PublicAPI) DeleteCommunityCategory(request *requests.DeleteCommunityCategory) (*protocol.MessengerResponse, error)

DeleteCommunityCategory deletes a category within a particular community and removes this category from any chat that has it

func (*PublicAPI) DeleteCommunityChat added in v0.83.8 

func (api *PublicAPI) DeleteCommunityChat(communityID types.HexBytes, chatID string) (*protocol.MessengerResponse, error)

DeleteCommunityChat deletes a community chat in the given community

func (*PublicAPI) DeleteCommunityMemberMessages added in v0.177.0 

func (api *PublicAPI) DeleteCommunityMemberMessages(request *requests.DeleteCommunityMemberMessages) (*protocol.MessengerResponse, error)

Delete a specific community member messages or all community member messages (based on provided parameters)

func (*PublicAPI) DeleteCommunityTokenPermission added in v0.136.0 

func (api *PublicAPI) DeleteCommunityTokenPermission(request *requests.DeleteCommunityTokenPermission) (*protocol.MessengerResponse, error)

func (*PublicAPI) DeleteMessage 

func (api *PublicAPI) DeleteMessage(id string) error

func (*PublicAPI) DeleteMessageAndSend added in v0.83.2 

func (api *PublicAPI) DeleteMessageAndSend(ctx context.Context, messageID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) DeleteMessageForMeAndSync added in v0.111.5 

func (api *PublicAPI) DeleteMessageForMeAndSync(ctx context.Context, chatID string, messageID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) DeleteMessagesByChatID 

func (api *PublicAPI) DeleteMessagesByChatID(id string) error

func (*PublicAPI) DeleteSavedAddress added in v0.111.5 

func (api *PublicAPI) DeleteSavedAddress(ctx context.Context, address ethcommon.Address, isTest bool) error

func (*PublicAPI) DeleteSwitcherCard added in v0.117.3 

func (api *PublicAPI) DeleteSwitcherCard(id string) error

func (*PublicAPI) DestroyWalletConnectSession added in v0.105.1 

func (api *PublicAPI) DestroyWalletConnectSession(ctx context.Context, PeerID string) error

func (*PublicAPI) DialPeer added in v0.88.4 

func (api *PublicAPI) DialPeer(address string) error

func (*PublicAPI) DialPeerByID added in v0.88.4 

func (api *PublicAPI) DialPeerByID(peerID string) error

func (*PublicAPI) DisableCommunityHistoryArchiveProtocol added in v0.98.1 

func (api *PublicAPI) DisableCommunityHistoryArchiveProtocol() error

func (*PublicAPI) DisableInstallation 

func (api *PublicAPI) DisableInstallation(installationID string) error

DisableInstallation disables an installation for multi-device sync.

func (*PublicAPI) DisablePushNotificationsBlockMentions added in v0.61.0 

func (api *PublicAPI) DisablePushNotificationsBlockMentions(ctx context.Context) error

func (*PublicAPI) DisablePushNotificationsFromContactsOnly added in v0.56.1 

func (api *PublicAPI) DisablePushNotificationsFromContactsOnly(ctx context.Context) error

func (*PublicAPI) DisableSendingNotifications added in v0.56.1 

func (api *PublicAPI) DisableSendingNotifications(ctx context.Context) error

func (*PublicAPI) DisconnectActiveMailserver added in v0.93.2 

func (api *PublicAPI) DisconnectActiveMailserver()

func (*PublicAPI) DismissActivityCenterNotifications added in v0.76.0 

func (api *PublicAPI) DismissActivityCenterNotifications(ctx context.Context, ids []types.HexBytes) error

func (*PublicAPI) DismissActivityCenterNotificationsByCommunity added in v0.171.27 

func (api *PublicAPI) DismissActivityCenterNotificationsByCommunity(ctx context.Context, request *requests.DismissCommunityNotifications) error

func (*PublicAPI) DismissLatestContactRequestForContact added in v0.102.2 

func (api *PublicAPI) DismissLatestContactRequestForContact(ctx context.Context, request *requests.DismissLatestContactRequestForContact) (*protocol.MessengerResponse, error)

func (*PublicAPI) DropPeer added in v0.88.4 

func (api *PublicAPI) DropPeer(peerID string) error

func (*PublicAPI) Echo 

func (api *PublicAPI) Echo(ctx context.Context, message string) (string, error)

Echo is a method for testing purposes.

func (*PublicAPI) EditCommunity added in v0.79.0 

func (api *PublicAPI) EditCommunity(request *requests.EditCommunity) (*protocol.MessengerResponse, error)

EditCommunity edits an existing community with the provided description

func (*PublicAPI) EditCommunityCategory added in v0.79.3 

func (api *PublicAPI) EditCommunityCategory(request *requests.EditCommunityCategory) (*protocol.MessengerResponse, error)

EditCommunityCategory modifies a category within a particular community

func (*PublicAPI) EditCommunityChat added in v0.79.8 

func (api *PublicAPI) EditCommunityChat(communityID types.HexBytes, chatID string, c *protobuf.CommunityChat) (*protocol.MessengerResponse, error)

EditCommunityChat edits a community chat in the given community

func (*PublicAPI) EditCommunityTokenPermission added in v0.136.0 

func (api *PublicAPI) EditCommunityTokenPermission(request *requests.EditCommunityTokenPermission) (*protocol.MessengerResponse, error)

func (*PublicAPI) EditMessage added in v0.80.3 

func (api *PublicAPI) EditMessage(ctx context.Context, request *requests.EditMessage) (*protocol.MessengerResponse, error)

func (*PublicAPI) EditSharedAddressesForCommunity added in v0.161.4 

func (api *PublicAPI) EditSharedAddressesForCommunity(request *requests.EditSharedAddresses) (*protocol.MessengerResponse, error)

EditSharedAddressesForCommunity edits the addresses that are shared with the owner of the community

func (*PublicAPI) EmojiReactionsByChatID added in v0.56.4 

func (api *PublicAPI) EmojiReactionsByChatID(chatID string, cursor string, limit int) ([]*protocol.EmojiReaction, error)

func (*PublicAPI) EmojiReactionsByChatIDMessageID added in v0.89.20 

func (api *PublicAPI) EmojiReactionsByChatIDMessageID(chatID string, messageID string) ([]*protocol.EmojiReaction, error)

func (*PublicAPI) EnableCommunityHistoryArchiveProtocol added in v0.98.1 

func (api *PublicAPI) EnableCommunityHistoryArchiveProtocol() error

func (*PublicAPI) EnableInstallation 

func (api *PublicAPI) EnableInstallation(installationID string) error

EnableInstallation enables an installation for multi-device sync.

func (*PublicAPI) EnablePushNotificationsBlockMentions added in v0.61.0 

func (api *PublicAPI) EnablePushNotificationsBlockMentions(ctx context.Context) error

func (*PublicAPI) EnablePushNotificationsFromContactsOnly added in v0.56.1 

func (api *PublicAPI) EnablePushNotificationsFromContactsOnly(ctx context.Context) error

func (*PublicAPI) EnableSendingNotifications added in v0.56.1 

func (api *PublicAPI) EnableSendingNotifications(ctx context.Context) error

func (*PublicAPI) EnsVerified added in v0.72.0 

func (api *PublicAPI) EnsVerified(pk, ensName string) error

func (*PublicAPI) ExportCommunity added in v0.67.0 

func (api *PublicAPI) ExportCommunity(id types.HexBytes) (types.HexBytes, error)

ExportCommunity exports the private key of the community with given ID

func (*PublicAPI) ExtractDiscordChannelsAndCategories added in v0.105.1 

func (api *PublicAPI) ExtractDiscordChannelsAndCategories(filesToImport []string) (*protocol.MessengerResponse, map[string]*discord.ImportError)

func (*PublicAPI) FetchCommunity added in v0.171.10 

func (api *PublicAPI) FetchCommunity(request *protocol.FetchCommunityRequest) (*communities.Community, error)

func (*PublicAPI) FetchMessages added in v0.171.21 

func (api *PublicAPI) FetchMessages(request *requests.FetchMessages) error

func (*PublicAPI) FillGaps added in v0.79.0 

func (api *PublicAPI) FillGaps(chatID string, messageIDs []string) error

func (*PublicAPI) FirstUnseenMessageID added in v0.117.1 

func (api *PublicAPI) FirstUnseenMessageID(chatID string) (string, error)

func (*PublicAPI) GenerateEditCommunityRequestsForSigning added in v0.171.9 

func (api *PublicAPI) GenerateEditCommunityRequestsForSigning(memberPubKey string, communityID types.HexBytes, addressesToReveal []string) ([]account.SignParams, error)

Generates a single hash for each address that needs to be revealed to a community. Each hash needs to be signed. The order of retuned hashes corresponds to the order of addresses in addressesToReveal.

func (*PublicAPI) GenerateJoiningCommunityRequestsForSigning added in v0.171.9 

func (api *PublicAPI) GenerateJoiningCommunityRequestsForSigning(memberPubKey string, communityID types.HexBytes, addressesToReveal []string) ([]account.SignParams, error)

Generates a single hash for each address that needs to be revealed to a community. Each hash needs to be signed. The order of retuned hashes corresponds to the order of addresses in addressesToReveal.

func (*PublicAPI) GetActivityCenterState added in v0.131.8 

func (api *PublicAPI) GetActivityCenterState() (*protocol.ActivityCenterState, error)

func (*PublicAPI) GetAllCommunityTokens added in v0.148.4 

func (api *PublicAPI) GetAllCommunityTokens() ([]*token.CommunityToken, error)

func (*PublicAPI) GetBrowsers added in v0.106.1 

func (api *PublicAPI) GetBrowsers(ctx context.Context) (browsers []*browsers.Browser, err error)

func (*PublicAPI) GetCheckChannelPermissionResponses added in v0.159.7 

func (api *PublicAPI) GetCheckChannelPermissionResponses(parent context.Context, communityID types.HexBytes) (*communities.CheckAllChannelsPermissionsResponse, error)

func (*PublicAPI) GetCommunitiesSettings added in v0.96.4 

func (api *PublicAPI) GetCommunitiesSettings() ([]communities.CommunitySettings, error)

func (*PublicAPI) GetCommunityMemberAllMessages added in v0.177.0 

func (api *PublicAPI) GetCommunityMemberAllMessages(request *requests.CommunityMemberMessages) ([]*common.Message, error)

func (*PublicAPI) GetCommunityMembersForWalletAddresses added in v0.163.8 

func (api *PublicAPI) GetCommunityMembersForWalletAddresses(communityID types.HexBytes, chainID uint64) (map[string]*protocol.Contact, error)

Get community members contact list for provided wallet addresses

func (*PublicAPI) GetCommunityPermissionedBalances added in v0.174.3 

func (api *PublicAPI) GetCommunityPermissionedBalances(request *requests.GetPermissionedBalances) (map[ethcommon.Address][]communities.PermissionedBalance, error)

GetCommunityPermissionedBalances returns balances indexed by account address.

func (*PublicAPI) GetCommunityPublicKeyFromPrivateKey added in v0.162.14 

func (api *PublicAPI) GetCommunityPublicKeyFromPrivateKey(ctx context.Context, hexPrivateKey string) string

GetCommunityPublicKeyFromPrivateKey gets the community's public key from its private key

func (*PublicAPI) GetCommunityStorenodes added in v0.175.3 

func (api *PublicAPI) GetCommunityStorenodes(id types.HexBytes) (*protocol.MessengerResponse, error)

Gets the community storenodes for a community

func (*PublicAPI) GetCommunityTokens added in v0.133.2 

func (api *PublicAPI) GetCommunityTokens(communityID string) ([]*token.CommunityToken, error)

func (*PublicAPI) GetContactByID added in v0.55.1 

func (api *PublicAPI) GetContactByID(parent context.Context, id string) *protocol.Contact

func (*PublicAPI) GetGroupChatInvitations added in v0.60.0 

func (api *PublicAPI) GetGroupChatInvitations() ([]*protocol.GroupChatInvitation, error)

func (*PublicAPI) GetLatestContactRequestForContact added in v0.176.3 

func (api *PublicAPI) GetLatestContactRequestForContact(ctx context.Context, contactID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) GetLatestVerificationRequestFrom added in v0.114.1 

func (api *PublicAPI) GetLatestVerificationRequestFrom(ctx context.Context, contactID string) (*verification.Request, error)

func (*PublicAPI) GetLinkPreviewData added in v0.62.15 

func (api *PublicAPI) GetLinkPreviewData(link string) (previewData urls.LinkPreviewData, err error)

func (*PublicAPI) GetLinkPreviewWhitelist added in v0.62.15 

func (api *PublicAPI) GetLinkPreviewWhitelist() []urls.Site

func (*PublicAPI) GetOurInstallations 

func (api *PublicAPI) GetOurInstallations() []*multidevice.Installation

GetOurInstallations returns all the installations available given an identity

func (*PublicAPI) GetProfileShowcaseAccountsByAddress added in v0.172.10 

func (api *PublicAPI) GetProfileShowcaseAccountsByAddress(address string) ([]*identity.ProfileShowcaseAccount, error)

Get profile showcase accounts by address

func (*PublicAPI) GetProfileShowcaseEntriesLimit added in v0.176.7 

func (api *PublicAPI) GetProfileShowcaseEntriesLimit() (int, error)

Get profile showcase max entries count (excluding social links)

func (*PublicAPI) GetProfileShowcaseForContact added in v0.171.12 

func (api *PublicAPI) GetProfileShowcaseForContact(contactID string, validate bool) (*identity.ProfileShowcase, error)

Get profile showcase for a contact

func (*PublicAPI) GetProfileShowcasePreferences added in v0.171.5 

func (api *PublicAPI) GetProfileShowcasePreferences() (*identity.ProfileShowcasePreferences, error)

Get all profile showcase preferences for current user

func (*PublicAPI) GetProfileShowcaseSocialLinksLimit added in v0.176.7 

func (api *PublicAPI) GetProfileShowcaseSocialLinksLimit() (int, error)

Get profile showcase max social link entries count

func (*PublicAPI) GetPushNotificationsServers added in v0.59.0 

func (api *PublicAPI) GetPushNotificationsServers() ([]*pushnotificationclient.PushNotificationServer, error)

func (*PublicAPI) GetReceivedVerificationRequests added in v0.102.6 

func (api *PublicAPI) GetReceivedVerificationRequests(ctx context.Context) ([]*verification.Request, error)

func (*PublicAPI) GetRevealedAccounts added in v0.163.4 

func (api *PublicAPI) GetRevealedAccounts(communityID types.HexBytes, memberPk string) ([]*protobuf.RevealedAccount, error)

GetRevealedAccounts gets the revealed addresses for a member in a community

func (*PublicAPI) GetRevealedAccountsForAllMembers added in v0.163.4 

func (api *PublicAPI) GetRevealedAccountsForAllMembers(communityID types.HexBytes) (map[string][]*protobuf.RevealedAccount, error)

GetRevealedAccountsForAllMembers gets the revealed addresses for all the members of a community

func (*PublicAPI) GetSavedAddresses added in v0.172.5 

func (api *PublicAPI) GetSavedAddresses(ctx context.Context) ([]*wallet.SavedAddress, error)

func (*PublicAPI) GetTextURLs deprecated added in v0.151.12 

func (api *PublicAPI) GetTextURLs(text string) []string

Deprecated: GetTextURLs is deprecated in favor of more generic GetTextURLsToUnfurl.

GetTextURLs parses text and returns a deduplicated and (somewhat) normalized slice of URLs. The returned URLs can be used as cache keys by clients.

func (*PublicAPI) GetTextURLsToUnfurl added in v0.171.21 

func (api *PublicAPI) GetTextURLsToUnfurl(text string) *protocol.URLsUnfurlPlan

GetTextURLsToUnfurl parses text and returns a deduplicated and (somewhat) normalized slice of URLs. The returned URLs can be used as cache keys by clients. For each URL there's a corresponding metadata which should be used as to plan the unfurling.

func (*PublicAPI) GetTrustStatus added in v0.102.6 

func (api *PublicAPI) GetTrustStatus(ctx context.Context, contactID string) (verification.TrustStatus, error)

func (*PublicAPI) GetVerificationRequestSentTo added in v0.102.6 

func (api *PublicAPI) GetVerificationRequestSentTo(ctx context.Context, contactID string) (*verification.Request, error)

func (*PublicAPI) GetWalletConnectSession added in v0.105.1 

func (api *PublicAPI) GetWalletConnectSession(ctx context.Context) ([]protocol.WalletConnectSession, error)

func (*PublicAPI) HasUnseenActivityCenterNotifications added in v0.131.8 

func (api *PublicAPI) HasUnseenActivityCenterNotifications() (bool, error)

func (*PublicAPI) ImageServerURL added in v0.94.6 

func (api *PublicAPI) ImageServerURL() string

func (*PublicAPI) ImportCommunity added in v0.67.0 

func (api *PublicAPI) ImportCommunity(ctx context.Context, hexPrivateKey string) (*protocol.MessengerResponse, error)

ImportCommunity imports a community with the given private key in hex

func (*PublicAPI) IsDisplayNameDupeOfCommunityMember added in v0.176.3 

func (api *PublicAPI) IsDisplayNameDupeOfCommunityMember(name string) (bool, error)

IsDisplayNameDupeOfCommunityMember returns if any controlled or joined community has a member with provided display name

func (*PublicAPI) JoinCommunity added in v0.67.0 

func (api *PublicAPI) JoinCommunity(parent context.Context, communityID types.HexBytes) (*protocol.MessengerResponse, error)

JoinCommunity joins a community with the given ID

func (*PublicAPI) JoinedCommunities added in v0.67.0 

func (api *PublicAPI) JoinedCommunities(parent context.Context) ([]*communities.Community, error)

JoinedCommunities returns a list of communities that the user has joined

func (*PublicAPI) LeaveCommunity added in v0.67.0 

func (api *PublicAPI) LeaveCommunity(ctx context.Context, communityID types.HexBytes) (*protocol.MessengerResponse, error)

LeaveCommunity leaves a commuity with the given ID

func (*PublicAPI) LeaveGroupChat 

func (api *PublicAPI) LeaveGroupChat(ctx Context, chatID string, remove bool) (*protocol.MessengerResponse, error)

func (*PublicAPI) ListenAddresses added in v0.115.4 

func (api *PublicAPI) ListenAddresses() ([]string, error)

func (*PublicAPI) LoadFilters 

func (api *PublicAPI) LoadFilters(parent context.Context, chats []*transport.Filter) ([]*transport.Filter, error)

func (*PublicAPI) MarkActivityCenterNotificationsRead added in v0.80.2 

func (api *PublicAPI) MarkActivityCenterNotificationsRead(ctx context.Context, ids []types.HexBytes) (*protocol.MessengerResponse, error)

func (*PublicAPI) MarkActivityCenterNotificationsUnread added in v0.91.0 

func (api *PublicAPI) MarkActivityCenterNotificationsUnread(ctx context.Context, ids []types.HexBytes) (*protocol.MessengerResponse, error)

func (*PublicAPI) MarkAllActivityCenterNotificationsRead added in v0.76.0 

func (api *PublicAPI) MarkAllActivityCenterNotificationsRead(ctx context.Context) (*protocol.MessengerResponse, error)

func (*PublicAPI) MarkAllRead added in v0.47.0 

func (api *PublicAPI) MarkAllRead(ctx context.Context, chatID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) MarkAllReadInCommunity added in v0.87.0 

func (api *PublicAPI) MarkAllReadInCommunity(ctx context.Context, communityID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) MarkAsSeenActivityCenterNotifications added in v0.131.8 

func (api *PublicAPI) MarkAsSeenActivityCenterNotifications() (*protocol.MessengerResponse, error)

func (*PublicAPI) MarkAsTrusted added in v0.102.6 

func (api *PublicAPI) MarkAsTrusted(ctx context.Context, contactID string) error

func (*PublicAPI) MarkAsUntrustworthy added in v0.102.6 

func (api *PublicAPI) MarkAsUntrustworthy(ctx context.Context, contactID string) error

func (*PublicAPI) MarkMessageAsUnread added in v0.171.31 

func (api *PublicAPI) MarkMessageAsUnread(chatID string, messageID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) MarkMessagesRead added in v0.171.40 

func (api *PublicAPI) MarkMessagesRead(chatID string, ids []string) (*protocol.MessengerResponse, error)

func (*PublicAPI) MarkMessagesSeen deprecated 

func (api *PublicAPI) MarkMessagesSeen(chatID string, ids []string) (*MarkMessageSeenResponse, error)

Deprecated: Use MarkMessagesRead instead

func (*PublicAPI) MessageByMessageID added in v0.89.20 

func (api *PublicAPI) MessageByMessageID(messageID string) (*common.Message, error)

func (*PublicAPI) Messenger added in v0.138.8 

func (api *PublicAPI) Messenger() *protocol.Messenger

func (*PublicAPI) MuteChat added in v0.56.1 

func (api *PublicAPI) MuteChat(parent context.Context, chatID string) (time.Time, error)

func (*PublicAPI) MuteChatV2 added in v0.145.2 

func (api *PublicAPI) MuteChatV2(parent context.Context, request *requests.MuteChat) (time.Time, error)

func (*PublicAPI) MuteCommunityCategory added in v0.102.6 

func (api *PublicAPI) MuteCommunityCategory(request *requests.MuteCategory) error

func (*PublicAPI) MuteCommunityChats added in v0.162.5 

func (api *PublicAPI) MuteCommunityChats(request *requests.MuteCommunity) (time.Time, error)

func (*PublicAPI) MyCanceledRequestsToJoin added in v0.114.1 

func (api *PublicAPI) MyCanceledRequestsToJoin() ([]*communities.RequestToJoin, error)

MyCanceledRequestsToJoin returns the pending requests for the logged in user

func (*PublicAPI) MyPendingRequestsToJoin added in v0.72.0 

func (api *PublicAPI) MyPendingRequestsToJoin() ([]*communities.RequestToJoin, error)

MyPendingRequestsToJoin returns the pending requests for the logged in user

func (*PublicAPI) ParseSharedURL added in v0.161.2 

func (api *PublicAPI) ParseSharedURL(url string) (*protocol.URLDataResponse, error)

func (*PublicAPI) Peers added in v0.88.4 

func (api *PublicAPI) Peers() map[string]types.WakuV2Peer

func (*PublicAPI) PendingRequestsToJoinForCommunity added in v0.72.0 

func (api *PublicAPI) PendingRequestsToJoinForCommunity(id types.HexBytes) ([]*communities.RequestToJoin, error)

PendingRequestsToJoinForCommunity returns the pending requests to join for a given community

func (*PublicAPI) PromoteSelfToControlMode added in v0.171.11 

func (api *PublicAPI) PromoteSelfToControlMode(communityID string) error

func (*PublicAPI) PromoteSelfToControlNode added in v0.171.8 

func (api *PublicAPI) PromoteSelfToControlNode(communityID types.HexBytes) (*protocol.MessengerResponse, error)

func (*PublicAPI) ReSendChatMessage 

func (api *PublicAPI) ReSendChatMessage(ctx context.Context, messageID string) error

func (*PublicAPI) ReevaluateCommunityMembersPermissions added in v0.163.14 

func (api *PublicAPI) ReevaluateCommunityMembersPermissions(request *requests.ReevaluateCommunityMembersPermissions) (*protocol.MessengerResponse, error)

ReevaluateCommunityMembersPermissions reevaluates community members permissions

func (*PublicAPI) RegisterForPushNotifications added in v0.56.1 

func (api *PublicAPI) RegisterForPushNotifications(ctx context.Context, deviceToken string, apnTopic string, tokenType protobuf.PushNotificationRegistration_TokenType) error

func (*PublicAPI) RegisterLostOwnershipNotification added in v0.171.11 

func (api *PublicAPI) RegisterLostOwnershipNotification(communityID string) (*protocol.MessengerResponse, error)

Returns response with AC notification when ownership is lost

func (*PublicAPI) RegisterOwnerTokenReceivedNotification added in v0.171.11 

func (api *PublicAPI) RegisterOwnerTokenReceivedNotification(communityID string) (*protocol.MessengerResponse, error)

Returns response with AC notification when owner token is received

func (*PublicAPI) RegisterReceivedCommunityTokenNotification added in v0.172.1 

func (api *PublicAPI) RegisterReceivedCommunityTokenNotification(communityID string, isFirst bool, tokenData string) (*protocol.MessengerResponse, error)

Returns response with AC notification when community token is received

func (*PublicAPI) RegisterReceivedOwnershipNotification added in v0.171.11 

func (api *PublicAPI) RegisterReceivedOwnershipNotification(communityID string) (*protocol.MessengerResponse, error)

Returns response with AC notification when setting signer is successful

func (*PublicAPI) RegisterSetSignerDeclinedNotification added in v0.171.11 

func (api *PublicAPI) RegisterSetSignerDeclinedNotification(communityID string) (*protocol.MessengerResponse, error)

Returns response with AC notification when setting signer is declined

func (*PublicAPI) RegisterSetSignerFailedNotification added in v0.171.11 

func (api *PublicAPI) RegisterSetSignerFailedNotification(communityID string) (*protocol.MessengerResponse, error)

Returns response with AC notification when setting signer is failed

func (*PublicAPI) RegisteredForPushNotifications added in v0.56.1 

func (api *PublicAPI) RegisteredForPushNotifications() (bool, error)

func (*PublicAPI) RemoveBookmark added in v0.102.2 

func (api *PublicAPI) RemoveBookmark(ctx context.Context, url string) error

func (*PublicAPI) RemoveCommunityToken added in v0.162.13 

func (api *PublicAPI) RemoveCommunityToken(chainID int, contractAddress string) error

func (*PublicAPI) RemoveContact added in v0.68.4 

func (api *PublicAPI) RemoveContact(ctx context.Context, pubKey string) (*protocol.MessengerResponse, error)

func (*PublicAPI) RemoveFilters 

func (api *PublicAPI) RemoveFilters(parent context.Context, chats []*transport.Filter) error

func (*PublicAPI) RemoveMemberFromGroupChat 

func (api *PublicAPI) RemoveMemberFromGroupChat(ctx Context, chatID string, member string) (*protocol.MessengerResponse, error)

func (*PublicAPI) RemoveMembersFromGroupChat added in v0.117.1 

func (api *PublicAPI) RemoveMembersFromGroupChat(ctx Context, chatID string, members []string) (*protocol.MessengerResponse, error)

func (*PublicAPI) RemovePrivateKey added in v0.162.9 

func (api *PublicAPI) RemovePrivateKey(id types.HexBytes) (*protocol.MessengerResponse, error)

RemovePrivateKey removes the private key of the community with given ID

func (*PublicAPI) RemovePushNotificationServer added in v0.56.1 

func (api *PublicAPI) RemovePushNotificationServer(ctx context.Context, publicKeyBytes types.HexBytes) error

func (*PublicAPI) RemoveRoleFromMember added in v0.115.5 

func (api *PublicAPI) RemoveRoleFromMember(request *requests.RemoveRoleFromMember) (*protocol.MessengerResponse, error)

func (*PublicAPI) RemoveTrustStatus added in v0.102.6 

func (api *PublicAPI) RemoveTrustStatus(ctx context.Context, contactID string) error

func (*PublicAPI) RemoveTrustVerificationStatus added in v0.179.6 

func (api *PublicAPI) RemoveTrustVerificationStatus(ctx context.Context, contactID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) RemoveUserFromCommunity added in v0.67.0 

func (api *PublicAPI) RemoveUserFromCommunity(communityID types.HexBytes, userPublicKey string) (*protocol.MessengerResponse, error)

RemoveUserFromCommunity removes the user with pk from the community with ID

func (*PublicAPI) ReorderCommunityCategories added in v0.79.3 

func (api *PublicAPI) ReorderCommunityCategories(request *requests.ReorderCommunityCategories) (*protocol.MessengerResponse, error)

ReorderCommunityCategories is used to change the order of the categories of a community

func (*PublicAPI) ReorderCommunityChat added in v0.79.3 

func (api *PublicAPI) ReorderCommunityChat(request *requests.ReorderCommunityChat) (*protocol.MessengerResponse, error)

ReorderCommunityChat allows changing the order of the chat or switching its category

func (*PublicAPI) RequestAddressForTransaction 

func (api *PublicAPI) RequestAddressForTransaction(ctx context.Context, chatID, from, value, contract string) (*protocol.MessengerResponse, error)

func (*PublicAPI) RequestAllHistoricMessages added in v0.79.0 

func (api *PublicAPI) RequestAllHistoricMessages(forceFetchingBackup bool) (*protocol.MessengerResponse, error)

func (*PublicAPI) RequestAllHistoricMessagesWithRetries added in v0.96.0 

func (api *PublicAPI) RequestAllHistoricMessagesWithRetries(forceFetchingBackup bool) (*protocol.MessengerResponse, error)

func (*PublicAPI) RequestCancelDiscordChannelImport added in v0.171.6 

func (api *PublicAPI) RequestCancelDiscordChannelImport(discordChannelID string)

func (*PublicAPI) RequestCancelDiscordCommunityImport added in v0.114.1 

func (api *PublicAPI) RequestCancelDiscordCommunityImport(id string)

func (*PublicAPI) RequestCommunityInfoFromMailserver deprecated added in v0.76.3 

func (api *PublicAPI) RequestCommunityInfoFromMailserver(communityID string) (*communities.Community, error)

Deprecated: RequestCommunityInfoFromMailserver is deprecated in favor of configurable FetchCommunity.

func (*PublicAPI) RequestCommunityInfoFromMailserverAsync deprecated added in v0.94.3 

func (api *PublicAPI) RequestCommunityInfoFromMailserverAsync(communityID string) error

Deprecated: RequestCommunityInfoFromMailserverAsync is deprecated in favor of configurable FetchCommunity.

func (*PublicAPI) RequestCommunityInfoFromMailserverAsyncWithShard deprecated added in v0.170.0 

func (api *PublicAPI) RequestCommunityInfoFromMailserverAsyncWithShard(communityID string, shard *shard.Shard) error

Deprecated: RequestCommunityInfoFromMailserverAsyncWithShard is deprecated in favor of configurable FetchCommunity.

func (*PublicAPI) RequestCommunityInfoFromMailserverWithShard deprecated added in v0.170.0 

func (api *PublicAPI) RequestCommunityInfoFromMailserverWithShard(communityID string, shard *shard.Shard) (*communities.Community, error)

Deprecated: RequestCommunityInfoFromMailserverWithShard is deprecated in favor of configurable FetchCommunity.

func (*PublicAPI) RequestContactInfoFromMailserver added in v0.143.0 

func (api *PublicAPI) RequestContactInfoFromMailserver(pubkey string) (*protocol.Contact, error)

func (*PublicAPI) RequestExtractDiscordChannelsAndCategories added in v0.105.1 

func (api *PublicAPI) RequestExtractDiscordChannelsAndCategories(filesToImport []string)

func (*PublicAPI) RequestImportDiscordChannel added in v0.171.6 

func (api *PublicAPI) RequestImportDiscordChannel(request *requests.ImportDiscordChannel)

func (*PublicAPI) RequestImportDiscordCommunity added in v0.114.1 

func (api *PublicAPI) RequestImportDiscordCommunity(request *requests.ImportDiscordCommunity)

func (*PublicAPI) RequestToJoinCommunity added in v0.72.0 

func (api *PublicAPI) RequestToJoinCommunity(request *requests.RequestToJoinCommunity) (*protocol.MessengerResponse, error)

RequestToJoinCommunity requests to join a particular community

func (*PublicAPI) RequestTransaction 

func (api *PublicAPI) RequestTransaction(ctx context.Context, chatID, value, contract, address string) (*protocol.MessengerResponse, error)

func (*PublicAPI) RetractContactRequest added in v0.100.0 

func (api *PublicAPI) RetractContactRequest(ctx context.Context, request *requests.RetractContactRequest) (*protocol.MessengerResponse, error)

func (*PublicAPI) SaveChat 

func (api *PublicAPI) SaveChat(parent context.Context, chat *protocol.Chat) error

func (*PublicAPI) SaveCommunityToken added in v0.162.13 

func (api *PublicAPI) SaveCommunityToken(token *token.CommunityToken, croppedImage *images.CroppedImage) (*token.CommunityToken, error)

func (*PublicAPI) SaveMessages added in v0.82.0 

func (api *PublicAPI) SaveMessages(parent context.Context, messages []*common.Message) error

func (*PublicAPI) SendChatMessage 

func (api *PublicAPI) SendChatMessage(ctx context.Context, message *common.Message) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendChatMessages added in v0.64.3 

func (api *PublicAPI) SendChatMessages(ctx context.Context, messages []*common.Message) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendContactRequest added in v0.100.0 

func (api *PublicAPI) SendContactRequest(ctx context.Context, request *requests.SendContactRequest) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendContactUpdate 

func (api *PublicAPI) SendContactUpdate(ctx context.Context, contactID, name, picture string, customizationColor multiaccountscommon.CustomizationColor) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendContactUpdates 

func (api *PublicAPI) SendContactUpdates(ctx context.Context, name, picture string, customizationColor multiaccountscommon.CustomizationColor) error

func (*PublicAPI) SendContactVerificationRequest added in v0.102.6 

func (api *PublicAPI) SendContactVerificationRequest(ctx context.Context, contactID string, challenge string) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendEmojiReaction added in v0.56.4 

func (api *PublicAPI) SendEmojiReaction(ctx context.Context, chatID, messageID string, emojiID protobuf.EmojiReaction_Type) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendEmojiReactionRetraction added in v0.56.4 

func (api *PublicAPI) SendEmojiReactionRetraction(ctx context.Context, emojiReactionID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendGroupChatInvitationRejection added in v0.60.0 

func (api *PublicAPI) SendGroupChatInvitationRejection(ctx Context, invitationRequestID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendGroupChatInvitationRequest added in v0.60.0 

func (api *PublicAPI) SendGroupChatInvitationRequest(ctx Context, chatID string, adminPK string, message string) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendGroupChatMessage added in v0.138.8 

func (api *PublicAPI) SendGroupChatMessage(request *requests.SendGroupChatMessage) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendOneToOneMessage added in v0.138.8 

func (api *PublicAPI) SendOneToOneMessage(request *requests.SendOneToOneMessage) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendPairInstallation 

func (api *PublicAPI) SendPairInstallation(ctx context.Context) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendPinMessage added in v0.78.0 

func (api *PublicAPI) SendPinMessage(ctx context.Context, message *common.PinMessage) (*protocol.MessengerResponse, error)

func (*PublicAPI) SendTransaction 

func (api *PublicAPI) SendTransaction(ctx context.Context, chatID, value, contract, transactionHash string, signature types.HexBytes) (*protocol.MessengerResponse, error)

func (*PublicAPI) SetBio added in v0.174.8 

func (api *PublicAPI) SetBio(ctx context.Context, bio string) error

func (*PublicAPI) SetCommunityMuted added in v0.81.0 

func (api *PublicAPI) SetCommunityMuted(request *requests.MuteCommunity) error

SetCommunityMuted sets the community's muted value

func (*PublicAPI) SetCommunityShard added in v0.170.0 

func (api *PublicAPI) SetCommunityShard(request *requests.SetCommunityShard) (*protocol.MessengerResponse, error)

Sets the community shard for a community and updates all active filters for the community

func (*PublicAPI) SetCommunityStorenodes added in v0.175.3 

func (api *PublicAPI) SetCommunityStorenodes(request *requests.SetCommunityStorenodes) (*protocol.MessengerResponse, error)

Sets the community storenodes for a community

func (*PublicAPI) SetContactLocalNickname added in v0.90.0 

func (api *PublicAPI) SetContactLocalNickname(ctx context.Context, request *requests.SetContactLocalNickname) (*protocol.MessengerResponse, error)

func (*PublicAPI) SetCustomNodes added in v0.171.21 

func (api *PublicAPI) SetCustomNodes(request *requests.SetCustomNodes) error

func (*PublicAPI) SetCustomizationColor added in v0.174.1 

func (api *PublicAPI) SetCustomizationColor(ctx context.Context, request *requests.SetCustomizationColor) error

func (*PublicAPI) SetDisplayName added in v0.94.12 

func (api *PublicAPI) SetDisplayName(ctx context.Context, displayName string) error

func (*PublicAPI) SetInstallationMetadata 

func (api *PublicAPI) SetInstallationMetadata(installationID string, data *multidevice.InstallationMetadata) error

SetInstallationMetadata sets the metadata for our own installation

func (*PublicAPI) SetInstallationName added in v0.138.8 

func (api *PublicAPI) SetInstallationName(installationID string, name string) error

SetInstallationName sets the only the name in metadata for a given installation

func (*PublicAPI) SetLightClient added in v0.171.21 

func (api *PublicAPI) SetLightClient(request *requests.SetLightClient) error

func (*PublicAPI) SetLogLevel added in v0.171.21 

func (api *PublicAPI) SetLogLevel(request *requests.SetLogLevel) error

func (*PublicAPI) SetPinnedMailservers added in v0.96.0 

func (api *PublicAPI) SetPinnedMailservers(pinnedMailservers map[string]string) error

func (*PublicAPI) SetProfileShowcasePreferences added in v0.171.5 

func (api *PublicAPI) SetProfileShowcasePreferences(preferences *identity.ProfileShowcasePreferences) error

Set profile showcase preference for current user

func (*PublicAPI) SetUserStatus added in v0.83.2 

func (api *PublicAPI) SetUserStatus(ctx context.Context, status int, customText string) error

func (*PublicAPI) ShareCommunity added in v0.72.0 

func (api *PublicAPI) ShareCommunity(request *requests.ShareCommunity) (*protocol.MessengerResponse, error)

ShareCommunity share the community with a set of users

func (*PublicAPI) ShareCommunityChannelURLWithChatKey added in v0.161.2 

func (api *PublicAPI) ShareCommunityChannelURLWithChatKey(request *requests.CommunityChannelShareURL) (string, error)

func (*PublicAPI) ShareCommunityChannelURLWithData added in v0.161.2 

func (api *PublicAPI) ShareCommunityChannelURLWithData(request *requests.CommunityChannelShareURL) (string, error)

func (*PublicAPI) ShareCommunityURLWithChatKey added in v0.161.2 

func (api *PublicAPI) ShareCommunityURLWithChatKey(communityID types.HexBytes) (string, error)

func (*PublicAPI) ShareCommunityURLWithData added in v0.161.2 

func (api *PublicAPI) ShareCommunityURLWithData(communityID types.HexBytes) (string, error)

func (*PublicAPI) ShareImageMessage added in v0.94.8 

func (api *PublicAPI) ShareImageMessage(request *requests.ShareImageMessage) (*protocol.MessengerResponse, error)

ShareImageMessage share the selected chat image with a set of users

func (*PublicAPI) ShareUserURLWithChatKey added in v0.161.2 

func (api *PublicAPI) ShareUserURLWithChatKey(pubKey string) (string, error)

func (*PublicAPI) ShareUserURLWithData added in v0.161.2 

func (api *PublicAPI) ShareUserURLWithData(pubKey string) (string, error)

func (*PublicAPI) ShareUserURLWithENS added in v0.161.2 

func (api *PublicAPI) ShareUserURLWithENS(pubKey string) (string, error)

func (*PublicAPI) SignData added in v0.171.9 

func (api *PublicAPI) SignData(signParams []account.SignParams) ([]string, error)

Signs the provided messages with the provided accounts and password. Provided accounts must not belong to a keypair that is migrated to a keycard. Otherwise, the signing will fail, cause such accounts should be signed with a keycard.

func (*PublicAPI) SignMessageWithChatKey added in v0.56.6 

func (api *PublicAPI) SignMessageWithChatKey(ctx context.Context, message string) (types.HexBytes, error)

func (*PublicAPI) SlowdownArchivesImport added in v0.156.1 

func (api *PublicAPI) SlowdownArchivesImport(ctx context.Context)

Slows down importing messages from archives

func (*PublicAPI) SpectateCommunity added in v0.111.5 

func (api *PublicAPI) SpectateCommunity(parent context.Context, communityID types.HexBytes) (*protocol.MessengerResponse, error)

SpectateCommunity spectates community with the given ID Meaning user is only a spectator, not a member

func (*PublicAPI) SpeedupArchivesImport added in v0.156.1 

func (api *PublicAPI) SpeedupArchivesImport(ctx context.Context)

Speeds up importing messages from archives

func (*PublicAPI) StartDiscV5 added in v0.91.8 

func (api *PublicAPI) StartDiscV5() error

func (*PublicAPI) StartMessenger added in v0.41.0 

func (api *PublicAPI) StartMessenger() (*protocol.MessengerResponse, error)

func (*PublicAPI) StartPushNotificationsServer added in v0.56.1 

func (api *PublicAPI) StartPushNotificationsServer() error

PushNotifications server endpoints

func (*PublicAPI) StatusUpdates added in v0.83.2 

func (api *PublicAPI) StatusUpdates() (*ApplicationStatusUpdatesResponse, error)

func (*PublicAPI) StopDiscV5 added in v0.91.8 

func (api *PublicAPI) StopDiscV5() error

func (*PublicAPI) StopPushNotificationsServer added in v0.56.1 

func (api *PublicAPI) StopPushNotificationsServer() error

func (*PublicAPI) StorePubsubTopicKey added in v0.166.1 

func (api *PublicAPI) StorePubsubTopicKey(topic string, privKey string) error

func (*PublicAPI) SubscribeToPubsubTopic added in v0.166.1 

func (api *PublicAPI) SubscribeToPubsubTopic(topic string, optPublicKey string) error

func (*PublicAPI) SwitcherCards added in v0.117.3 

func (api *PublicAPI) SwitcherCards() (*ApplicationSwitcherCardsResponse, error)

func (*PublicAPI) SyncChatFromSyncedFrom added in v0.79.0 

func (api *PublicAPI) SyncChatFromSyncedFrom(chatID string) (uint32, error)

func (*PublicAPI) SyncDevices 

func (api *PublicAPI) SyncDevices(ctx context.Context, name, picture string) error

func (*PublicAPI) ToggleCollapsedCommunityCategory added in v0.138.4 

func (api *PublicAPI) ToggleCollapsedCommunityCategory(request *requests.ToggleCollapsedCommunityCategory) error

func (*PublicAPI) TogglePeerSyncing added in v0.176.3 

func (api *PublicAPI) TogglePeerSyncing(request *requests.TogglePeerSyncingRequest) error

func (*PublicAPI) ToggleUseMailservers added in v0.96.0 

func (api *PublicAPI) ToggleUseMailservers(value bool) error

func (*PublicAPI) UnMuteCommunityChats added in v0.162.5 

func (api *PublicAPI) UnMuteCommunityChats(communityID string) (time.Time, error)

func (*PublicAPI) UnbanUserFromCommunity added in v0.102.6 

func (api *PublicAPI) UnbanUserFromCommunity(request *requests.UnbanUserFromCommunity) (*protocol.MessengerResponse, error)

UnbanUserFromCommunity removes the user's pk from the community ban list

func (*PublicAPI) UnblockContact added in v0.90.0 

func (api *PublicAPI) UnblockContact(parent context.Context, contactID string) (*protocol.MessengerResponse, error)

func (*PublicAPI) UnfurlURLs added in v0.151.12 

func (api *PublicAPI) UnfurlURLs(urls []string) (protocol.UnfurlURLsResponse, error)

UnfurlURLs uses a best-effort approach to unfurl each URL. Failed URLs will be removed from the response.

This endpoint expects the client to send URLs normalized by GetTextURLs.

func (*PublicAPI) UnmuteChat added in v0.56.1 

func (api *PublicAPI) UnmuteChat(parent context.Context, chatID string) error

func (*PublicAPI) UnmuteCommunityCategory added in v0.102.6 

func (api *PublicAPI) UnmuteCommunityCategory(communityID string, categoryID string) error

func (*PublicAPI) UnregisterFromPushNotifications added in v0.59.0 

func (api *PublicAPI) UnregisterFromPushNotifications(ctx context.Context) error

func (*PublicAPI) UpdateBookmark added in v0.102.2 

func (api *PublicAPI) UpdateBookmark(ctx context.Context, oldURL string, bookmark browsers.Bookmark) error

func (*PublicAPI) UpdateCommunityTokenAddress added in v0.163.14 

func (api *PublicAPI) UpdateCommunityTokenAddress(chainID int, oldContractAddress string, newContractAddress string) error

func (*PublicAPI) UpdateCommunityTokenState added in v0.133.2 

func (api *PublicAPI) UpdateCommunityTokenState(chainID int, contractAddress string, deployState token.DeployState) error

func (*PublicAPI) UpdateCommunityTokenSupply added in v0.158.0 

func (api *PublicAPI) UpdateCommunityTokenSupply(chainID int, contractAddress string, supply *bigint.BigInt) error

func (*PublicAPI) UpdateMessageOutgoingStatus 

func (api *PublicAPI) UpdateMessageOutgoingStatus(id, newOutgoingStatus string) error

func (*PublicAPI) UpsertSavedAddress added in v0.111.5 

func (api *PublicAPI) UpsertSavedAddress(ctx context.Context, sa wallet.SavedAddress) error

Saved Addresses APIs

func (*PublicAPI) UpsertSwitcherCard added in v0.117.3 

func (api *PublicAPI) UpsertSwitcherCard(request *requests.UpsertSwitcherCard) error

func (*PublicAPI) VerifiedTrusted added in v0.102.6 

func (api *PublicAPI) VerifiedTrusted(ctx context.Context, request *requests.VerifiedTrusted) (*protocol.MessengerResponse, error)

func (*PublicAPI) VerifiedUntrustworthy added in v0.102.6 

func (api *PublicAPI) VerifiedUntrustworthy(ctx context.Context, request *requests.VerifiedUntrustworthy) (*protocol.MessengerResponse, error)

type PublisherSignalHandler 

type PublisherSignalHandler struct{}

PublisherSignalHandler sends signals on protocol events

func (PublisherSignalHandler) BundleAdded 

func (h PublisherSignalHandler) BundleAdded(identity string, installationID string)

func (PublisherSignalHandler) DecryptMessageFailed 

func (h PublisherSignalHandler) DecryptMessageFailed(pubKey string)

func (PublisherSignalHandler) NewMessages 

func (h PublisherSignalHandler) NewMessages(response *protocol.MessengerResponse)

func (PublisherSignalHandler) Stats added in v0.83.8 

func (h PublisherSignalHandler) Stats(stats types.StatsSummary)

type RequestsRegistry 

type RequestsRegistry struct {
	// contains filtered or unexported fields
}

RequestsRegistry keeps map for all requests with timestamp when they were made.

func NewRequestsRegistry 

func NewRequestsRegistry(delay time.Duration) *RequestsRegistry

NewRequestsRegistry creates instance of the RequestsRegistry and returns pointer to it.

func (*RequestsRegistry) Clear 

func (r *RequestsRegistry) Clear()

Clear recreates all structures used for caching requests.

func (*RequestsRegistry) Has 

func (r *RequestsRegistry) Has(uid types.Hash) bool

Has returns true if given uid is stored in registry.

func (*RequestsRegistry) Register 

func (r *RequestsRegistry) Register(uid types.Hash, topics []types.TopicType) error

Register request with given topics. If request with same topics was made in less then configured delay then error will be returned.

func (*RequestsRegistry) Unregister 

func (r *RequestsRegistry) Unregister(uid types.Hash)

Unregister removes request with given UID from registry.

type RetryConfig 

type RetryConfig struct {
	BaseTimeout time.Duration
	// StepTimeout defines duration increase per each retry.
	StepTimeout time.Duration
	MaxRetries  int
}

RetryConfig specifies configuration for retries with timeout and max amount of retries.

type SendDirectMessageRPC 

type SendDirectMessageRPC struct {
	Sig     string // TODO: remove
	Chat    string
	Payload types.HexBytes
	PubKey  types.HexBytes
	DH      bool // TODO: make sure to remove safely
}

SendDirectMessageRPC represents the RPC payload for the SendDirectMessage RPC method

func (SendDirectMessageRPC) ID 

func (m SendDirectMessageRPC) ID() string

TODO: implement with accordance to https://github.com/status-im/status-go/protocol/issues/28.

func (SendDirectMessageRPC) PublicKey 

func (m SendDirectMessageRPC) PublicKey() *ecdsa.PublicKey

func (SendDirectMessageRPC) PublicName 

func (m SendDirectMessageRPC) PublicName() string

type SendPublicMessageRPC 

type SendPublicMessageRPC struct {
	Sig     string // TODO: remove
	Chat    string
	Payload types.HexBytes
}

SendPublicMessageRPC represents the RPC payload for the SendPublicMessage RPC method

func (SendPublicMessageRPC) ID 

func (m SendPublicMessageRPC) ID() string

TODO: implement with accordance to https://github.com/status-im/status-go/protocol/issues/28.

func (SendPublicMessageRPC) PublicKey 

func (m SendPublicMessageRPC) PublicKey() *ecdsa.PublicKey

func (SendPublicMessageRPC) PublicName 

func (m SendPublicMessageRPC) PublicName() string

type Service 

type Service struct {
	// contains filtered or unexported fields
}

Service is a service that provides some additional API to whisper-based protocols like Whisper or Waku.

func New 

func New(
	config params.NodeConfig,
	n types.Node,
	rpcClient *rpc.Client,
	ldb *leveldb.DB,
	mailMonitor *MailRequestMonitor,
	eventSub mailservers.EnvelopeEventSubscriber,
) *Service

func (*Service) APIs 

func (s *Service) APIs() []gethrpc.API

APIs returns a list of new APIs.

func (*Service) ConnectionChanged added in v0.79.0 

func (s *Service) ConnectionChanged(state connection.State)

func (*Service) DisableInstallation 

func (s *Service) DisableInstallation(installationID string) error

DisableInstallation disables an installation for multi-device sync.

func (*Service) EnableInstallation 

func (s *Service) EnableInstallation(installationID string) error

func (*Service) FetchCommunityInfo added in v0.171.8 

func (s *Service) FetchCommunityInfo(communityID string) (*thirdparty.CommunityInfo, error)

Fetch latest community from store nodes.

func (*Service) FillCollectibleMetadata added in v0.171.8 

func (s *Service) FillCollectibleMetadata(community *communities.Community, collectible *thirdparty.FullCollectibleData) error

func (*Service) FillCollectiblesMetadata added in v0.179.4 

func (s *Service) FillCollectiblesMetadata(communityID string, cs []*thirdparty.FullCollectibleData) (bool, error)

func (*Service) GetCommunityID added in v0.171.8 

func (s *Service) GetCommunityID(tokenURI string) string

func (*Service) GetPeer 

func (s *Service) GetPeer(rawURL string) (*enode.Node, error)

func (*Service) InitProtocol 

func (s *Service) InitProtocol(nodeName string, identity *ecdsa.PrivateKey, appDb, walletDb *sql.DB, httpServer *server.MediaServer, multiAccountDb *multiaccounts.Database, acc *multiaccounts.Account, accountManager *account.GethManager, rpcClient *rpc.Client, walletService *wallet.Service, communityTokensService *communitytokens.Service, wakuService *wakuv2.Waku, logger *zap.Logger) error

func (*Service) Messenger added in v0.86.2 

func (s *Service) Messenger() *protocol.Messenger

func (*Service) NodeID 

func (s *Service) NodeID() *ecdsa.PrivateKey

func (*Service) Protocols 

func (s *Service) Protocols() []p2p.Protocol

Protocols returns a new protocols list. In this case, there are none.

func (*Service) SetP2PServer added in v0.82.0 

func (s *Service) SetP2PServer(server *p2p.Server)

func (*Service) Start 

func (s *Service) Start() error

Start is run when a service is started. It does nothing in this case but is required by `node.Service` interface.

func (*Service) StartMessenger added in v0.41.0 

func (s *Service) StartMessenger() (*protocol.MessengerResponse, error)

func (*Service) Stop 

func (s *Service) Stop() error

Stop is run when a service is stopped.

type StoreRequestCursor added in v0.80.2 

type StoreRequestCursor struct {
	Digest       []byte  `json:"digest"`
	ReceivedTime float64 `json:"receivedTime"`
}

type TestNodeWrapper 

type TestNodeWrapper struct {
	// contains filtered or unexported fields
}

func NewTestNodeWrapper 

func NewTestNodeWrapper(whisper types.Whisper, waku types.Waku) *TestNodeWrapper

func (*TestNodeWrapper) AddPeer 

func (w *TestNodeWrapper) AddPeer(url string) error

func (*TestNodeWrapper) GetWaku 

func (w *TestNodeWrapper) GetWaku(_ interface{}) (types.Waku, error)

func (*TestNodeWrapper) GetWakuV2 added in v0.80.2 

func (w *TestNodeWrapper) GetWakuV2(_ interface{}) (types.Waku, error)

func (*TestNodeWrapper) GetWhisper 

func (w *TestNodeWrapper) GetWhisper(_ interface{}) (types.Whisper, error)

func (*TestNodeWrapper) NewENSVerifier 

func (w *TestNodeWrapper) NewENSVerifier(_ *zap.Logger) enstypes.ENSVerifier

func (*TestNodeWrapper) PeersCount added in v0.59.0 

func (w *TestNodeWrapper) PeersCount() int

func (*TestNodeWrapper) RemovePeer 

func (w *TestNodeWrapper) RemovePeer(url string) error

type TimeSource 

type TimeSource func() time.Time

TimeSource is a type used for current time.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.