rpc

type Acknowledge struct {
	Error     string
	ErrorCode int // optional error to be used as a hint
}

type AppointRTDTServer struct {
	// AppointCookie is the peer's appointment cookie, generated by the
	// session owner/admin.
	AppointCookie []byte `json:"appoint_cookie"`
}

type AppointRTDTServerReply struct {
	// JoinCookie is the opaque join cookie the client should use to join
	// the RTDT server.
	JoinCookie []byte `json:"join_cookie"`

	// ServerAddress is the address (FQDN or IP and port) of the RTDT server
	// the client should use to join.
	ServerAddress string `json:"server_address"`

	// ServerPubKey is the public key of the RTDT server. If nil, the server
	// does not use client/server encryption (data is sent in plaintext).
	ServerPubKey *zkidentity.FixedSizeSntrupPublicKey `json:"server_pubkey"`
}

type CreateRTDTSession struct {
	// Size is the max number of concurrent users in the session. This
	// determines the payment rates for the session.
	Size uint32 `json:"size"`
}

type CreateRTDTSessionReply struct {
	// SessionCookie is opaque session data that identifies the session.
	SessionCookie []byte `json:"session_cookie"`
}

type ErrUnpaidSubscriptionRV ratchet.RVPoint

type FileManifest struct {
	Index uint64 `json:"index"`
	Size  uint64 `json:"size"`
	Hash  []byte `json:"hash"`
}

type FileMetadata struct {
	Version     uint64            `json:"version"`
	Cost        uint64            `json:"cost"`
	Size        uint64            `json:"size"`
	Directory   string            `json:"directory"`
	Filename    string            `json:"filename"`
	Description string            `json:"description"`
	Hash        string            `json:"hash"`
	Manifest    []FileManifest    `json:"manifest"` // len == number of chunks
	Signature   string            `json:"signature"`
	Attributes  map[string]string `json:"attributes,omitempty"`
}

type GetInvoice struct {
	PaymentScheme string           // LN, on-chain, whatever
	Action        GetInvoiceAction // push or subscribe
}

type GetInvoiceAction string

type GetInvoiceReply struct {
	Invoice string // Depends on payment scheme
}

type GetRTDTAppointCookies struct {
	// SessionCookie is the opaque session cookie created by the
	// CreateRTDTSession PRPC.
	SessionCookie []byte `json:"session_cookie"`

	// OwnerSecret is random data from the session owner. This is used as
	// part of the unique session id in the RTDT server.
	//
	// Using the same SessionCookie with different OwnerSecret values will
	// put users in different RTDT sessions.
	OwnerSecret zkidentity.ShortID `json:"owner_secret"`

	// Peers is the list of peers for which an appointment cookie is
	// requested.
	Peers []RTDTAppointmentCookiePeer `json:"peers"`

	// OldOwnerSecret is the prior owner secret for this session. When
	// specified, the server generates a rotation cookie to be used to
	// perform a live session id rotation.
	OldOwnerSecret *zkidentity.ShortID `json:"old_owner_secret"`
}

type GetRTDTAppointCookiesReply struct {
	// AppointCookies are the appointment cookies for the peer ids passed
	// in the GetAppointCookies PRPC command.
	AppointCookies [][]byte `json:"appoint_cookies"`

	// RotateCookie is the rotate cookie created when rotating the
	// appointment cookies.
	RotateCookie []byte `json:"rotate_cookie"`
}

type InviteFunds struct {
	Tx         TxHash `json:"txid"`
	Index      uint32 `json:"index"`
	Tree       int8   `json:"tree"`
	PrivateKey string `json:"private_key"`
	HeightHint uint32 `json:"height_hint"`
	Address    string `json:"address"`
}

type MaxMsgSizeVersion uint

type Message struct {
	Command   string // discriminator
	TimeStamp int64  // originator timestamp
	Cleartext bool   // If set Payload is in clear text, proxy use only
	Tag       uint32 // client generated tag, shall be unique

}

type MessageMode uint32

type MessageSigner func(message []byte) zkidentity.FixedSizeSignature

type MessageVerifier func(msg []byte, sig *zkidentity.FixedSizeSignature) bool

