@clonegod/ttd-sui-common 1.0.93 → 1.0.95

package/dist/grpc/protos/sui/rpc/v2/execution_status.proto

@@ -0,0 +1,374 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2;
+
+// The status of an executed transaction.
+message ExecutionStatus {
+  // Indicates if the transaction was successful or not.
+  optional bool success = 1;
+
+  // The error if `success` is false.
+  optional ExecutionError error = 2;
+}
+
+// An error that can occur during the execution of a transaction.
+message ExecutionError {
+  // A human readable description of the error
+  optional string description = 1;
+
+  // The command, if any, during which the error occurred.
+  optional uint64 command = 2;
+
+  enum ExecutionErrorKind {
+    EXECUTION_ERROR_KIND_UNKNOWN = 0;
+
+    // Insufficient gas.
+    INSUFFICIENT_GAS = 1;
+
+    // Invalid `Gas` object.
+    INVALID_GAS_OBJECT = 2;
+
+    // Invariant violation.
+    INVARIANT_VIOLATION = 3;
+
+    // Attempted to use feature that is not supported yet.
+    FEATURE_NOT_YET_SUPPORTED = 4;
+
+    // Move object is larger than the maximum allowed size.
+    OBJECT_TOO_BIG = 5;
+
+    // Package is larger than the maximum allowed size.
+    PACKAGE_TOO_BIG = 6;
+
+    // Circular object ownership.
+    CIRCULAR_OBJECT_OWNERSHIP = 7;
+
+    //
+    // Coin errors.
+    //
+
+    // Insufficient coin balance for requested operation.
+    INSUFFICIENT_COIN_BALANCE = 8;
+
+    // Coin balance overflowed an u64.
+    COIN_BALANCE_OVERFLOW = 9;
+
+    //
+    // Publish/Upgrade errors.
+    //
+
+    // Publish error, non-zero address.
+    // The modules in the package must have their self-addresses set to zero.
+    PUBLISH_ERROR_NON_ZERO_ADDRESS = 10;
+
+    // Sui Move bytecode verification error.
+    SUI_MOVE_VERIFICATION_ERROR = 11;
+
+    //
+    // MoveVm errors.
+    //
+
+    // Error from a non-abort instruction.
+    // Possible causes:
+    //     Arithmetic error, stack overflow, max value depth, or similar.
+    MOVE_PRIMITIVE_RUNTIME_ERROR = 12;
+
+    // Move runtime abort.
+    MOVE_ABORT = 13;
+
+    // Bytecode verification error.
+    VM_VERIFICATION_OR_DESERIALIZATION_ERROR = 14;
+
+    // MoveVm invariant violation.
+    VM_INVARIANT_VIOLATION = 15;
+
+    //
+    // Programmable transaction errors.
+    //
+
+    // Function not found.
+    FUNCTION_NOT_FOUND = 16;
+
+    // Parity mismatch for Move function.
+    // The number of arguments does not match the number of parameters.
+    ARITY_MISMATCH = 17;
+
+    // Type parity mismatch for Move function.
+    // Mismatch between the number of actual versus expected type arguments.
+    TYPE_ARITY_MISMATCH = 18;
+
+    // Non-entry function invoked. Move Call must start with an entry function.
+    NON_ENTRY_FUNCTION_INVOKED = 19;
+
+    // Invalid command argument.
+    COMMAND_ARGUMENT_ERROR = 20;
+
+    // Type argument error.
+    TYPE_ARGUMENT_ERROR = 21;
+
+    // Unused result without the drop ability.
+    UNUSED_VALUE_WITHOUT_DROP = 22;
+
+    // Invalid public Move function signature.
+    // Unsupported return type for return value.
+    INVALID_PUBLIC_FUNCTION_RETURN_TYPE = 23;
+
+    // Invalid transfer object, object does not have public transfer.
+    INVALID_TRANSFER_OBJECT = 24;
+
+    //
+    // Post-execution errors.
+    //
+
+    // Effects from the transaction are too large.
+    EFFECTS_TOO_LARGE = 25;
+
+    // Publish or Upgrade is missing dependency.
+    PUBLISH_UPGRADE_MISSING_DEPENDENCY = 26;
+
+    // Publish or upgrade dependency downgrade.
+    //
+    // Indirect (transitive) dependency of published or upgraded package has been assigned an
+    // on-chain version that is less than the version required by one of the package's
+    // transitive dependencies.
+    PUBLISH_UPGRADE_DEPENDENCY_DOWNGRADE = 27;
+
+    // Invalid package upgrade.
+    PACKAGE_UPGRADE_ERROR = 28;
+
+    // Indicates the transaction tried to write objects too large to storage.
+    WRITTEN_OBJECTS_TOO_LARGE = 29;
+
+    // Certificate is on the deny list.
+    CERTIFICATE_DENIED = 30;
+
+    // Sui Move bytecode verification timed out.
+    SUI_MOVE_VERIFICATION_TIMEDOUT = 31;
+
+    // The requested consensus object operation is not allowed.
+    CONSENSUS_OBJECT_OPERATION_NOT_ALLOWED = 32;
+
+    // Requested consensus object has been deleted.
+    INPUT_OBJECT_DELETED = 33;
+
+    // Certificate is canceled due to congestion on consensus objects.
+    EXECUTION_CANCELED_DUE_TO_CONSENSUS_OBJECT_CONGESTION = 34;
+
+    // Address is denied for this coin type.
+    ADDRESS_DENIED_FOR_COIN = 35;
+
+    // Coin type is globally paused for use.
+    COIN_TYPE_GLOBAL_PAUSE = 36;
+
+    // Certificate is canceled because randomness could not be generated this epoch.
+    EXECUTION_CANCELED_DUE_TO_RANDOMNESS_UNAVAILABLE = 37;
+
+    MOVE_VECTOR_ELEM_TOO_BIG = 38;
+
+    MOVE_RAW_VALUE_TOO_BIG = 39;
+
+    INVALID_LINKAGE = 40;
+  }
+
+  optional ExecutionErrorKind kind = 3;
+
+  oneof error_details {
+    MoveAbort abort = 4;
+    SizeError size_error = 5;
+    CommandArgumentError command_argument_error = 6;
+    TypeArgumentError type_argument_error = 7;
+    PackageUpgradeError package_upgrade_error = 8;
+    IndexError index_error = 9;
+    string object_id = 10;
+    CoinDenyListError coin_deny_list_error = 11;
+    // Set of objects that were congested, leading to the transaction's cancellation.
+    CongestedObjects congested_objects = 12;
+  }
+}
+
+message MoveAbort {
+  optional uint64 abort_code = 1;
+  // Location in Move where the error occurred.
+  optional MoveLocation location = 2;
+  // Extra error information if abort code is a "Clever Error"
+  optional CleverError clever_error = 3;
+}
+
+// Location in Move bytecode where an error occurred.
+message MoveLocation {
+  // The package ID.
+  optional string package = 1;
+  // The module name.
+  optional string module = 2;
+  // The function index.
+  optional uint32 function = 3;
+  // Offset of the instruction where the error occurred.
+  optional uint32 instruction = 4;
+  // The name of the function, if available.
+  optional string function_name = 5;
+}
+
+message CleverError {
+  optional uint64 error_code = 1;
+  optional uint64 line_number = 2;
+  optional string constant_name = 3;
+  optional string constant_type = 4;
+  oneof value {
+    string rendered = 5;
+    bytes raw = 6;
+  }
+}
+
+// A size error.
+message SizeError {
+  // The offending size.
+  optional uint64 size = 1;
+  // The maximum allowable size.
+  optional uint64 max_size = 2;
+}
+
+message IndexError {
+  // Index of an input or result.
+  optional uint32 index = 1;
+
+  // Index of a subresult.
+  optional uint32 subresult = 2;
+}
+
+message CoinDenyListError {
+  // Denied address.
+  optional string address = 1;
+  // Coin type.
+  optional string coin_type = 2;
+}
+
+// Set of objects that were congested, leading to the transaction's cancellation.
+message CongestedObjects {
+  repeated string objects = 1;
+}
+
+// An error with an argument to a command.
+message CommandArgumentError {
+  // Position of the problematic argument.
+  optional uint32 argument = 1;
+
+  enum CommandArgumentErrorKind {
+    COMMAND_ARGUMENT_ERROR_KIND_UNKNOWN = 0;
+
+    // The type of the value does not match the expected type.
+    TYPE_MISMATCH = 1;
+
+    // The argument cannot be deserialized into a value of the specified type.
+    INVALID_BCS_BYTES = 2;
+
+    // The argument cannot be instantiated from raw bytes.
+    INVALID_USAGE_OF_PURE_ARGUMENT = 3;
+
+    // Invalid argument to private entry function.
+    // Private entry functions cannot take arguments from other Move functions.
+    INVALID_ARGUMENT_TO_PRIVATE_ENTRY_FUNCTION = 4;
+
+    // Out of bounds access to input or results.
+    //
+    // `index` field will be set indicating the invalid index value.
+    INDEX_OUT_OF_BOUNDS = 5;
+
+    // Out of bounds access to subresult.
+    //
+    // `index` and `subresult` fields will be set indicating the invalid index value.
+    SECONDARY_INDEX_OUT_OF_BOUNDS = 6;
+
+    // Invalid usage of result.
+    // Expected a single result but found either no return value or multiple.
+    // `index` field will be set indicating the invalid index value.
+    INVALID_RESULT_ARITY = 7;
+
+    // Invalid usage of gas coin.
+    // The gas coin can only be used by-value with a `TransferObject` command.
+    INVALID_GAS_COIN_USAGE = 8;
+
+    // Invalid usage of Move value.
+    //    - Mutably borrowed values require unique usage.
+    //    - Immutably borrowed values cannot be taken or borrowed mutably.
+    //    - Taken values cannot be used again.
+    INVALID_VALUE_USAGE = 9;
+
+    // Immutable objects cannot be passed by-value.
+    INVALID_OBJECT_BY_VALUE = 10;
+
+    // Immutable objects cannot be passed by mutable reference, `&mut`.
+    INVALID_OBJECT_BY_MUT_REF = 11;
+
+    // Consensus object operations such as wrapping, freezing, or converting to owned are not
+    // allowed.
+    CONSENSUS_OBJECT_OPERATION_NOT_ALLOWED = 12;
+
+    // Invalid argument arity. Expected a single argument but found a result that expanded to
+    // multiple arguments.
+    INVALID_ARGUMENT_ARITY = 13;
+  }
+
+  optional CommandArgumentErrorKind kind = 2;
+
+  optional IndexError index_error = 3;
+}
+
+// An error with upgrading a package.
+message PackageUpgradeError {
+  enum PackageUpgradeErrorKind {
+    PACKAGE_UPGRADE_ERROR_KIND_UNKNOWN = 0;
+
+    // Unable to fetch package.
+    UNABLE_TO_FETCH_PACKAGE = 1;
+
+    // Object is not a package.
+    NOT_A_PACKAGE = 2;
+
+    // Package upgrade is incompatible with previous version.
+    INCOMPATIBLE_UPGRADE = 3;
+
+    // Digest in upgrade ticket and computed digest differ.
+    DIGEST_DOES_NOT_MATCH = 4;
+
+    // Upgrade policy is not valid.
+    UNKNOWN_UPGRADE_POLICY = 5;
+
+    // Package ID does not match `PackageId` in upgrade ticket.
+    PACKAGE_ID_DOES_NOT_MATCH = 6;
+  }
+
+  optional PackageUpgradeErrorKind kind = 1;
+
+  // The Package Id.
+  optional string package_id = 2;
+
+  // A digest.
+  optional string digest = 3;
+
+  // The policy.
+  optional uint32 policy = 4;
+
+  // The ticket Id.
+  optional string ticket_id = 5;
+}
+
+// Type argument error.
+message TypeArgumentError {
+  // Index of the problematic type argument.
+  optional uint32 type_argument = 1;
+
+  enum TypeArgumentErrorKind {
+    TYPE_ARGUMENT_ERROR_KIND_UNKNOWN = 0;
+
+    // A type was not found in the module specified.
+    TYPE_NOT_FOUND = 1;
+
+    // A type provided did not match the specified constraint.
+    CONSTRAINT_NOT_SATISFIED = 2;
+  }
+
+  optional TypeArgumentErrorKind kind = 2;
+}

