@clonegod/ttd-sui-common 1.0.6 → 1.0.7

package/dist/grpc/protos/sui/rpc/v2beta2/live_data_service.proto

@@ -0,0 +1,298 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2beta2;
+
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/struct.proto";
+import "sui/rpc/v2beta2/argument.proto";
+import "sui/rpc/v2beta2/bcs.proto";
+import "sui/rpc/v2beta2/executed_transaction.proto";
+import "sui/rpc/v2beta2/object.proto";
+import "sui/rpc/v2beta2/transaction.proto";
+
+service LiveDataService {
+  rpc ListDynamicFields(ListDynamicFieldsRequest) returns (ListDynamicFieldsResponse);
+  rpc ListOwnedObjects(ListOwnedObjectsRequest) returns (ListOwnedObjectsResponse);
+  rpc GetCoinInfo(GetCoinInfoRequest) returns (GetCoinInfoResponse);
+  rpc GetBalance(GetBalanceRequest) returns (GetBalanceResponse);
+  rpc ListBalances(ListBalancesRequest) returns (ListBalancesResponse);
+
+  rpc SimulateTransaction(SimulateTransactionRequest) returns (SimulateTransactionResponse);
+}
+
+// Request message for `NodeService.GetCoinInfo`.
+message GetCoinInfoRequest {
+  // The coin type to request information about
+  optional string coin_type = 1;
+}
+
+// Response message for `NodeService.GetCoinInfo`.
+message GetCoinInfoResponse {
+  // Required. The coin type.
+  optional string coin_type = 1;
+
+  // This field will be populated with information about this coin
+  // type's `0x2::coin::CoinMetadata` if it exists and has not been wrapped.
+  optional CoinMetadata metadata = 2;
+
+  // This field will be populated with information about this coin
+  // type's `0x2::coin::TreasuryCap` if it exists and has not been wrapped.
+  optional CoinTreasury treasury = 3;
+
+  // If this coin type is a regulated coin, this field will be
+  // populated with information about its `0x2::coin::RegulatedCoinMetadata`
+  // object.
+  optional RegulatedCoinMetadata regulated_metadata = 4;
+}
+
+// Metadata for a coin type
+message CoinMetadata {
+  // ObjectId of the `0x2::coin::CoinMetadata` object or
+  // 0x2::sui::coin_registry::CoinData object (when registered with CoinRegistry).
+  optional string id = 1;
+  // Number of decimal places to coin uses.
+  optional uint32 decimals = 2;
+  // Name for the token
+  optional string name = 3;
+  // Symbol for the token
+  optional string symbol = 4;
+  // Description of the token
+  optional string description = 5;
+  // URL for the token logo
+  optional string icon_url = 6;
+
+  // The MetadataCap ID if it has been claimed for this coin type.
+  // This capability allows updating the coin's metadata fields.
+  // Only populated when metadata is from CoinRegistry.
+  optional string metadata_cap_id = 7;
+}
+
+// Information about a coin type's `0x2::coin::TreasuryCap` and its total available supply
+message CoinTreasury {
+  // Supply state of a coin, matching the Move SupplyState enum
+  enum SupplyState {
+    // Supply is unknown or TreasuryCap still exists (minting still possible)
+    SUPPLY_STATE_UNKNOWN = 0;
+    // Supply is fixed (TreasuryCap consumed, no more minting possible)
+    FIXED = 1;
+  }
+  // ObjectId of the `0x2::coin::TreasuryCap` object.
+  optional string id = 1;
+  // Total available supply for this coin type.
+  optional uint64 total_supply = 2;
+  // Supply state indicating if the supply is fixed or can still be minted
+  optional SupplyState supply_state = 3;
+}
+
+// Information about a regulated coin, which indicates that it makes use of the transfer deny list.
+message RegulatedCoinMetadata {
+  // ObjectId of the `0x2::coin::RegulatedCoinMetadata` object.
+  optional string id = 1;
+  // The ID of the coin's `CoinMetadata` or `CoinData` object.
+  optional string coin_metadata_object = 2;
+  // The ID of the coin's `DenyCap` object.
+  optional string deny_cap_object = 3;
+}
+
+// Request message for `LiveDataService.GetBalance`.
+message GetBalanceRequest {
+  // Required. The owner's Sui address.
+  optional string owner = 1;
+
+  // Required. The type names for the coin (e.g., 0x2::sui::SUI).
+  optional string coin_type = 2;
+}
+
+// Response message for `LiveDataService.GetBalance`.
+// Return the total coin balance for one coin type, owned by the address owner.
+message GetBalanceResponse {
+  // The balance information for the requested coin type.
+  optional Balance balance = 1;
+}
+
+// Request message for `LiveDataService.ListBalances`.
+message ListBalancesRequest {
+  // Required. The owner's Sui address.
+  optional string owner = 1;
+
+  // The maximum number of balance entries to return. The service may return fewer than this value.
+  // If unspecified, at most `50` entries will be returned.
+  // The maximum value is `1000`; values above `1000` will be coerced to `1000`.
+  optional uint32 page_size = 2;
+
+  // A page token, received from a previous `ListBalances` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListBalances` must
+  // match the call that provided the page token.
+  optional bytes page_token = 3;
+}
+
+// Response message for `LiveDataService.ListBalances`.
+// Return the total coin balance for all coin types, owned by the address owner.
+message ListBalancesResponse {
+  // The list of coin types and their respective balances.
+  repeated Balance balances = 1;
+
+  // A token, which can be sent as `page_token` to retrieve the next page.
+  // If this field is omitted, there are no subsequent pages.
+  optional bytes next_page_token = 2;
+}
+
+// Balance information for a specific coin type.
+message Balance {
+  // The type of the coin (e.g., 0x2::sui::SUI).
+  optional string coin_type = 1;
+
+  // Shows the total balance of the coin in its smallest unit.
+  optional uint64 balance = 3;
+}
+
+// Request message for `NodeService.ListDynamicFields`
+message ListDynamicFieldsRequest {
+  // Required. The `UID` of the parent, which owns the collections of dynamic fields.
+  optional string parent = 1;
+
+  // The maximum number of dynamic fields to return. The service may return fewer than this value.
+  // If unspecified, at most `50` entries will be returned.
+  // The maximum value is `1000`; values above `1000` will be coerced to `1000`.
+  optional uint32 page_size = 2;
+
+  // A page token, received from a previous `ListDynamicFields` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListDynamicFields` must
+  // match the call that provided the page token.
+  optional bytes page_token = 3;
+
+  optional google.protobuf.FieldMask read_mask = 4;
+}
+
+// Response message for `NodeService.ListDynamicFields`
+message ListDynamicFieldsResponse {
+  // Page of dynamic fields owned by the specified parent.
+  repeated DynamicField dynamic_fields = 1;
+
+  // A token, which can be sent as `page_token` to retrieve the next page.
+  // If this field is omitted, there are no subsequent pages.
+  optional bytes next_page_token = 2;
+}
+
+message DynamicField {
+  enum DynamicFieldKind {
+    DYNAMIC_FIELD_KIND_UNKNOWN = 0;
+    FIELD = 1;
+    OBJECT = 2;
+  }
+
+  optional DynamicFieldKind kind = 1;
+
+  // ObjectId of this dynamic field's parent.
+  optional string parent = 2;
+
+  // ObjectId of this dynamic field.
+  optional string field_id = 3;
+
+  // The type of the dynamic field "name"
+  optional string name_type = 4;
+
+  // The serialized move value of "name"
+  optional bytes name_value = 5;
+
+  // The type of the dynamic field "value".
+  //
+  // If this is a dynamic object field then this is the type of the object
+  // itself (which is a child of this field), otherwise this is the type of the
+  // value of this field.
+  optional string value_type = 6;
+
+  // The ObjectId of the child object when a child is a dynamic
+  // object field.
+  //
+  // The presence or absence of this field can be used to determine if a child
+  // is a dynamic field or a dynamic child object
+  optional string dynamic_object_id = 7;
+
+  // The object itself when a child is a dynamic object field.
+  optional Object object = 8;
+}
+
+message SimulateTransactionRequest {
+  optional Transaction transaction = 1;
+  optional google.protobuf.FieldMask read_mask = 2;
+
+  // buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
+  enum TransactionChecks {
+    ENABLED = 0;
+    DISABLED = 1;
+  }
+
+  // Specify whether checks should be ENABLED (default) or DISABLED while executing the transaction
+  optional TransactionChecks checks = 3;
+
+  // Perform gas selection based on a budget estimation and include the
+  // selected gas payment and budget in the response.
+  //
+  // This option will be ignored if `checks` is `DISABLED`.
+  optional bool do_gas_selection = 4;
+}
+
+message SimulateTransactionResponse {
+  optional ExecutedTransaction transaction = 1;
+  repeated CommandResult outputs = 2;
+}
+
+// An intermediate result/output from the execution of a single command
+message CommandResult {
+  repeated CommandOutput return_values = 1;
+  repeated CommandOutput mutated_by_ref = 2;
+}
+
+message CommandOutput {
+  optional Argument argument = 1;
+  optional Bcs value = 2;
+
+  // JSON rendering of the output.
+  optional google.protobuf.Value json = 3;
+}
+
+message ListOwnedObjectsRequest {
+  // Required. The address of the account that owns the objects.
+  optional string owner = 1;
+
+  // The maximum number of entries return. The service may return fewer than this value.
+  // If unspecified, at most `50` entries will be returned.
+  // The maximum value is `1000`; values above `1000` will be coerced to `1000`.
+  optional uint32 page_size = 2;
+
+  // A page token, received from a previous `ListOwnedObjects` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListOwnedObjects` must
+  // match the call that provided the page token.
+  optional bytes page_token = 3;
+
+  optional google.protobuf.FieldMask read_mask = 4;
+
+  // Optional type filter to limit the types of objects listed.
+  //
+  // Providing an object type with no type params will return objects of that
+  // type with any type parameter, e.g. `0x2::coin::Coin` will return all
+  // `Coin<T>` objects regardless of the type parameter `T`. Providing a type
+  // with a type param will retrict the returned objects to only those objects
+  // that match the provided type parameters, e.g.
+  // `0x2::coin::Coin<0x2::sui::SUI>` will only return `Coin<SUI>` objects.
+  optional string object_type = 5;
+}
+
+message ListOwnedObjectsResponse {
+  // Page of dynamic fields owned by the specified parent.
+  repeated Object objects = 1;
+
+  // A token, which can be sent as `page_token` to retrieve the next page.
+  // If this field is omitted, there are no subsequent pages.
+  optional bytes next_page_token = 2;
+}