type OOBPublicIdentityInvite struct {
	Public            zkidentity.PublicIdentity `json:"public"`
	InitialRendezvous zkidentity.ShortID        `json:"initialrendezvous"`
	ResetRendezvous   zkidentity.ShortID        `json:"resetrendezvous"`
	Funds             *InviteFunds              `json:"funds,omitempty"`
}

type Ping struct{}

type Pong struct{}

type PostListItem struct {
	ID        zkidentity.ShortID `json:"id"`
	Title     string             `json:"title"`
	Timestamp int64              `json:"timestamp"`
}

type PostMetadata struct {
	Version    uint64            `json:"version"`
	Attributes map[string]string `json:"attributes,omitempty"`
}

type PostMetadataStatus struct {
	Version    uint64            `json:"version"`
	From       string            `json:"from"` // Who sent update
	Link       string            `json:"link"` // Original post ID
	Attributes map[string]string `json:"attributes,omitempty"`
}

type PushRoutedMessage struct {
	Payload   []byte
	RV        ratchet.RVPoint
	Timestamp int64
	Error     string
}

type RMBlock struct {
}

type RMFTGet struct {
	Directory string `json:"directory"` // Which directory **DEPRECATED
	Filename  string `json:"filename"`  // Which file **DEPRECATED
	Tag       uint32 `json:"tag"`       // Tag to copy in replies
	FileID    string `json:"file_id"`   // Equals metadata hash
}

type RMFTGetChunk struct {
	FileID string `json:"file_id"`
	Hash   []byte `json:"hash"` // Chunk to retrieve
	Index  int    `json:"index"`
	Tag    uint32 `json:"tag"` // Tag to copy in replies
}

type RMFTGetChunkReply struct {
	FileID string  `json:"file_id"`
	Index  int     `json:"index"`
	Chunk  []byte  `json:"chunk"` // Actual data, needs to be hashed to verify
	Tag    uint32  `json:"tag"`
	Error  *string `json:"error,omitempty"`
}

type RMFTGetReply struct {
	Metadata FileMetadata `json:"metadata"`
	Tag      uint32       `json:"tag"`
	Error    *string      `json:"error,omitempty"`
}

type RMFTList struct {
	Directories []string `json:"directories"`      // Which directories to obtain
	Filter      string   `json:"filter,omitempty"` // Filter list by this regex
	Tag         uint32   `json:"tag"`              // Tag to copy in replies
}

type RMFTListReply struct {
	Global []FileMetadata `json:"global,omitempty"`
	Shared []FileMetadata `json:"shared,omitempty"`
	Tag    uint32
	Error  *string `json:"error,omitempty"`
}

type RMFTPayForChunk struct {
	Tag     uint32  `json:"tag"`
	FileID  string  `json:"file_id"`
	Invoice string  `json:"invoice"`
	Index   int     `json:"index"`
	Hash    []byte  `json:"hash"`
	Error   *string `json:"error,omitempty"`
}

type RMFTSendFile struct {
	Metadata FileMetadata `json:"metadata"`
}

type RMFetchResource struct {
	Path  []string          `json:"path"`
	Meta  map[string]string `json:"meta"`
	Tag   ResourceTag       `json:"tag"`
	Data  json.RawMessage   `json:"data"`
	Index uint32            `json:"index"`
	Count uint32            `json:"count"`
}

type RMFetchResourceReply struct {
	Tag    ResourceTag       `json:"tag"`
	Status ResourceStatus    `json:"status"`
	Meta   map[string]string `json:"meta"`
	Data   []byte            `json:"data"`
	Index  uint32            `json:"index"`
	Count  uint32            `json:"count"`
}

type RMGetInvoice struct {
	PayScheme  string
	MilliAtoms uint64
	Tag        uint32
}

type RMGetPost struct {
	ID            zkidentity.ShortID `json:"id"`
	IncludeStatus bool               `json:"include_status"`
}

type RMGroupInvite struct {
	ID          zkidentity.ShortID `json:"id"`          // group id
	Name        string             `json:"name"`        // requested group name
	Token       uint64             `json:"token"`       // invite token
	Description string             `json:"description"` // group description
	Expires     int64              `json:"expires"`     // unix time when this invite expires
	Version     uint8              `json:"version"`     // version the GC is running on
}

