waku-proto/waku/store/v2beta4/store.proto

syntax = "proto3";

// 13/WAKU2-STORE rfc: https://rfc.vac.dev/spec/13/
// Protocol identifier: /vac/waku/store/2.0.0-beta4
package waku.store.v2beta4;

import "waku/message/v1/message.proto";

message Index {
  bytes digest = 1;
  sint64 receiver_time = 2;
  sint64 sender_time = 3;
  string pubsub_topic = 4;
}

message PagingInfo {
  uint64 page_size = 1;
  Index cursor = 2;
  enum Direction {
    BACKWARD = 0;
    FORWARD = 1;
  }
  Direction direction = 3;
}

message ContentFilter {
  string content_topic = 1;
}

message HistoryQuery {
  // The first field is reserved for future use
  string pubsub_topic = 2;
  repeated ContentFilter content_filters = 3;
  PagingInfo paging_info = 4;
  optional sint64 start_time = 5;
  optional sint64 end_time = 6;
}

message HistoryResponse {
  // The first field is reserved for future use
  repeated waku.message.v1.WakuMessage messages = 2;
  PagingInfo paging_info = 3;
  enum Error {
    NONE = 0;
    INVALID_CURSOR = 1;
    TOO_MANY_REQUESTS = 429;
    SERVICE_UNAVAILABLE = 503;
  }
  Error error = 4;
}

message HistoryRPC {
  string request_id = 1;
  HistoryQuery query = 2;
  HistoryResponse response = 3;
}