package pubsub.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service Msg
tx.proto:11rpc RemovePublisher (, )
tx.proto:14message
tx.proto:23string publisher_domain = 1
string signer = 2
message
tx.proto:30(message has no fields)
rpc AddSubscriber (, )
tx.proto:15message
tx.proto:32optional subscriber = 1
string signer = 2
message
tx.proto:39(message has no fields)
rpc RemoveSubscriber (, )
tx.proto:16message
tx.proto:41string subscriber_address = 1
string signer = 2
message
tx.proto:48(message has no fields)
rpc AddPublisherIntent (, )
tx.proto:17message
tx.proto:50optional publisher_intent = 1
string signer = 2
message
tx.proto:57(message has no fields)
rpc RemovePublisherIntent (, )
tx.proto:18message
tx.proto:59string subscription_id = 1
string publisher_domain = 2
string signer = 3
message
tx.proto:67(message has no fields)
rpc AddSubscriberIntent (, )
tx.proto:19message
tx.proto:69optional subscriber_intent = 1
string signer = 2
message
tx.proto:76(message has no fields)
rpc RemoveSubscriberIntent (, )
tx.proto:20message
tx.proto:78string subscription_id = 1
string subscriber_address = 2
string signer = 3
message
tx.proto:86(message has no fields)
service Query
query.proto:13rpc Params (, )
query.proto:14message
query.proto:100(message has no fields)
message
query.proto:102optional params = 1
rpc QueryPublisher (, )
query.proto:19message
query.proto:106string publisher_domain = 1
message
query.proto:110optional publisher = 1
rpc QueryPublishers (, )
query.proto:24message
query.proto:114(message has no fields)
message
query.proto:116repeated publishers = 1
rpc QuerySubscriber (, )
query.proto:29message
query.proto:120string subscriber_address = 1
message
query.proto:124optional subscriber = 1
rpc QuerySubscribers (, )
query.proto:34message
query.proto:128(message has no fields)
message
query.proto:130repeated subscribers = 1
message
query.proto:134(message has no fields)
message
query.proto:136repeated subscribers = 1
rpc QueryPublisherIntent (, )
query.proto:44message
query.proto:140string publisher_domain = 1
string subscription_id = 2
message
query.proto:145optional publisher_intent = 1
rpc QueryPublisherIntents (, )
query.proto:49message
query.proto:149(message has no fields)
message
query.proto:151repeated publisher_intents = 1
message
query.proto:155string publisher_domain = 1
message
query.proto:159repeated publisher_intents = 1
message
query.proto:163string subscription_id = 1
message
query.proto:167repeated publisher_intents = 1
rpc QuerySubscriberIntent (, )
query.proto:64message
query.proto:171string subscriber_address = 1
string subscription_id = 2
message
query.proto:176optional subscriber_intent = 1
rpc QuerySubscriberIntents (, )
query.proto:69message
query.proto:180(message has no fields)
message
query.proto:182repeated subscriber_intents = 1
message
query.proto:186string subscriber_address = 1
message
query.proto:190repeated subscriber_intents = 1
message
query.proto:194string subscription_id = 1
message
query.proto:198repeated subscriber_intents = 1
message
query.proto:202string publisher_domain = 1
message
query.proto:206repeated subscriber_intents = 1
message
query.proto:210string subscription_id = 1
message
query.proto:214optional default_subscription = 1
message
query.proto:218(message has no fields)
message
query.proto:220repeated default_subscriptions = 1
message
pubsub.proto:141set the default publisher for a given subscription ID these can be overridden by the client
string title = 1
string description = 2
string subscription_id = 3
string publisher_domain = 4
message
pubsub.proto:148string title = 1
string description = 2
string subscription_id = 3
string publisher_domain = 4
string deposit = 5
message
pubsub.proto:104governance proposal to add a publisher, with domain, adress, and ca_cert the same as the Publisher type proof URL expected in the format: https://<domain>/<address>/cacert.pem and serving cacert.pem matching ca_cert
string title = 1
string description = 2
string domain = 3
string address = 4
string proof_url = 5
string ca_cert = 6
message
pubsub.proto:113string title = 1
string description = 2
string domain = 3
string address = 4
string proof_url = 5
string ca_cert = 6
string deposit = 7
for a given PublisherIntent, determines what types of subscribers may subscribe
Used in:
ANY = 0
any valid account address
VALIDATORS = 1
account address must map to a validator in the active validator set
LIST = 2
a specific list of account addresses
message
pubsub.proto:94represents a default subscription voted in by governance that can be overridden by a subscriber
Used in: , ,
string subscription_id = 1
arbitary string representing a subscription, max length of 128
string publisher_domain = 2
FQDN of the publisher, max length of 256
message
genesis.proto:11GenesisState defines the pubsub module's genesis state.
optional params = 1
repeated publishers = 2
repeated subscribers = 3
repeated publisher_intents = 4
repeated subscriber_intents = 5
repeated default_subscriptions = 6
message
params.proto:9Params defines the parameters for the module.
Used in: ,
(message has no fields)
for a given PublisherIntent, whether or not it is pulled or pushed
Used in:
PULL = 0
subscribers should pull from the provided URL
PUSH = 1
subscribers must provide a URL to receive push messages
message
pubsub.proto:9represents a publisher, which are added via governance
Used in: , ,
string address = 1
account address of the publisher
string domain = 2
unique key, FQDN of the publisher, max length of 256
string ca_cert = 3
the publisher's self-signed CA cert PEM file, expecting TLS 1.3 compatible ECDSA certificates, max length 4096
message
pubsub.proto:56represents a publisher committing to sending messages for a specific subscription ID
unique key is subscription_id and publisher_domain tuple
Used in: , , , , ,
string subscription_id = 1
arbitary string representing a subscription, max length of 128
string publisher_domain = 2
FQDN of the publisher, max length of 256
PublishMethod method = 3
either PULL or PUSH (see enum above for details)
string pull_url = 4
optional, only needs to be set if using the PULL method, max length of 512
AllowedSubscribers allowed_subscribers = 5
either ANY, VALIDATORS, or LIST (see enum above for details)
repeated string allowed_addresses = 6
optional, must be provided if allowed_subscribers is LIST, list of account addresses, max length 256
message
pubsub.proto:157remove a default subscription
string title = 1
string description = 2
string subscription_id = 3
message
pubsub.proto:163string title = 1
string description = 2
string subscription_id = 3
string deposit = 4
message
pubsub.proto:126governance proposal to remove a publisher (publishers can remove themselves, but this might be necessary in the event of a malicious publisher or a key compromise), since Publishers are unique by domain, it's the only necessary information to remove one
string title = 1
string description = 2
string domain = 3
message
pubsub.proto:132string title = 1
string description = 2
string domain = 3
string deposit = 4
message
pubsub.proto:21represents a subscriber, can be set or modified by the owner of the subscriber address
Used in: , , , ,
string address = 1
unique key, account address representation of either an account or a validator
string ca_cert = 2
the subscriber's self-signed CA cert PEM file, expecting TLS 1.3 compatible ECDSA certificates, max length 4096
string push_url = 3
max length of 512
message
pubsub.proto:79represents a subscriber requesting messages for a specific subscription ID and publisher
unique key is subscription_id and subscriber_address tuple, a given subscriber can only subscribe to one publisher per subscription_id at a time
Used in: , , , , , ,
string subscription_id = 1
arbitary string representing a subscription, max length of 128
string subscriber_address = 2
account address of the subscriber
string publisher_domain = 3
FQDN of the publisher, max length of 256