type RMGroupJoin struct {
	// XXX who sent this?
	ID    zkidentity.ShortID `json:"id"`    // group id
	Token uint64             `json:"token"` // invite token, implicitly identifies sender
	Error string             `json:"error"` // accept or deny Invite
}

type RMGroupKick struct {
	Member       [zkidentity.IdentitySize]byte `json:"member"`       // kickee
	Reason       string                        `json:"reason"`       // why member was kicked
	Parted       bool                          `json:"parted"`       // kicked/parted
	NewGroupList RMGroupList                   `json:"newgrouplist"` // new GroupList
}

type RMGroupKill struct {
	// XXX who sent this?
	ID     zkidentity.ShortID `json:"id"`     // group id
	Reason string             `json:"reason"` // reason to disassemble group
}

type RMGroupList struct {
	ID         zkidentity.ShortID `json:"id"` // group id
	Name       string             `json:"name"`
	Generation uint64             `json:"generation"` // incremented every time list changes
	Timestamp  int64              `json:"timestamp"`  // unix time last generation changed
	Version    uint8              `json:"version"`    // version of the rules for GC op

	// Members is the list of GC participants. Members[0] is the "owner"
	// of the GC and has power over admins.
	Members []zkidentity.ShortID `json:"members"`

	// ExtraAdmins are additional admins. Members[0] is still considered
	// an admin in version 1 GCs.
	ExtraAdmins []zkidentity.ShortID `json:"extra_admins"`
}

type RMGroupMessage struct {
	ID         zkidentity.ShortID `json:"id"`         // group name
	Generation uint64             `json:"generation"` // Generation used
	Message    string             `json:"message"`    // Actual message
	Mode       MessageMode        `json:"mode"`       // 0 regular mode, 1 /me
}

type RMGroupPart struct {
	// XXX who sent this?
	ID     zkidentity.ShortID `json:"id"`     // group id
	Reason string             `json:"reason"` // reason to depart group
}

type RMGroupUpdateAdmins struct {
	Reason       string      `json:"reason"`
	NewGroupList RMGroupList `json:"newgrouplist"`
}

type RMGroupUpgradeVersion struct {
	NewGroupList RMGroupList `json:"newgrouplist"`
}

type RMHandshakeACK struct{}

type RMHandshakeSYN struct{}

type RMHandshakeSYNACK struct{}

type RMHeader struct {
	Version   uint64 `json:"version"`
	Timestamp int64  `json:"timestamp"`
	Command   string `json:"command"`
	Tag       uint32 `json:"tag"`

	Signature zkidentity.FixedSizeSignature `json:"signature,omitempty"`
}

type RMInvite struct {
	Invitee zkidentity.PublicIdentity `json:"invitee"` // XXX why aren't we using Identity here?
}

type RMInvoice struct {
	Invoice string
	Tag     uint32
	Error   *string `json:"error,omitempty"`
}

type RMKXSearch struct {
	Refs []RMKXSearchRef `json:"refs"`
}

type RMKXSearchRef struct {
	Type RMKXSearchRefType `json:"type"`
	Ref  string            `json:"ref"`
}

type RMKXSearchRefType string

type RMKXSearchReply struct {
	TargetID zkidentity.ShortID   `json:"target_id"`
	IDs      []zkidentity.ShortID `json:"ids"`
}

type RMKXSuggestion struct {
	Target zkidentity.PublicIdentity
}

type RMListPosts struct{}

type RMListPostsReply struct {
	Posts []PostListItem `json:"posts"`
}

type RMMediateIdentity struct {
	Identity [zkidentity.IdentitySize]byte `json:"identity"`
}

type RMOFullKX struct {
	FullKX ratchet.KeyExchange `json:"fullkx"`
}

type RMOHalfKX struct {
	Public            zkidentity.PublicIdentity `json:"public"`
	HalfKX            ratchet.KeyExchange       `json:"halfkx"`
	InitialRendezvous ratchet.RVPoint           `json:"initialrendezvous"`
	ResetRendezvous   ratchet.RVPoint           `json:"resetrendezvous"`
}