package/dist/grpc/protos/sui/rpc/v2beta2/move_package.proto

@@ -0,0 +1,238 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2beta2;
+
+// A Move Package
+message Package {
+  // The PackageId of this package
+  //
+  // A package's `storage_id` is the Sui ObjectId of the package on-chain.
+  // Outside of system packages the `storage_id` for every package version is
+  // different.
+  optional string storage_id = 1;
+
+  // The PackageId of the first published version of this package.
+  //
+  // A package's `original_id` (sometimes also called its `runtime_id`) is the
+  // `storage_id` of the first version of this package that has been published.
+  // The `original_id`/`runtime_id` is stable across all versions of the
+  // package and does not ever change.
+  optional string original_id = 2;
+
+  // The version of this package
+  optional uint64 version = 3;
+
+  // The modules defined by this package
+  repeated Module modules = 4;
+
+  // List of datatype origins for mapping datatypes to a package version where
+  // it was first defined
+  repeated TypeOrigin type_origins = 5;
+
+  // The package's transitive dependencies as a mapping from the package's
+  // runtime Id (the Id it is referred to by in other packages) to its
+  // storage Id (the Id it is loaded from on chain).
+  repeated Linkage linkage = 6;
+}
+
+// A Move Module.
+message Module {
+  // Name of this module.
+  optional string name = 1;
+
+  // Serialized bytecode of the module.
+  optional bytes contents = 2;
+
+  // List of DataTypes defined by this module.
+  repeated DatatypeDescriptor datatypes = 3;
+
+  // List of Functions defined by this module.
+  repeated FunctionDescriptor functions = 4;
+
+  // List of Constants defined by this module.
+  // repeated Constant constants = 5;
+}
+
+// Describes a Move Datatype.
+message DatatypeDescriptor {
+  // Fully qualified name of this Datatype.
+  //
+  // This is `<defining_id>::<module>::<name>`
+  optional string type_name = 1;
+
+  // PackageId of the package where this Datatype is defined.
+  //
+  // A type's `defining_id` is the `storage_id` of the package version that first introduced or added that type.
+  optional string defining_id = 2;
+
+  // Name of the module where this Datatype is defined
+  optional string module = 3;
+
+  // Name of this Datatype
+  optional string name = 4;
+
+  // This type's abilities
+  repeated Ability abilities = 5;
+
+  // Ability constraints and phantom status for this type's generic type parameters
+  repeated TypeParameter type_parameters = 6;
+
+  enum DatatypeKind {
+    DATATYPE_KIND_UNKNOWN = 0;
+    STRUCT = 1;
+    ENUM = 2;
+  }
+
+  // Indicates whether this datatype is a 'STRUCT' or an 'ENUM'
+  optional DatatypeKind kind = 7;
+
+  // Set of fields if this Datatype is a struct.
+  //
+  // The order of the entries is the order of how the fields are defined.
+  repeated FieldDescriptor fields = 8;
+
+  // Set of variants if this Datatype is an enum.
+  //
+  // The order of the entries is the order of how the variants are defined.
+  repeated VariantDescriptor variants = 9;
+}
+
+// An `Ability` classifies what operations are permitted for a given type
+enum Ability {
+  ABILITY_UNKNOWN = 0;
+
+  // Allows values of types with this ability to be copied
+  COPY = 1;
+
+  // Allows values of types with this ability to be dropped.
+  DROP = 2;
+
+  // Allows values of types with this ability to exist inside a struct in global storage
+  STORE = 3;
+
+  // Allows the type to serve as a key for global storage operations
+  KEY = 4;
+}
+
+// A generic type parameter used in the declaration of a struct or enum.
+message TypeParameter {
+  // The type parameter constraints
+  repeated Ability constraints = 1;
+
+  // Whether the parameter is declared as phantom
+  optional bool is_phantom = 2;
+}
+
+// Descriptor of a field that belongs to a struct or enum variant
+message FieldDescriptor {
+  // Name of the field
+  optional string name = 1;
+
+  // Order or position of the field in the struct or enum variant definition.
+  optional uint32 position = 2;
+
+  // The type of the field
+  optional OpenSignatureBody type = 3;
+}
+
+// Descriptor of an enum variant
+message VariantDescriptor {
+  // Name of the variant
+  optional string name = 1;
+
+  // Order or position of the variant in the enum definition.
+  optional uint32 position = 2;
+
+  // Set of fields defined by this variant.
+  repeated FieldDescriptor fields = 3;
+}
+
+// Representation of a type signature that could appear as a field type for a struct or enum
+message OpenSignatureBody {
+  enum Type {
+    TYPE_UNKNOWN = 0;
+    ADDRESS = 1;
+    BOOL = 2;
+    U8 = 3;
+    U16 = 4;
+    U32 = 5;
+    U64 = 6;
+    U128 = 7;
+    U256 = 8;
+    VECTOR = 9;
+    DATATYPE = 10;
+    TYPE_PARAMETER = 11;
+  }
+
+  // Type of this signature
+  optional Type type = 1;
+
+  // Fully qualified name of the datatype when `type` is `DATATYPE`
+  optional string type_name = 2;
+
+  // Set when `type` is `VECTOR` or `DATATYPE`
+  repeated OpenSignatureBody type_parameter_instantiation = 3;
+
+  // Position of the type parameter as defined in the containing data type descriptor when `type` is `TYPE_PARAMETER`
+  optional uint32 type_parameter = 4;
+}
+
+// Descriptor of a Move function
+message FunctionDescriptor {
+  // Name of the function
+  optional string name = 1;
+
+  enum Visibility {
+    VISIBILITY_UNKNOWN = 0;
+    PRIVATE = 1;
+    PUBLIC = 2;
+    FRIEND = 3;
+  }
+
+  // Whether the function is `public`, `private` or `public(friend)`
+  optional Visibility visibility = 5;
+
+  // Whether the function is marked `entry` or not.
+  optional bool is_entry = 6;
+
+  // Ability constraints for type parameters
+  repeated TypeParameter type_parameters = 7;
+
+  // Formal parameter types.
+  repeated OpenSignature parameters = 8;
+
+  // Return types.
+  repeated OpenSignature returns = 9;
+}
+
+// Representation of a type signature that could appear as a function parameter or return value.
+message OpenSignature {
+  enum Reference {
+    REFERENCE_UNKNOWN = 0;
+    IMMUTABLE = 1;
+    MUTABLE = 2;
+  }
+
+  optional Reference reference = 1;
+  optional OpenSignatureBody body = 2;
+}
+
+// Identifies a struct and the module it was defined in.
+message TypeOrigin {
+  optional string module_name = 1;
+  optional string datatype_name = 2;
+  optional string package_id = 3;
+}
+
+// Upgraded package info for the linkage table.
+message Linkage {
+  // Id of the original package.
+  optional string original_id = 1;
+  // Id of the upgraded package.
+  optional string upgraded_id = 2;
+  // Version of the upgraded package.
+  optional uint64 upgraded_version = 3;
+}