package/dist/grpc/protos/sui/rpc/v2/gas_cost_summary.proto

@@ -0,0 +1,19 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2;
+
+// Summary of gas charges.
+message GasCostSummary {
+  // Cost of computation/execution.
+  optional uint64 computation_cost = 1;
+  // Storage cost, it's the sum of all storage cost for all objects created or mutated.
+  optional uint64 storage_cost = 2;
+  // The amount of storage cost refunded to the user for all objects deleted or mutated in the
+  // transaction.
+  optional uint64 storage_rebate = 3;
+  // The fee for the rebate. The portion of the storage rebate kept by the system.
+  optional uint64 non_refundable_storage_fee = 4;
+}

package/dist/grpc/protos/sui/rpc/v2/input.proto

@@ -0,0 +1,55 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2;
+
+import "google/protobuf/struct.proto";
+
+// An input to a user transaction.
+message Input {
+  enum InputKind {
+    INPUT_KIND_UNKNOWN = 0;
+
+    // A move value serialized as BCS.
+    PURE = 1;
+
+    // A Move object that is either immutable or address owned.
+    IMMUTABLE_OR_OWNED = 2;
+
+    // A Move object whose owner is "Shared".
+    SHARED = 3;
+
+    // A Move object that is attempted to be received in this transaction.
+    RECEIVING = 4;
+  }
+
+  optional InputKind kind = 1;
+
+  // A move value serialized as BCS.
+  //
+  // For normal operations this is required to be a move primitive type and not contain structs
+  // or objects.
+  optional bytes pure = 2;
+
+  // `ObjectId` of the object input.
+  optional string object_id = 3;
+
+  // Requested version of the input object when `kind` is `IMMUTABLE_OR_OWNED`
+  // or `RECEIVING` or if `kind` is `SHARED` this is the initial version of the
+  // object when it was shared
+  optional uint64 version = 4;
+
+  // The digest of this object.
+  optional string digest = 5;
+
+  // Controls whether the caller asks for a mutable reference to the shared
+  // object.
+  optional bool mutable = 6;
+
+  // A literal value
+  //
+  // INPUT ONLY
+  optional google.protobuf.Value literal = 1000;
+}

