refactor(zetacore): delete ballots after maturity

changelog.md

@@ -17,6 +17,7 @@
 
 * [3170](https://github.com/zeta-chain/node/pull/3170) - revamp TSS package in zetaclient
 * [3291](https://github.com/zeta-chain/node/pull/3291) - revamp zetaclient initialization (+ graceful shutdown)
+* [2863](https://github.com/zeta-chain/node/pull/2863) - refactor zetacore to delete matured ballots and add a migration script to remove all old ballots.
 
 ### Fixes
 

docs/cli/zetacored/cli.md

@@ -5376,6 +5376,7 @@ zetacored query observer [flags]
 * [zetacored query](#zetacored-query)	 - Querying subcommands
 * [zetacored query observer get-historical-tss-address](#zetacored-query-observer-get-historical-tss-address)	 - Query tss address by finalized zeta height (for historical tss addresses)
 * [zetacored query observer get-tss-address](#zetacored-query-observer-get-tss-address)	 - Query current tss address
+* [zetacored query observer list-ballots](#zetacored-query-observer-list-ballots)	 - Query all ballots
 * [zetacored query observer list-blame](#zetacored-query-observer-list-blame)	 - Query AllBlameRecords
 * [zetacored query observer list-blame-by-msg](#zetacored-query-observer-list-blame-by-msg)	 - Query AllBlameRecords
 * [zetacored query observer list-chain-nonces](#zetacored-query-observer-list-chain-nonces)	 - list all chainNonces
@@ -5466,6 +5467,40 @@ zetacored query observer get-tss-address [bitcoinChainId]] [flags]
 
 * [zetacored query observer](#zetacored-query-observer)	 - Querying commands for the observer module
 
+## zetacored query observer list-ballots
+
+Query all ballots
+
+```
+zetacored query observer list-ballots [flags]
+```
+
+### Options
+
+```
+      --grpc-addr string   the gRPC endpoint to use for this chain
+      --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
+      --height int         Use a specific height to query state at (this can error if the node is pruning state)
+  -h, --help               help for list-ballots
+      --node string        [host]:[port] to Tendermint RPC interface for this chain 
+  -o, --output string      Output format (text|json) 
+```
+
+### Options inherited from parent commands
+
+```
+      --chain-id string     The network chain ID
+      --home string         directory for config and data 
+      --log_format string   The logging format (json|plain) 
+      --log_level string    The logging level (trace|debug|info|warn|error|fatal|panic) 
+      --log_no_color        Disable colored logs
+      --trace               print out full stack trace on errors
+```
+
+### SEE ALSO
+
+* [zetacored query observer](#zetacored-query-observer)	 - Querying commands for the observer module
+
 ## zetacored query observer list-blame
 
 Query AllBlameRecords

docs/openapi/openapi.swagger.yaml

@@ -29981,6 +29981,65 @@ paths:
           type: string
       tags:
         - Query
+  /zeta-chain/observer/ballots:
+    get:
+      summary: Query all ballots
+      operationId: Query_Ballots
+      responses:
+        "200":
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/observerQueryBallotsResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+      parameters:
+        - name: pagination.key
+          description: |-
+            key is a value returned in PageResponse.next_key to begin
+            querying the next page most efficiently. Only one of offset or key
+            should be set.
+          in: query
+          required: false
+          type: string
+          format: byte
+        - name: pagination.offset
+          description: |-
+            offset is a numeric offset that can be used when key is unavailable.
+            It is less efficient than using key. Only one of offset or key should
+            be set.
+          in: query
+          required: false
+          type: string
+          format: uint64
+        - name: pagination.limit
+          description: |-
+            limit is the total number of results to be returned in the result page.
+            If left empty it will default to a value to be set by each app.
+          in: query
+          required: false
+          type: string
+          format: uint64
+        - name: pagination.count_total
+          description: |-
+            count_total is set to true  to indicate that the result set should include
+            a count of the total number of items available for pagination in UIs.
+            count_total is only respected when offset is used. It is ignored when key
+            is set.
+          in: query
+          required: false
+          type: boolean
+        - name: pagination.reverse
+          description: |-
+            reverse is set to true if results are to be returned in the descending order.
+
+            Since: cosmos-sdk 0.43
+          in: query
+          required: false
+          type: boolean
+      tags:
+        - Query
   /zeta-chain/observer/blame_by_chain_and_nonce/{chain_id}/{nonce}:
     get:
       summary: Queries a list of VoterByIdentifier items.
@@ -57864,6 +57923,31 @@ definitions:
     properties:
       valid:
         type: boolean
+  observerBallot:
+    type: object
+    properties:
+      index:
+        type: string
+      ballot_identifier:
+        type: string
+      voter_list:
+        type: array
+        items:
+          type: string
+      votes:
+        type: array
+        items:
+          $ref: '#/definitions/observerVoteType'
+      observation_type:
+        $ref: '#/definitions/observerObservationType'
+      ballot_threshold:
+        type: string
+      ballot_status:
+        $ref: '#/definitions/observerBallotStatus'
+      ballot_creation_height:
+        type: string
+        format: int64
+    title: https://github.com/zeta-chain/node/issues/939
   observerBallotStatus:
     type: string
     enum:
@@ -58180,6 +58264,16 @@ definitions:
         $ref: '#/definitions/observerObservationType'
       ballot_status:
         $ref: '#/definitions/observerBallotStatus'
+  observerQueryBallotsResponse:
+    type: object
+    properties:
+      ballots:
+        type: array
+        items:
+          type: object
+          $ref: '#/definitions/observerBallot'
+      pagination:
+        $ref: '#/definitions/v1beta1PageResponse'
   observerQueryBlameByChainAndNonceResponse:
     type: object
     properties:

proto/zetachain/zetacore/observer/ballot.proto

@@ -41,3 +41,8 @@ message BallotListForHeight {
   int64 height = 1;
   repeated string ballots_index_list = 2;
 }
+
+message VoterList {
+  string voter_address = 1;
+  VoteType vote_type = 2;
+}

proto/zetachain/zetacore/observer/events.proto

@@ -4,6 +4,7 @@ package zetachain.zetacore.observer;
 import "gogoproto/gogo.proto";
 import "zetachain/zetacore/observer/crosschain_flags.proto";
 import "zetachain/zetacore/observer/observer.proto";
+import "zetachain/zetacore/observer/ballot.proto";
 
 option go_package = "github.com/zeta-chain/node/x/observer/types";
 
@@ -15,6 +16,13 @@ message EventBallotCreated {
   string ballot_type = 5;
 }
 
+message EventBallotDeleted {
+  string msg_type_url = 1;
+  string ballot_identifier = 2;
+  string ballot_type = 3;
+  repeated VoterList voters = 4 [ (gogoproto.nullable) = false ];
+}
+
 message EventKeygenBlockUpdated {
   string msg_type_url = 1;
   string keygen_block = 2;

proto/zetachain/zetacore/observer/query.proto

@@ -171,6 +171,20 @@ service Query {
       returns (QueryOperationalFlagsResponse) {
     option (google.api.http).get = "/zeta-chain/observer/operationalFlags";
   }
+
+  // Query all ballots
+  rpc Ballots(QueryBallotsRequest) returns (QueryBallotsResponse) {
+    option (google.api.http).get = "/zeta-chain/observer/ballots";
+  }
+}
+
+message QueryBallotsRequest {
+  cosmos.base.query.v1beta1.PageRequest pagination = 1;
+}
+
+message QueryBallotsResponse {
+  repeated Ballot ballots = 1 [ (gogoproto.nullable) = false ];
+  cosmos.base.query.v1beta1.PageResponse pagination = 2;
 }
 
 message QueryOperationalFlagsRequest {}
@@ -259,14 +273,10 @@ message QueryHasVotedRequest {
 message QueryHasVotedResponse { bool has_voted = 1; }
 
 message QueryBallotByIdentifierRequest { string ballot_identifier = 1; }
-message VoterList {
-  string voter_address = 1;
-  VoteType vote_type = 2;
-}
 
 message QueryBallotByIdentifierResponse {
   string ballot_identifier = 1;
-  repeated VoterList voters = 2;
+  repeated VoterList voters = 2 [ (gogoproto.nullable) = false ];
   ObservationType observation_type = 3;
   BallotStatus ballot_status = 4;
 }

typescript/zetachain/zetacore/observer/ballot_pb.d.ts

@@ -142,3 +142,32 @@ export declare class BallotListForHeight extends Message<BallotListForHeight> {
   static equals(a: BallotListForHeight | PlainMessage<BallotListForHeight> | undefined, b: BallotListForHeight | PlainMessage<BallotListForHeight> | undefined): boolean;
 }
 
+/**
+ * @generated from message zetachain.zetacore.observer.VoterList
+ */
+export declare class VoterList extends Message<VoterList> {
+  /**
+   * @generated from field: string voter_address = 1;
+   */
+  voterAddress: string;
+
+  /**
+   * @generated from field: zetachain.zetacore.observer.VoteType vote_type = 2;
+   */
+  voteType: VoteType;
+
+  constructor(data?: PartialMessage<VoterList>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "zetachain.zetacore.observer.VoterList";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): VoterList;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): VoterList;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): VoterList;
+
+  static equals(a: VoterList | PlainMessage<VoterList> | undefined, b: VoterList | PlainMessage<VoterList> | undefined): boolean;
+}
+

typescript/zetachain/zetacore/observer/events_pb.d.ts

@@ -5,6 +5,7 @@
 
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
 import { Message, proto3 } from "@bufbuild/protobuf";
+import type { VoterList } from "./ballot_pb.js";
 import type { GasPriceIncreaseFlags } from "./crosschain_flags_pb.js";
 
 /**
@@ -51,6 +52,45 @@ export declare class EventBallotCreated extends Message<EventBallotCreated> {
   static equals(a: EventBallotCreated | PlainMessage<EventBallotCreated> | undefined, b: EventBallotCreated | PlainMessage<EventBallotCreated> | undefined): boolean;
 }
 
+/**
+ * @generated from message zetachain.zetacore.observer.EventBallotDeleted
+ */
+export declare class EventBallotDeleted extends Message<EventBallotDeleted> {
+  /**
+   * @generated from field: string msg_type_url = 1;
+   */
+  msgTypeUrl: string;
+
+  /**
+   * @generated from field: string ballot_identifier = 2;
+   */
+  ballotIdentifier: string;
+
+  /**
+   * @generated from field: string ballot_type = 3;
+   */
+  ballotType: string;
+
+  /**
+   * @generated from field: repeated zetachain.zetacore.observer.VoterList voters = 4;
+   */
+  voters: VoterList[];
+
+  constructor(data?: PartialMessage<EventBallotDeleted>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "zetachain.zetacore.observer.EventBallotDeleted";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): EventBallotDeleted;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): EventBallotDeleted;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): EventBallotDeleted;
+
+  static equals(a: EventBallotDeleted | PlainMessage<EventBallotDeleted> | undefined, b: EventBallotDeleted | PlainMessage<EventBallotDeleted> | undefined): boolean;
+}
+
 /**
  * @generated from message zetachain.zetacore.observer.EventKeygenBlockUpdated
  */