type RMOHeader struct {
	Version   uint64 `json:"version"`
	Timestamp int64  `json:"timestamp"`
	Command   string `json:"command"`
}

type RMPostGet struct {
	Link string `json:"link"`
}

type RMPostGetReply struct {
	Attributes map[string]string `json:"attributes"`
	Error      *string           `json:"error,omitempty"`
}

type RMPostShare struct {
	Version    uint64            `json:"version"`
	Attributes map[string]string `json:"attributes"`
}

type RMPostStatus struct {
	Link       string            `json:"link"` // Link to post
	Attributes map[string]string `json:"attributes"`
}

type RMPostStatusReply struct {
	Error *string `json:"error,omitempty"`
}

type RMPostsSubscribe struct {
	// GetPost is an optional post to send to the client, assuming
	// subscribing to the posts worked.
	GetPost *zkidentity.ShortID `json:"get_post,omitempty"`

	// IncludeStatus also sends the post status updates if GetPost != nil.
	IncludeStatus bool `json:"include_status,omitempty"`
}

type RMPostsSubscribeReply struct {
	Error *string `json:"error,omitempty"`
}

type RMPostsUnsubscribe struct{}

type RMPostsUnsubscribeReply struct {
	Error *string `json:"error,omitempty"`
}

type RMPrivateMessage struct {
	Mode    uint32 `json:"mode"`
	Message string `json:"message"`
}

type RMProfileUpdate struct {
	// Avatar is the user's avatar. If set to nil, the avatar is not
	// updated. If set to an empty slice, the avatar is cleared.
	Avatar []byte `json:"avatar"`
}

type RMRTDTAdminCookies struct {
	RV            zkidentity.ShortID  `json:"rv"`
	SessionCookie []byte              `json:"session_cookie"`
	OwnerSecret   *zkidentity.ShortID `json:"owner_secret"`
	Members       []RMRTDTAdminMember `json:"members"`
	NextPeerID    *RTDTPeerID         `json:"next_peer_id"`
}

type RMRTDTAdminMember struct {
	UID                zkidentity.ShortID `json:"uid"`
	PeerID             RTDTPeerID         `json:"peer_id"`
	AppointCookie      []byte             `json:"appoint_cookie"`
	AllowedAsPublisher bool               `json:"allowed_as_publisher"`
}

type RMRTDTDissolveSession struct {
	RV zkidentity.ShortID `json:"rv"`
}

type RMRTDTExitSession struct {
	RV zkidentity.ShortID `json:"rv"`
}

type RMRTDTRemovedFromSession struct {
	RV     zkidentity.ShortID `json:"rv"`
	Reason string             `json:"reason"`
}

type RMRTDTRotateAppointCookie struct {
	RV            zkidentity.ShortID `json:"rv"`
	AppointCookie []byte             `json:"appoint_cookie"`
}

type RMRTDTSession struct {
	// Generation is increased on every change to the session.
	Generation uint32 `json:"generation"`

	// RV is the unique session identifier.
	RV zkidentity.ShortID `json:"rv"`

	// Size is the max number of concurrent users in the session.
	Size uint32 `json:"size"`

	// Description is a small description of the session.
	Description string `json:"description"`

	// Owner is the user ID of the owner of the session.
	Owner zkidentity.ShortID `json:"owner"`

	// Admins is a list of admins of the session.
	Admins []zkidentity.ShortID `json:"admins"`

	// Publishers is a list of users allowed to publish data in the
	// session.
	Publishers []RMRTDTSessionPublisher `json:"publishers"`

	// IsInstant determines if this is an instant/ephemeral call.
	IsInstant bool `json:"is_instant"`
}