package/dist/grpc/protos/sui/rpc/v2/jwk.proto

@@ -0,0 +1,38 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2;
+
+// Key to uniquely identify a JWK.
+message JwkId {
+  // The issuer or identity of the OIDC provider.
+  optional string iss = 1;
+  // A key ID used to uniquely identify a key from an OIDC provider.
+  optional string kid = 2;
+}
+
+// A JSON web key.
+//
+// Struct that contains info for a JWK. A list of them for different kinds can
+// be retrieved from the JWK endpoint (for example, <https://www.googleapis.com/oauth2/v3/certs>).
+// The JWK is used to verify the JWT token.
+message Jwk {
+  // Key type parameter, https://datatracker.ietf.org/doc/html/rfc7517#section-4.1.
+  optional string kty = 1;
+  // RSA public exponent, https://datatracker.ietf.org/doc/html/rfc7517#section-9.3.
+  optional string e = 2;
+  // RSA modulus, https://datatracker.ietf.org/doc/html/rfc7517#section-9.3.
+  optional string n = 3;
+  // Algorithm parameter, https://datatracker.ietf.org/doc/html/rfc7517#section-4.4.
+  optional string alg = 4;
+}
+
+// Represents a standard JWT header according to
+// https://openid.net/specs/openid-connect-core-1_0.html
+// message JwtHeader {
+//   optional string alg = 1;
+//   optional string kid = 2;
+//   optional string typ = 3;
+// }