package/dist/grpc/protos/sui/rpc/v2beta2/move_package_service.proto

@@ -0,0 +1,91 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2beta2;
+
+import "sui/rpc/v2beta2/move_package.proto";
+
+service MovePackageService {
+  rpc GetPackage(GetPackageRequest) returns (GetPackageResponse);
+  rpc GetDatatype(GetDatatypeRequest) returns (GetDatatypeResponse);
+  rpc GetFunction(GetFunctionRequest) returns (GetFunctionResponse);
+  rpc ListPackageVersions(ListPackageVersionsRequest) returns (ListPackageVersionsResponse);
+}
+
+message GetPackageRequest {
+  // Required. The `storage_id` of the requested package.
+  optional string package_id = 1;
+}
+
+message GetPackageResponse {
+  // The package.
+  optional Package package = 1;
+}
+
+message GetDatatypeRequest {
+  // Required. The `storage_id` of the requested package.
+  optional string package_id = 1;
+
+  // Required. The name of the requested module.
+  optional string module_name = 2;
+
+  // Required. The name of the requested datatype.
+  optional string name = 3;
+}
+
+message GetDatatypeResponse {
+  // The datatype.
+  optional DatatypeDescriptor datatype = 1;
+}
+
+message GetFunctionRequest {
+  // Required. The `storage_id` of the requested package.
+  optional string package_id = 1;
+
+  // Required. The name of the requested module.
+  optional string module_name = 2;
+
+  // Required. The name of the requested function.
+  optional string name = 3;
+}
+
+message GetFunctionResponse {
+  // The function.
+  optional FunctionDescriptor function = 1;
+}
+
+message ListPackageVersionsRequest {
+  // Required. The `storage_id` of any version of the package.
+  optional string package_id = 1;
+
+  // The maximum number of versions to return. The service may return fewer than this value.
+  // If unspecified, at most `1000` entries will be returned.
+  // The maximum value is `10000`; values above `10000` will be coerced to `10000`.
+  optional uint32 page_size = 2;
+
+  // A page token, received from a previous `ListPackageVersions` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListPackageVersions` must
+  // match the call that provided the page token.
+  optional bytes page_token = 3;
+}
+
+message ListPackageVersionsResponse {
+  // List of all package versions, ordered by version.
+  repeated PackageVersion versions = 1;
+
+  // A token, which can be sent as `page_token` to retrieve the next page.
+  // If this field is omitted, there are no subsequent pages.
+  optional bytes next_page_token = 2;
+}
+
+// A simplified representation of a package version
+message PackageVersion {
+  // The storage ID of this package version
+  optional string package_id = 1;
+  // The version number
+  optional uint64 version = 2;
+}

