// Copyright 2020. The Tari Project
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
// disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
// following disclaimer in the documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
// products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
syntax = "proto3";

package tari.rpc;

import "types.proto";

message SideChainFeature {
  oneof feature {
    ValidatorNodeRegistration validator_node_registration = 1;
    TemplateRegistration template_registration = 2;
    ConfidentialOutputData confidential_output = 3;
    EvictionProof eviction_proof = 4;
    ValidatorNodeExit validator_node_exit = 5;
  }
  SideChainId sidechain_id = 6;
}

message SideChainId {
  bytes public_key = 1;
  Signature knowledge_proof = 2;
}

message ValidatorNodeRegistration {
  bytes public_key = 1;
  Signature signature = 2;
  bytes claim_public_key = 3;
  uint64 max_epoch = 4;
}

message ValidatorNodeExit {
  bytes public_key = 1;
  Signature signature = 2;
  uint64 max_epoch = 3;
}

message TemplateRegistration {
  bytes author_public_key = 1;
  Signature author_signature = 2;
  string template_name = 3;
  uint32 template_version = 4;
  TemplateType template_type = 5;
  BuildInfo build_info = 6;
  bytes binary_sha = 7;
  string binary_url = 8;
}

message ConfidentialOutputData {
  bytes claim_public_key = 1;
}

message TemplateType {
  oneof template_type {
    WasmInfo wasm = 1;
    FlowInfo flow = 2;
    ManifestInfo manifest = 3;
  }
}

message WasmInfo {
  uint32 abi_version = 1;
}

message FlowInfo {
}

message ManifestInfo {
}

message BuildInfo {
  string repo_url = 1;
  bytes commit_hash = 2;
}


message EvictionProof {
  CommitProof proof = 1;
}

message CommitProof {
  oneof version {
    CommitProofV1 v1 = 1;
  }
}

message CommitProofV1 {
  bytes command = 1;
  SidechainBlockCommitProof commit_proof = 2;
  bytes encoded_inclusion_proof = 3;
}

message SidechainBlockCommitProof {
  SidechainBlockHeader header = 1;
  repeated CommitProofElement proof_elements = 2;
}

message CommitProofElement {
  oneof proof_element {
    QuorumCertificate quorum_certificate = 1;
    DummyChain dummy_chain = 2;
  }
}

message DummyChain {
  repeated ChainLink chain_links = 1;
}

message ChainLink {
  bytes header_hash = 1;
  bytes parent_id = 2;
}

message SidechainBlockHeader {
  uint32 network = 1;
  bytes parent_id = 2;
  bytes justify_id = 3;
  uint64 height = 4;
  uint64 epoch = 5;
  ShardGroup shard_group = 6;
  bytes proposed_by = 7;
  bytes state_merkle_root = 8;
  bytes command_merkle_root = 9;
  bytes metadata_hash = 10;
  Signature signature = 11;
  ShardGroupAccumulatedData accumulated_data = 12;
  bytes epoch_hash = 13;
}

message ShardGroup {
  uint32 start = 1;
  uint32 end_inclusive = 2;
}

message EvictAtom {
  bytes public_key = 1;
}

message QuorumCertificate {
  bytes header_hash = 1;
  bytes parent_id = 2;
  repeated ValidatorSignature signatures = 3;
  QuorumDecision decision = 4;
}

enum QuorumDecision {
  Accept = 0;
  Reject = 1;
}

message ValidatorSignature {
  bytes public_key = 1;
  Signature signature = 2;
}

message ShardGroupAccumulatedData {
  uint64 total_exhaust_burn_msb = 1;
  uint64 total_exhaust_burn_lsb = 2;
}