package/dist/grpc/protos/sui/rpc/v2/ledger_service.proto

@@ -0,0 +1,165 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2;
+
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/timestamp.proto";
+import "google/rpc/status.proto";
+import "sui/rpc/v2/checkpoint.proto";
+import "sui/rpc/v2/epoch.proto";
+import "sui/rpc/v2/executed_transaction.proto";
+import "sui/rpc/v2/object.proto";
+
+service LedgerService {
+  // Query the service for general information about its current state.
+  rpc GetServiceInfo(GetServiceInfoRequest) returns (GetServiceInfoResponse);
+
+  rpc GetObject(GetObjectRequest) returns (GetObjectResponse);
+  rpc BatchGetObjects(BatchGetObjectsRequest) returns (BatchGetObjectsResponse);
+
+  rpc GetTransaction(GetTransactionRequest) returns (GetTransactionResponse);
+  rpc BatchGetTransactions(BatchGetTransactionsRequest) returns (BatchGetTransactionsResponse);
+
+  rpc GetCheckpoint(GetCheckpointRequest) returns (GetCheckpointResponse);
+
+  rpc GetEpoch(GetEpochRequest) returns (GetEpochResponse);
+}
+
+message GetServiceInfoRequest {}
+
+message GetServiceInfoResponse {
+  // The chain identifier of the chain that this node is on.
+  //
+  // The chain identifier is the digest of the genesis checkpoint, the
+  // checkpoint with sequence number 0.
+  optional string chain_id = 1;
+
+  // Human-readable name of the chain that this node is on.
+  //
+  // This is intended to be a human-readable name like `mainnet`, `testnet`, and so on.
+  optional string chain = 2;
+
+  // Current epoch of the node based on its highest executed checkpoint.
+  optional uint64 epoch = 3;
+
+  // Checkpoint height of the most recently executed checkpoint.
+  optional uint64 checkpoint_height = 4;
+
+  // Unix timestamp of the most recently executed checkpoint.
+  optional google.protobuf.Timestamp timestamp = 5;
+
+  // The lowest checkpoint for which checkpoints and transaction data are available.
+  optional uint64 lowest_available_checkpoint = 6;
+
+  // The lowest checkpoint for which object data is available.
+  optional uint64 lowest_available_checkpoint_objects = 7;
+
+  // Software version of the service. Similar to the `server` http header.
+  optional string server = 8;
+}
+
+message GetObjectRequest {
+  // Required. The `ObjectId` of the requested object.
+  optional string object_id = 1;
+
+  // Request a specific version of the object.
+  // If no version is specified, and the object is live, then the latest
+  // version of the object is returned.
+  optional uint64 version = 2;
+
+  // Mask specifying which fields to read.
+  // If no mask is specified, defaults to `object_id,version,digest`.
+  optional google.protobuf.FieldMask read_mask = 3;
+}
+
+message GetObjectResponse {
+  optional Object object = 1;
+}
+
+message BatchGetObjectsRequest {
+  repeated GetObjectRequest requests = 1;
+
+  // Mask specifying which fields to read.
+  // If no mask is specified, defaults to `object_id,version,digest`.
+  optional google.protobuf.FieldMask read_mask = 2;
+}
+
+message BatchGetObjectsResponse {
+  repeated GetObjectResult objects = 1;
+}
+
+message GetObjectResult {
+  oneof result {
+    Object object = 1;
+    google.rpc.Status error = 2;
+  }
+}
+
+message GetTransactionRequest {
+  // Required. The digest of the requested transaction.
+  optional string digest = 1;
+
+  // Mask specifying which fields to read.
+  // If no mask is specified, defaults to `digest`.
+  optional google.protobuf.FieldMask read_mask = 2;
+}
+
+message GetTransactionResponse {
+  optional ExecutedTransaction transaction = 1;
+}
+
+message BatchGetTransactionsRequest {
+  // Required. The digests of the requested transactions.
+  repeated string digests = 1;
+
+  // Mask specifying which fields to read.
+  // If no mask is specified, defaults to `digest`.
+  optional google.protobuf.FieldMask read_mask = 2;
+}
+
+message BatchGetTransactionsResponse {
+  repeated GetTransactionResult transactions = 1;
+}
+
+message GetTransactionResult {
+  oneof result {
+    ExecutedTransaction transaction = 1;
+    google.rpc.Status error = 2;
+  }
+}
+
+message GetCheckpointRequest {
+  // If neither is provided, return the latest
+  oneof checkpoint_id {
+    // The sequence number of the requested checkpoint.
+    uint64 sequence_number = 1;
+
+    // The digest of the requested checkpoint.
+    string digest = 2;
+  }
+
+  // Mask specifying which fields to read.
+  // If no mask is specified, defaults to `sequence_number,digest`.
+  optional google.protobuf.FieldMask read_mask = 3;
+}
+
+message GetCheckpointResponse {
+  optional Checkpoint checkpoint = 1;
+}
+
+message GetEpochRequest {
+  // The requested epoch.
+  // If no epoch is provided the current epoch will be returned.
+  optional uint64 epoch = 1;
+
+  // Mask specifying which fields to read.
+  // If no mask is specified, defaults to `epoch`.
+  optional google.protobuf.FieldMask read_mask = 2;
+}
+
+message GetEpochResponse {
+  optional Epoch epoch = 1;
+}