package/dist/grpc/protos/sui/rpc/v2beta2/object.proto

@@ -0,0 +1,62 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2beta2;
+
+import "google/protobuf/struct.proto";
+import "sui/rpc/v2beta2/bcs.proto";
+import "sui/rpc/v2beta2/move_package.proto";
+import "sui/rpc/v2beta2/owner.proto";
+
+// An object on the Sui blockchain.
+message Object {
+  // This Object serialized as BCS.
+  optional Bcs bcs = 1;
+
+  // `ObjectId` for this object.
+  optional string object_id = 2;
+
+  // Version of the object.
+  optional uint64 version = 3;
+
+  // The digest of this Object.
+  optional string digest = 4;
+
+  // Owner of the object.
+  optional Owner owner = 5;
+
+  // The type of this object.
+  //
+  // This will be 'package' for packages and a StructTag for move structs.
+  optional string object_type = 6;
+
+  // DEPRECATED this field is no longer used to determine whether a tx can transfer this
+  // object. Instead, it is always calculated from the objects type when loaded in execution.
+  //
+  // Only set for Move structs
+  optional bool has_public_transfer = 7;
+
+  // BCS bytes of a Move struct value.
+  //
+  // Only set for Move structs
+  optional Bcs contents = 8;
+
+  // Package information for Move Packages
+  optional Package package = 9;
+
+  // The digest of the transaction that created or last mutated this object
+  optional string previous_transaction = 10;
+
+  // The amount of SUI to rebate if this object gets deleted.
+  // This number is re-calculated each time the object is mutated based on
+  // the present storage gas price.
+  optional uint64 storage_rebate = 11;
+
+  // JSON rendering of the object.
+  optional google.protobuf.Value json = 100;
+
+  // Current balance if this object is a `0x2::coin::Coin<T>`
+  optional uint64 balance = 101;
+}

package/dist/grpc/protos/sui/rpc/v2beta2/object_reference.proto

@@ -0,0 +1,16 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2beta2;
+
+// Reference to an object.
+message ObjectReference {
+  // The object id of this object.
+  optional string object_id = 1;
+  // The version of this object.
+  optional uint64 version = 2;
+  // The digest of this object.
+  optional string digest = 3;
+}