libra_client 0.1.6 → 0.1.7

data/protos/proof.proto

@@ -51,6 +51,21 @@ message SparseMerkleProof {
   repeated bytes non_default_siblings = 3;
 }
 
+message AccumulatorConsistencyProof {
+  // The root hashes of the frozen subtrees that form the small accumulator.
+  // Note that none of these hashes should be default hash.
+  repeated bytes frozen_subtree_roots = 1;
+
+  // The total number of siblings.
+  uint32 num_siblings = 2;
+
+  // The non-default siblings. Note that the entire list of siblings always
+  // start of zero or more non-default siblings, followed by zero of more
+  // default siblings. So given the total number of siblings and the non-default
+  // siblings we should be able to construct the entire sibling list.
+  repeated bytes non_default_siblings = 3;
+}
+
 // The complete proof used to authenticate a signed transaction.
 message SignedTransactionProof {
   AccumulatorProof ledger_info_to_transaction_info_proof = 1;

data/protos/secret_service.proto

@@ -0,0 +1,64 @@
+// Copyright (c) The Libra Core Contributors
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package secret_service;
+
+// -----------------------------------------------------------------------------
+// ---------------- Service definition
+// -----------------------------------------------------------------------------
+service SecretService {
+    // API to request key generation
+    rpc GenerateKey (GenerateKeyRequest) returns (GenerateKeyResponse) {}
+    // API to request a public key
+    rpc GetPublicKey (PublicKeyRequest) returns (PublicKeyResponse) {}   
+    // API to request a signature
+    rpc Sign (SignRequest) returns (SignResponse) {}
+}
+
+message GenerateKeyRequest {
+    // Spec gives a way to generate the key (potentially BIP32 private derivation path here)
+    KeyType spec = 1;
+}
+
+message GenerateKeyResponse {
+    bytes key_id = 1;
+    ErrorCode code = 2;
+}
+
+message PublicKeyRequest {
+    bytes key_id = 1;
+}
+
+message PublicKeyResponse {
+    bytes public_key = 1;
+    ErrorCode code = 2;
+}
+
+message SignRequest {
+    bytes key_id = 1;
+    // message_hash should be a prehashed message of length crypto::HashValue::LENGTH = 32 bytes
+    bytes message_hash = 2;
+}
+
+message SignResponse {
+  bytes signature = 1;
+  ErrorCode code = 2;
+}
+
+enum ErrorCode {
+    Success = 0;
+    KeyIdNotFound = 1;
+    WrongLength = 2;
+    InvalidParameters = 3;
+    AuthenticationFailed = 4;
+    Unspecified = 5;
+    
+    // Good examples of more error codes: https://developers.yubico.com/YubiHSM2/Component_Reference/KSP/Status_codes.html
+}
+
+enum KeyType {
+     Ed25519 = 0;
+     BLS12381 = 1;
+}

data/protos/state_synchronizer.proto

@@ -0,0 +1,29 @@
+// Copyright (c) The Libra Core Contributors
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package network;
+
+import "ledger_info.proto";
+import "transaction.proto";
+
+message GetChunkRequest {
+  uint64 known_version = 1;
+  uint64 limit = 2;
+  uint64 timeout = 3;
+  types.LedgerInfoWithSignatures ledger_info_with_sigs = 4;
+}
+
+message GetChunkResponse {
+  types.LedgerInfoWithSignatures ledger_info_with_sigs = 1;
+  // chunk of transactions with proof corresponding to version in `ledger_info_with_sigs`
+  types.TransactionListWithProof txn_list_with_proof = 2;
+}
+
+message StateSynchronizerMsg {
+  oneof message {
+    GetChunkRequest chunk_request = 1;
+    GetChunkResponse chunk_response = 2;
+  }
+}

data/protos/storage.proto

@@ -0,0 +1,115 @@
+// Copyright (c) The Libra Core Contributors
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package storage;
+
+import "get_with_proof.proto";
+import "ledger_info.proto";
+import "transaction.proto";
+import "account_state_blob.proto";
+import "proof.proto";
+
+// -----------------------------------------------------------------------------
+// ---------------- Service definition for storage
+// -----------------------------------------------------------------------------
+service Storage {
+    // Write APIs.
+
+    // Persist transactions. Called by Execution when either syncing nodes or
+    // committing blocks during normal operation.
+    rpc SaveTransactions(SaveTransactionsRequest)
+    returns (SaveTransactionsResponse);
+
+    // Read APIs.
+
+    // Used to get a piece of data and return the proof of it. If the client
+    // knows and trusts a ledger info at version v, it should pass v in as the
+    // client_known_version and we will return the latest ledger info together
+    // with the proof that it derives from v.
+    rpc UpdateToLatestLedger(
+    types.UpdateToLatestLedgerRequest)
+    returns (types.UpdateToLatestLedgerResponse);
+
+    // When we receive a request from a peer validator asking a list of
+    // transactions for state synchronization, this API can be used to serve the
+    // request. Note that the peer should specify a ledger version and all proofs
+    // in the response will be relative to this given ledger version.
+    rpc GetTransactions(GetTransactionsRequest) returns (GetTransactionsResponse);
+
+    rpc GetAccountStateWithProofByVersion(
+    GetAccountStateWithProofByVersionRequest)
+    returns (GetAccountStateWithProofByVersionResponse);
+
+    // Returns information needed for libra core to start up.
+    rpc GetStartupInfo(GetStartupInfoRequest)
+    returns (GetStartupInfoResponse);
+}
+
+message SaveTransactionsRequest {
+    // Transactions to persist.
+    repeated types.TransactionToCommit txns_to_commit = 1;
+
+    // The version of the first transaction in `txns_to_commit`.
+    uint64 first_version = 2;
+
+    // If this is set, Storage will check its state after applying the above
+    // transactions matches info in this LedgerInfo before committing otherwise
+    // it denies the request.
+    types.LedgerInfoWithSignatures ledger_info_with_signatures = 3;
+}
+
+message SaveTransactionsResponse {}
+
+message GetTransactionsRequest {
+    // The version to start with.
+    uint64 start_version = 1;
+    // The size of the transaction batch.
+    uint64 batch_size = 2;
+    // All the proofs returned in the response should be relative to this
+    // given version.
+    uint64 ledger_version = 3;
+    // Used to return the events associated with each transaction
+    bool fetch_events = 4;
+}
+
+message GetTransactionsResponse {
+    types.TransactionListWithProof txn_list_with_proof = 1;
+}
+
+message GetAccountStateWithProofByVersionRequest {
+    /// The account address to query with.
+    bytes address = 1;
+
+    /// The version the query is based on.
+    uint64 version = 2;
+}
+
+message GetAccountStateWithProofByVersionResponse {
+    /// The optional blob of account state blob.
+    types.AccountStateBlob account_state_blob = 1;
+
+    /// The state root hash the query is based on.
+    types.SparseMerkleProof sparse_merkle_proof = 2;
+}
+
+message GetStartupInfoRequest {}
+
+message GetStartupInfoResponse {
+    // When this is empty, Storage needs to be bootstrapped via the bootstrap API
+    StartupInfo info = 1;
+}
+
+message StartupInfo {
+    // The latest LedgerInfo. Note that at start up storage can have more
+    // transactions than the latest LedgerInfo indicates due to an incomplete
+    // start up sync.
+    types.LedgerInfo ledger_info = 1;
+    // The latest version. All fields below are based on this version.
+    uint64 latest_version = 2;
+    // The latest account state root hash.
+    bytes account_state_root_hash = 3;
+    // From left to right, root hashes of all frozen subtrees.
+    repeated bytes ledger_frozen_subtree_hashes = 4;
+}

data/protos/transaction.proto

@@ -24,11 +24,15 @@ message RawTransaction {
         // This bypasses the rules for regular transactions so will typically be
         // rejected. Only under special circumstances will it be accepted.
         WriteSet write_set = 4;
+        // The transaction script to execute.
+        Script script = 8;
+        // The MOVE Module to publish.
+        Module module = 9;
     }
     // Maximal total gas specified by wallet to spend for this transaction.
     uint64 max_gas_amount = 5;
     // The price to be paid for each unit of gas.
-    uint64 gas_unit_price = 6;  
+    uint64 gas_unit_price = 6;
     // Expiration time for this transaction.  If storage is queried and
     // the time returned is greater than or equal to this time and this
     // transaction has not been included, you can be certain that it will
@@ -44,6 +48,12 @@ message Program {
     repeated bytes modules = 3;
 }
 
+// The code for the transaction to execute
+message Script {
+    bytes code = 1;
+    repeated TransactionArgument arguments = 2;
+}
+
 // An argument to the transaction if the transaction takes arguments
 message TransactionArgument {
     enum ArgType {
@@ -56,6 +66,11 @@ message TransactionArgument {
     bytes data = 2;
 }
 
+// A Move Module to publish
+message Module {
+    bytes code = 1;
+}
+
 // A generic structure that represents signed RawTransaction
 message SignedTransaction {
     // The serialized Protobuf bytes for RawTransaction, for which the signature

data/protos/validator_public_keys.proto

@@ -0,0 +1,18 @@
+// Copyright (c) The Libra Core Contributors
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package types;
+
+// Protobuf definition for the Rust struct ValidatorPublicKeys
+message ValidatorPublicKeys {
+  // Validator account address
+  bytes account_address = 1;
+  // Consensus public key
+  bytes consensus_public_key = 2;
+  // Network signing publick key
+  bytes network_signing_public_key = 3;
+  /// Network identity publick key
+  bytes network_identity_public_key = 4;
+}

data/protos/validator_set.proto

@@ -0,0 +1,13 @@
+// Copyright (c) The Libra Core Contributors
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package types;
+
+import "validator_public_keys.proto";
+
+// Protobuf definition for the Rust struct ValidatorSet.
+message ValidatorSet {
+  repeated ValidatorPublicKeys validator_public_keys = 1;
+}

data/protos/vm_errors.proto

@@ -5,6 +5,8 @@ syntax = "proto3";
 
 package types;
 
+import "language_storage.proto";
+
 // The statuses and errors produced by the VM can be categorized into a
 // couple different types:
 // 1. Validation Statuses: all the errors that can (/should) be
@@ -83,12 +85,15 @@ message VMVerificationStatus {
     enum StatusKind {
         SCRIPT = 0;
         MODULE = 1;
+        DEPENDENCY = 2;
     }
     StatusKind status_kind = 1;
-    // For StatusKind::SCRIPT this is ignored.
+    // For StatusKind::SCRIPT and DEPENDENCY this is ignored.
     uint32 module_idx = 2;
     VMVerificationErrorKind error_kind = 3;
     string message = 4;
+    // For StatusKind::SCRIPT and MODULE this is ignored.
+    ModuleId dependency_id = 5;
 }
 
 // When a code module/script is published it is verified. These are the
@@ -97,74 +102,81 @@ enum VMVerificationErrorKind {
     // Likewise default to a unknown verification error
     UnknownVerificationError = 0;
     IndexOutOfBounds = 1;
-    RangeOutOfBounds = 2;
-    InvalidSignatureToken = 3;
-    InvalidFieldDefReference = 4;
-    RecursiveStructDefinition = 5;
-    InvalidResourceField = 6;
-    InvalidFallThrough = 7;
-    JoinFailure = 8;
-    NegativeStackSizeWithinBlock = 9;
-    UnbalancedStack = 10;
-    InvalidMainFunctionSignature = 11;
-    DuplicateElement = 12;
-    InvalidModuleHandle = 13;
-    UnimplementedHandle = 14;
-    InconsistentFields = 15;
-    UnusedFields = 16;
-    LookupFailed = 17;
-    VisibilityMismatch = 18;
-    TypeResolutionFailure = 19;
-    TypeMismatch = 20;
-    MissingDependency = 21;
-    PopReferenceError = 22;
-    PopResourceError = 23;
-    ReleaseRefTypeMismatchError = 24;
-    BrTypeMismatchError = 25;
-    AssertTypeMismatchError = 26;
-    StLocTypeMismatchError = 27;
-    StLocUnsafeToDestroyError = 28;
-    RetUnsafeToDestroyError = 29;
-    RetTypeMismatchError = 30;
-    FreezeRefTypeMismatchError = 31;
-    FreezeRefExistsMutableBorrowError = 32;
-    BorrowFieldTypeMismatchError = 33;
-    BorrowFieldBadFieldError = 34;
-    BorrowFieldExistsMutableBorrowError = 35;
-    CopyLocUnavailableError = 36;
-    CopyLocResourceError = 37;
-    CopyLocExistsBorrowError = 38;
-    MoveLocUnavailableError = 39;
-    MoveLocExistsBorrowError = 40;
-    BorrowLocReferenceError = 41;
-    BorrowLocUnavailableError = 42;
-    BorrowLocExistsBorrowError = 43;
-    CallTypeMismatchError = 44;
-    CallBorrowedMutableReferenceError = 45;
-    PackTypeMismatchError = 46;
-    UnpackTypeMismatchError = 47;
-    ReadRefTypeMismatchError = 48;
-    ReadRefResourceError = 49;
-    ReadRefExistsMutableBorrowError = 50;
-    WriteRefTypeMismatchError = 51;
-    WriteRefResourceError = 52;
-    WriteRefExistsBorrowError = 53;
-    WriteRefNoMutableReferenceError = 54;
-    IntegerOpTypeMismatchError = 55;
-    BooleanOpTypeMismatchError = 56;
-    EqualityOpTypeMismatchError = 57;
-    ExistsResourceTypeMismatchError = 58;
-    BorrowGlobalTypeMismatchError = 59;
-    BorrowGlobalNoResourceError = 60;
-    MoveFromTypeMismatchError = 61;
-    MoveFromNoResourceError = 62;
-    MoveToSenderTypeMismatchError = 63;
-    MoveToSenderNoResourceError = 64;
-    CreateAccountTypeMismatchError = 65;
+    CodeUnitIndexOutOfBounds = 2;
+    RangeOutOfBounds = 3;
+    InvalidSignatureToken = 4;
+    InvalidFieldDefReference = 5;
+    RecursiveStructDefinition = 6;
+    InvalidResourceField = 7;
+    InvalidFallThrough = 8;
+    JoinFailure = 9;
+    NegativeStackSizeWithinBlock = 10;
+    UnbalancedStack = 11;
+    InvalidMainFunctionSignature = 12;
+    DuplicateElement = 13;
+    InvalidModuleHandle = 14;
+    UnimplementedHandle = 15;
+    InconsistentFields = 16;
+    UnusedFields = 17;
+    LookupFailed = 18;
+    VisibilityMismatch = 19;
+    TypeResolutionFailure = 20;
+    TypeMismatch = 21;
+    MissingDependency = 22;
+    PopReferenceError = 23;
+    PopResourceError = 24;
+    ReleaseRefTypeMismatchError = 25;
+    BrTypeMismatchError = 26;
+    AbortTypeMismatchError = 27;
+    StLocTypeMismatchError = 28;
+    StLocUnsafeToDestroyError = 29;
+    RetUnsafeToDestroyError = 30;
+    RetTypeMismatchError = 31;
+    FreezeRefTypeMismatchError = 32;
+    FreezeRefExistsMutableBorrowError = 33;
+    BorrowFieldTypeMismatchError = 34;
+    BorrowFieldBadFieldError = 35;
+    BorrowFieldExistsMutableBorrowError = 36;
+    CopyLocUnavailableError = 37;
+    CopyLocResourceError = 38;
+    CopyLocExistsBorrowError = 39;
+    MoveLocUnavailableError = 40;
+    MoveLocExistsBorrowError = 41;
+    BorrowLocReferenceError = 42;
+    BorrowLocUnavailableError = 43;
+    BorrowLocExistsBorrowError = 44;
+    CallTypeMismatchError = 45;
+    CallBorrowedMutableReferenceError = 46;
+    PackTypeMismatchError = 47;
+    UnpackTypeMismatchError = 48;
+    ReadRefTypeMismatchError = 49;
+    ReadRefResourceError = 50;
+    ReadRefExistsMutableBorrowError = 51;
+    WriteRefTypeMismatchError = 52;
+    WriteRefResourceError = 53;
+    WriteRefExistsBorrowError = 54;
+    WriteRefNoMutableReferenceError = 55;
+    IntegerOpTypeMismatchError = 56;
+    BooleanOpTypeMismatchError = 57;
+    EqualityOpTypeMismatchError = 58;
+    ExistsResourceTypeMismatchError = 59;
+    ExistsNoResourceError = 60;
+    BorrowGlobalTypeMismatchError = 61;
+    BorrowGlobalNoResourceError = 62;
+    MoveFromTypeMismatchError = 63;
+    MoveFromNoResourceError = 64;
+    MoveToSenderTypeMismatchError = 65;
+    MoveToSenderNoResourceError = 66;
+    CreateAccountTypeMismatchError = 67;
+    GlobalReferenceError = 68;
     // The self address of a module the transaction is publishing is not the sender address
-    ModuleAddressDoesNotMatchSender = 66;
+    ModuleAddressDoesNotMatchSender = 69;
     // The module does not have any module handles. Each module or script must have at least one module handle.
-    NoModuleHandles = 67;
+    NoModuleHandles = 70;
+    MissingAcquiresResourceAnnotationError = 71;
+    ExtraneousAcquiresResourceAnnotationError = 72;
+    DuplicateAcquiresResourceAnnotationError = 73;
+    InvalidAcquiresResourceAnnotationError = 74;
 }
 
 // These are errors that the VM might raise if a violation of internal
@@ -179,6 +191,8 @@ enum VMInvariantViolationError {
     LinkerError = 6;
     LocalReferenceError = 7;
     StorageError = 8;
+    InternalTypeError = 9;
+    EventKeyMismatch = 10;
 }
 
 // Errors that can arise from binary decoding (deserialization)
@@ -225,11 +239,13 @@ enum RuntimeStatus {
     // The sender is trying to publish a module named `M`, but the sender's account already contains
     // a module with this name.
     DuplicateModuleName = 15;
+    ExecutionStackOverflow = 16;
+    CallStackOverflow = 17;
 }
 
-// user-defined assertion error code number
-message AssertionFailure {
-    uint64 assertion_error_code = 1;
+// user-defined abort error code number
+message Aborted {
+    uint64 aborted_error_code = 1;
 }
 
 message ArithmeticError {
@@ -258,7 +274,7 @@ message DynamicReferenceError {
 message ExecutionStatus {
     oneof execution_status {
         RuntimeStatus runtime_status = 1;
-        AssertionFailure assertion_failure = 2;
+        Aborted aborted = 2;
         ArithmeticError arithmetic_error = 3;
         DynamicReferenceError reference_error = 4;
     }