type RMRTDTSessionInvite struct {
	// RV is the session RV.
	RV zkidentity.ShortID `json:"rv"`

	// AppointCookie is generated by the server to the session owner/admin
	// and shared with the target client.
	AppointCookie []byte `json:"appoint_cookie"`

	// Size is the max number of users in the session.
	Size uint32 `json:"size"`

	// Description is a brief description of the session.
	Description string `json:"description"`

	// AllowedAsPublisher flags whether the client will be allowed to send
	// data in the session. When this is false, the client can only receive
	// data from other publishers ("spectate").
	AllowedAsPublisher bool `json:"allowed_as_publisher"`

	// PeerID is the peer id the client should use when sending realtime
	// data.
	PeerID RTDTPeerID `json:"peer_id"`

	// GC is filled if this session is to be associated with a particular
	// GC.
	GC *zkidentity.ShortID `json:"gc"`

	// Tag identifies this invite.
	Tag uint64 `json:"tag"`

	// IsInstant determines if this is an instant/ephemeral call.
	//
	// An instant call is one that is not meant for long term tracking, but
	// rather for online/quick/temporary/immediate interaction.
	//
	// Usually, instant calls are immediately joined upon
	// creation/acceptance and are automatically deleted from clients after
	// finalization.
	IsInstant bool `json:"is_instant"`
}

type RMRTDTSessionInviteAccept struct {
	// RV is the RV of the session.
	RV zkidentity.ShortID `json:"rv"`

	// Tag must match the tag in the invitation.
	Tag uint64 `json:"tag"`

	// PublisherKey should be set if the client will send data in the
	// session.
	PublisherKey *zkidentity.FixedSizeSymmetricKey `json:"publisher_key"`
}

type RMRTDTSessionInviteCancel struct {
	// RV is the RV of the session.
	RV zkidentity.ShortID `json:"rv"`

	// Tag must match the tag in the invitation.
	Tag uint64 `json:"tag"`

	// PublisherKey should be set if the client will send data in the
	// session.
	PublisherKey *zkidentity.FixedSizeSymmetricKey `json:"publisher_key"`
}

type RMRTDTSessionPublisher struct {
	// PublisherID is the user ID of the client.
	PublisherID zkidentity.ShortID `json:"publisher_id"`

	// PeerID is the realtime id of messages sent by the client.
	PeerID RTDTPeerID `json:"peer_id"`

	// PublisherKey is the key to decrypt messages from this peer.
	PublisherKey zkidentity.FixedSizeSymmetricKey `json:"publisher_key"`

	// Alias is the user's nick.
	Alias string `json:"alias"`
}

type RMReceiptDomain string

type RMReceiveReceipt struct {
	// Domain is the type of receipt.
	Domain RMReceiptDomain

	// ID is the main ID of the receipt. Depends on the domain.
	//
	// post, postcomments : ID of the post.
	ID *zkidentity.ShortID

	// SubID is the secondary id of the receipt. Depends on the domain.
	//
	// posts: nil
	// postcomments: ID of the comment.
	SubID *zkidentity.ShortID

	// ClientTime is the unix millisecond timestamp of when the client
	// received.
	ClientTime int64
}

type RMResourceBundle struct {
	Resources map[string]RMFetchResourceReply
}

type RMTransitiveMessage struct {
	// For is the invitee identity and the corresponding public key that
	// was used to encrypt the InviteBlob.
	For zkidentity.ShortID `json:"for"`

	// CipherText contains a sntrup4591761 encapsulated shared key that is
	// used to encrypt the message. This ciphertext is decrypted by the
	// intended final recipient.
	CipherText zkidentity.FixedSizeSntrupCiphertext `json:"ciphertext,omitempty"`

	// Message is an encrypted json encoded structure.
	Message []byte `json:"message,omitempty"`
}

type RMTransitiveMessageForward struct {
	// From is the sender identity. This is used as a hint to verify the
	// signature and identity inside Message.
	From zkidentity.ShortID `json:"from"`

	// CipherText contains a sntrup4591761 encapsulated shared key that is
	// used to encrypt the InviteBlob.
	CipherText zkidentity.FixedSizeSntrupCiphertext `json:"ciphertext"`

	// Message is an encrypted json encoded structure.
	Message []byte `json:"message"`
}

type RMTransitiveMessageReply struct {
	// For is the intended recipient that needs Message routed.
	For zkidentity.ShortID `json:"for"`

	// Error is set if the other side encountered an error.
	Error *string `json:"error,omitempty"`
}

type RMTransitiveReset struct {
	HalfKX ratchet.KeyExchange `json:"halfkx"` // Half ratchet
}

type RMTransitiveResetReply struct {
	FullKX ratchet.KeyExchange `json:"fullkx"` // Full ratchet
}

type RMUser struct{}

type RMUserReply struct {
	Identity   [sha256.Size]byte `json:"identity"`
	Attributes map[string]string `json:"attributes"`
}

type RTDTAppointCookie struct {
	// ServerSecret is the random server secret data.
	ServerSecret zkidentity.ShortID

	// OwnerSecret is random data generated by the owner. This is used as
	// part of the session identifier within the RTDT server.
	OwnerSecret zkidentity.ShortID

	// Size is the size of the session.
	Size uint32

	// PeerID is the peer ID that should be used by the client.
	PeerID RTDTPeerID

	// AllowedAsPublisher is true if this peer is allowed to send data in
	// the session.
	AllowedAsPublisher bool

	// IsAdmin is true if this peer is allowed to admin the live RTDT
	// session.
	IsAdmin bool
}

type RTDTAppointmentCookiePeer struct {
	// ID is the RTDT peer id.
	ID RTDTPeerID `json:"id"`

	// AllowedAsPublisher is true if the peer is allowed as publisher in
	// the session.
	AllowedAsPublisher bool `json:"allowed_as_publisher"`

	// IsAdmin is true if the passed peer id is allowed as admin of the
	// session.
	IsAdmin bool `json:"is_admin"`
}

type RTDTDataPacket struct {
	// Stream is the identifier of the logical media stream related to this
	// data.
	Stream RTDTStreamType

	// Timestamp is a monotonically increasing timestamp of the media.
	Timestamp uint32

	// Data is the actual data.
	Data []byte
	// contains filtered or unexported fields
}

type RTDTFramedPacket struct {
	// Target is the peer id of the receiving client in the channel. When
	// sending, this will equal Source to route a data packet to every
	// member of the session. Otherwise, this will be processed as an
	// internal server command.
	Target RTDTPeerID

	// Source is the peer id of the sending client. When receiving, this
	// will be zero for replies to server commands.
	Source RTDTPeerID

	// Sequence is used to drop old packets.
	Sequence uint32

	// Data is the framed packet data. This may be (possibly E2E encrypted)
	// RTDTDataPacket or a serialized server command.
	Data []byte
}

type RTDTJoinCookie struct {
	// ServerSecret is the random server secret data.
	ServerSecret zkidentity.ShortID

	// OwnerSecret is random data generated by the owner. This is used as
	// part of the session identifier within the RTDT server.
	OwnerSecret zkidentity.ShortID

	// Size is the size of the session.
	Size uint32

	// PeerID is the peer ID that should be used by the client.
	PeerID RTDTPeerID

	// EndTimestamp determines when this join cookie expires.
	EndTimestamp int64 `json:"end_timestamp"`

	// PublishAllowance is the total number of bytes that this user may send
	// using this join cookie.
	PublishAllowance uint64 `json:"publish_allowance"`

	// PaymentTag is a unique payment identifier for this join cookie.
	PaymentTag uint64 `json:"payment_tag"`

	// IsAdmin is true if this client is allowed as an admin.
	IsAdmin bool `json:"is_admin"`
}

type RTDTPeerID uint32

type RTDTPingCmd struct {
	// Data is opaque data sent by the sender.
	Data []byte
}

type RTDTPongCmd struct {
	// Data is opaque data, originally sent by the sender of the
	// corresponding Ping.
	Data []byte
}

type RTDTRotateCookie struct {
	// ServerSecret is the random server secret data.
	ServerSecret zkidentity.ShortID `json:"server_secret"`

	// OldOwnerSecret is the previous OwnerSecret value.
	OldOwnerSecret zkidentity.ShortID `json:"old_owner_secret"`

	// NewOwnerSecret is the new OwnerSecret value.
	NewOwnerSecret zkidentity.ShortID `json:"new_owner_secret"`

	// Size is the size of the session.
	Size uint32 `json:"size"`

	// Timestamp is the unix timestamp in seconds of when this cookie was
	// generated.
	Timestamp int64 `json:"timestamp"`

	// PaymentTag is a unique identifier of the cookie.
	PaymentTag uint64 `json:"payment_tag"`
}

type RTDTServerCmdJoinSession struct {
	// JoinCookie is an opaque cookie generated from brserver and sent to
	// the RTDT server.
	JoinCookie []byte
}

type RTDTServerCmdJoinSessionReply struct {
	// ErrCode is the error code for processing this message.
	//
	// Note: the error code is only set when the server is running with
	// a debug flag set. When that flag is not set, this field will be empty
	// even when the session binding failed.
	ErrCode uint64
}

type RTDTServerCmdKickPeer struct {
	KickTarget         RTDTPeerID
	BanDurationSeconds uint32
}

type RTDTServerCmdKickPeerReply struct {
	// KickTarget is the original target of the kick request.
	KickTarget RTDTPeerID

	// ErrCode is the error code for processing this message.
	//
	// Note: the error code is only set when the server is running with
	// a debug flag set. When that flag is not set, this field will be empty
	// even when the command failed.
	ErrCode uint64
}

type RTDTServerCmdLeaveSession struct{}

type RTDTServerCmdLeaveSessionReply struct{}

type RTDTServerCmdMembersBitmap struct {
	// Bitmap is a serialization of a roaring bitmap of peer IDs.
	Bitmap []byte
}

type RTDTServerCmdRotateSessionCookies struct {
	RotateCookie []byte
}

type RTDTServerCmdRotateSessionCookiesReply struct {
	ErrCode uint64
}

type RTDTServerCmdType uint8

type RTDTSessionCookie struct {
	// ServerSecret is random server data. This is used as part of the full
	// session id.
	ServerSecret zkidentity.ShortID

	// Size is the size of the RTDT session (max number of concurrent
	// peers).
	Size uint32
}

type RTDTStreamType uint8

type ResourceStatus uint16

type ResourceTag uint64

type RouteMessage struct {
	Rendezvous    ratchet.RVPoint
	PaidInvoiceID []byte
	Message       []byte
}

type RouteMessageReply struct {
	Error       string
	NextInvoice string
}

type SeederClientAPI struct {
	ServerGroups []SeederServerGroup `json:"serverGroups"`
}

type SeederCommandStatus struct {
	LastUpdated int64                   `json:"lastUpdated"`
	Database    SeederCommandStatusDB   `json:"db"`
	Node        SeederCommandStatusNode `json:"node"`
}

type SeederCommandStatusDB struct {
	Online bool `json:"db_online"`
	Master bool `json:"db_master"`
}

type SeederCommandStatusNode struct {
	Alias         string `json:"alias"`
	Online        bool   `json:"online"`
	PublicKey     string `json:"publicKey"`
	NumPeers      uint32 `json:"numPeers"`
	BlockHeight   int64  `json:"blockHeight"`
	SyncedToChain bool   `json:"syncedToChain"`
	SyncedToGraph bool   `json:"syncedToGraph"`
}

type SeederCommandStatusReply struct {
	Master bool `json:"db_master"`
}

type SeederServerGroup struct {
	Server   string `json:"brserver"`
	LND      string `json:"lnd"`
	IsMaster bool   `json:"isMaster"`
	Online   bool   `json:"online"`
}

type ServerProperty struct {
	Key      string // name of property
	Value    string // value of property
	Required bool   // if true client must handle this entry
}

type SubscribeRoutedMessages struct {
	AddRendezvous []ratchet.RVPoint // Add to subscribed RVs
	DelRendezvous []ratchet.RVPoint // Del from subscribed RVs
	MarkPaid      []ratchet.RVPoint // Mark paid but do not subscribe
}

type SubscribeRoutedMessagesReply struct {
	NextInvoice string
	Error       string
}

type SuggestedClientVersion struct {
	// Client is the client identifier ("brclient", "bruig", etc).
	Client string `json:"client"`

	// Version is the suggested client version (semver compatible).
	Version string `json:"version"`
}

type TxHash chainhash.Hash

type Welcome struct {
	Version    int   // protocol version
	ServerTime int64 // server timestamp

	// Client shall ensure it is compatible with the server requirements
	Properties []ServerProperty // server properties
}