@clonegod/ttd-sui-common 1.0.93 → 1.0.94

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

@@ -0,0 +1,238 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2;
+
+import "sui/rpc/v2/bcs.proto";
+import "sui/rpc/v2/jwk.proto";
+import "sui/rpc/v2/signature_scheme.proto";
+
+// A signature from a user.
+message UserSignature {
+  // This signature serialized as as BCS.
+  //
+  // When provided as input this will support both the form that is length
+  // prefixed as well as not length prefixed.
+  optional Bcs bcs = 1;
+
+  // The signature scheme of this signature.
+  optional SignatureScheme scheme = 2;
+
+  oneof signature {
+    // Simple signature if scheme is ed25519 | secp256k1 | secp256r1.
+    SimpleSignature simple = 3;
+
+    // The multisig aggregated signature if scheme is `MULTISIG`.
+    MultisigAggregatedSignature multisig = 4;
+
+    // The zklogin authenticator if scheme is `ZKLOGIN`.
+    ZkLoginAuthenticator zklogin = 5;
+
+    // The passkey authenticator if scheme is `PASSKEY`.
+    PasskeyAuthenticator passkey = 6;
+  }
+}
+
+// Either an ed25519, secp256k1 or secp256r1 signature
+message SimpleSignature {
+  // The signature scheme of this signature.
+  optional SignatureScheme scheme = 1;
+
+  // Signature bytes
+  optional bytes signature = 2;
+
+  // Public key bytes
+  optional bytes public_key = 3;
+}
+
+// Public key equivalent for zklogin authenticators.
+message ZkLoginPublicIdentifier {
+  optional string iss = 1;
+  // base10 encoded Bn254FieldElement
+  optional string address_seed = 2;
+}
+
+// Set of valid public keys for multisig committee members.
+message MultisigMemberPublicKey {
+  // The signature scheme of this public key.
+  optional SignatureScheme scheme = 1;
+
+  // Public key bytes if scheme is ed25519 | secp256k1 | secp256r1 | passkey.
+  optional bytes public_key = 2;
+
+  // A zklogin public identifier if scheme is zklogin.
+  optional ZkLoginPublicIdentifier zklogin = 3;
+}
+
+// A member in a multisig committee.
+message MultisigMember {
+  // The public key of the committee member.
+  optional MultisigMemberPublicKey public_key = 1;
+  // The weight of this member's signature.
+  optional uint32 weight = 2;
+}
+
+// A multisig committee.
+message MultisigCommittee {
+  // A list of committee members and their corresponding weight.
+  repeated MultisigMember members = 1;
+  // The threshold of signatures needed to validate a signature from
+  // this committee.
+  optional uint32 threshold = 2;
+}
+
+// Aggregated signature from members of a multisig committee.
+message MultisigAggregatedSignature {
+  // The plain signatures encoded with signature scheme.
+  //
+  // The signatures must be in the same order as they are listed in the committee.
+  repeated MultisigMemberSignature signatures = 1;
+
+  // Bitmap indicating which committee members contributed to the
+  // signature.
+  optional uint32 bitmap = 2;
+  // If present, means this signature's on-chain format uses the old
+  // legacy multisig format.
+  optional bytes legacy_bitmap = 3;
+  // The committee to use to validate this signature.
+  optional MultisigCommittee committee = 4;
+}
+
+// A signature from a member of a multisig committee.
+message MultisigMemberSignature {
+  // The signature scheme of this signature.
+  optional SignatureScheme scheme = 1;
+
+  // Signature bytes if scheme is ed25519 | secp256k1 | secp256r1.
+  optional bytes signature = 2;
+
+  // The zklogin authenticator if scheme is `ZKLOGIN`.
+  optional ZkLoginAuthenticator zklogin = 3;
+
+  // The passkey authenticator if scheme is `PASSKEY`.
+  optional PasskeyAuthenticator passkey = 4;
+}
+
+// A zklogin authenticator.
+message ZkLoginAuthenticator {
+  // Zklogin proof and inputs required to perform proof verification.
+  optional ZkLoginInputs inputs = 1;
+  // Maximum epoch for which the proof is valid.
+  optional uint64 max_epoch = 2;
+  // User signature with the public key attested to by the provided proof.
+  optional SimpleSignature signature = 3;
+
+  // The public identifier (similar to a public key) for this zklogin authenticator
+  optional ZkLoginPublicIdentifier public_identifier = 4;
+  // The id of the JWK used to authorize this zklogin authenticator
+  optional JwkId jwk_id = 5;
+}
+
+// A zklogin groth16 proof and the required inputs to perform proof verification.
+message ZkLoginInputs {
+  optional ZkLoginProof proof_points = 1;
+  optional ZkLoginClaim iss_base64_details = 2;
+  optional string header_base64 = 3;
+  // base10 encoded Bn254FieldElement
+  optional string address_seed = 4;
+}
+
+// A zklogin groth16 proof.
+message ZkLoginProof {
+  optional CircomG1 a = 1;
+  optional CircomG2 b = 2;
+  optional CircomG1 c = 3;
+}
+
+// A claim of the iss in a zklogin proof.
+message ZkLoginClaim {
+  optional string value = 1;
+  optional uint32 index_mod_4 = 2;
+}
+
+// A G1 point.
+message CircomG1 {
+  // base10 encoded Bn254FieldElement
+  optional string e0 = 1;
+  // base10 encoded Bn254FieldElement
+  optional string e1 = 2;
+  // base10 encoded Bn254FieldElement
+  optional string e2 = 3;
+}
+
+// A G2 point.
+message CircomG2 {
+  // base10 encoded Bn254FieldElement
+  optional string e00 = 1;
+  // base10 encoded Bn254FieldElement
+  optional string e01 = 2;
+
+  // base10 encoded Bn254FieldElement
+  optional string e10 = 3;
+  // base10 encoded Bn254FieldElement
+  optional string e11 = 4;
+
+  // base10 encoded Bn254FieldElement
+  optional string e20 = 5;
+  // base10 encoded Bn254FieldElement
+  optional string e21 = 6;
+}
+
+// A passkey authenticator.
+//
+// See
+// [struct.PasskeyAuthenticator](https://mystenlabs.github.io/sui-rust-sdk/sui_sdk_types/struct.PasskeyAuthenticator.html#bcs)
+// for more information on the requirements on the shape of the
+// `client_data_json` field.
+message PasskeyAuthenticator {
+  // Opaque authenticator data for this passkey signature.
+  //
+  // See [Authenticator Data](https://www.w3.org/TR/webauthn-2/#sctn-authenticator-data) for
+  // more information on this field.
+  optional bytes authenticator_data = 1;
+
+  // Structured, unparsed, JSON for this passkey signature.
+  //
+  // See [CollectedClientData](https://www.w3.org/TR/webauthn-2/#dictdef-collectedclientdata)
+  // for more information on this field.
+  optional string client_data_json = 2;
+
+  // A secp256r1 signature.
+  optional SimpleSignature signature = 3;
+}
+
+// The validator set for a particular epoch.
+message ValidatorCommittee {
+  // The epoch where this committee governs.
+  optional uint64 epoch = 1;
+
+  // The committee members.
+  repeated ValidatorCommitteeMember members = 2;
+}
+
+// A member of a validator committee.
+message ValidatorCommitteeMember {
+  // The 96-byte Bls12381 public key for this validator.
+  optional bytes public_key = 1;
+
+  // voting weight this validator possesses.
+  optional uint64 weight = 2;
+}
+
+/// An aggregated signature from multiple validators.
+message ValidatorAggregatedSignature {
+  // The epoch when this signature was produced.
+  //
+  // This can be used to lookup the `ValidatorCommittee` from this epoch
+  // to verify this signature.
+  optional uint64 epoch = 1;
+
+  // The 48-byte Bls12381 aggregated signature.
+  optional bytes signature = 2;
+
+  // Bitmap indicating which members of the committee contributed to
+  // this signature.
+  optional bytes bitmap = 3;
+}

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

@@ -0,0 +1,22 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2;
+
+// Flag use to disambiguate the signature schemes supported by Sui.
+//
+// Note: the enum values defined by this proto message exactly match their
+// expected BCS serialized values when serialized as a u8. See
+// [enum.SignatureScheme](https://mystenlabs.github.io/sui-rust-sdk/sui_sdk_types/enum.SignatureScheme.html)
+// for more information about signature schemes.
+enum SignatureScheme {
+  ED25519 = 0;
+  SECP256K1 = 1;
+  SECP256R1 = 2;
+  MULTISIG = 3;
+  BLS12381 = 4;
+  ZKLOGIN = 5;
+  PASSKEY = 6;
+}

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

@@ -0,0 +1,49 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2;
+
+import "sui/rpc/v2/bcs.proto";
+import "sui/rpc/v2/signature.proto";
+import "sui/rpc/v2/transaction.proto";
+
+service SignatureVerificationService {
+  // Perform signature verification of a UserSignature against the provided message.
+  rpc VerifySignature(VerifySignatureRequest) returns (VerifySignatureResponse);
+}
+
+message VerifySignatureRequest {
+  // The message to verify against.
+  //
+  // Today the only supported message types are `PersonalMessage` and
+  // `TransactionData` and the `Bcs.name` must be set to indicate which type of
+  // message is being verified.
+  optional Bcs message = 1;
+
+  // The signature to verify.
+  optional UserSignature signature = 2;
+
+  // Optional. Address to validate against the provided signature.
+  //
+  // If provided, this address will be compared against the the address derived
+  // from the provide signature and a successful response will only be returned
+  // if they match.
+  optional string address = 3;
+
+  // The set of JWKs to use when verifying Zklogin signatures.
+  // If this is empty the current set of valid JWKs stored onchain will be used
+  repeated ActiveJwk jwks = 4;
+
+  // The epoch to use
+  // optional uint64 epoch = 5;
+}
+
+message VerifySignatureResponse {
+  // Indicates if the provided signature was valid given the requested parameters.
+  optional bool is_valid = 1;
+
+  // If `is_valid` is `false`, this is the reason for why the signature verification failed.
+  optional string reason = 2;
+}

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

@@ -0,0 +1,300 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2;
+
+import "google/protobuf/field_mask.proto";
+import "sui/rpc/v2/bcs.proto";
+import "sui/rpc/v2/object.proto";
+
+service StateService {
+  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);
+}
+
+// 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 either from its Currency object
+  // in the CoinRegistry, or from its `0x2::coin::RegulatedCoinMetadata`
+  // object for coins that have not been migrated to the CoinRegistry
+  //
+  // If this coin is not known to be regulated, only the
+  // coin_regulated_state field will be populated.
+  optional RegulatedCoinMetadata regulated_metadata = 4;
+}
+
+// Metadata for a coin type
+message CoinMetadata {
+  // Information about the state of the coin's MetadataCap
+  enum MetadataCapState {
+    // Indicates the state of the MetadataCap is unknown.
+    // Set when the coin has not been migrated to the CoinRegistry.
+    METADATA_CAP_STATE_UNKNOWN = 0;
+    // Indicates the MetadataCap has been claimed.
+    CLAIMED = 1;
+    // Indicates the MetadataCap has not been claimed.
+    UNCLAIMED = 2;
+    // Indicates the MetadataCap has been deleted.
+    DELETED = 3;
+  }
+
+  // ObjectId of the `0x2::coin::CoinMetadata` object or
+  // 0x2::sui::coin_registry::Currency 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;
+  // State of the MetadataCap for this coin type.
+  optional MetadataCapState metadata_cap_state = 8;
+}
+
+// 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;
+    // Supply can only decrease (burning allowed, minting not allowed)
+    BURN_ONLY = 2;
+  }
+  // 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 {
+  // Indicates the state of the regulation of the coin.
+  enum CoinRegulatedState {
+    // Indicates the regulation state of the coin is unknown.
+    // This is set when a coin has not been migrated to the
+    // coin registry and has no `0x2::coin::RegulatedCoinMetadata`
+    // object.
+    COIN_REGULATED_STATE_UNKNOWN = 0;
+    // Indicates a coin is regulated. RegulatedCoinMetadata will be populated.
+    REGULATED = 1;
+    // Indicates a coin is unregulated.
+    UNREGULATED = 2;
+  }
+
+  // ObjectId of the `0x2::coin::RegulatedCoinMetadata` object.
+  // Only present for coins that have not been migrated to CoinRegistry.
+  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;
+  // Whether the coin can be globally paused
+  optional bool allow_global_pause = 4;
+  // Variant of the regulated coin metadata
+  optional uint32 variant = 5;
+  // Indicates the coin's regulated state.
+  optional CoinRegulatedState coin_regulated_state = 6;
+}
+
+// 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;
+
+  // Mask specifying which fields to read.
+  // If no mask is specified, defaults to `parent,field_id`.
+  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 field object itself
+  optional Object field_object = 4;
+
+  // The dynamic field's "name"
+  optional Bcs name = 5;
+
+  // The dynamic field's "value"
+  optional Bcs value = 6;
+
+  // 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 = 7;
+
+  // 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 child_id = 8;
+
+  // The object itself when a child is a dynamic object field.
+  optional Object child_object = 9;
+}
+
+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;
+
+  // Mask specifying which fields to read.
+  // If no mask is specified, defaults to `object_id,version,object_type`.
+  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 restrict 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/v2/subscription_service.proto

@@ -0,0 +1,41 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+syntax = "proto3";
+
+package sui.rpc.v2;
+
+import "google/protobuf/field_mask.proto";
+import "sui/rpc/v2/checkpoint.proto";
+
+service SubscriptionService {
+  // Subscribe to the stream of checkpoints.
+  //
+  // This API provides a subscription to the checkpoint stream for the Sui
+  // blockchain. When a subscription is initialized the stream will begin with
+  // the latest executed checkpoint as seen by the server. Responses are
+  // guaranteed to return checkpoints in-order and without gaps. This enables
+  // clients to know exactly the last checkpoint they have processed and in the
+  // event the subscription terminates (either by the client/server or by the
+  // connection breaking), clients will be able to reinitialize a subscription
+  // and then leverage other APIs in order to request data for the checkpoints
+  // they missed.
+  rpc SubscribeCheckpoints(SubscribeCheckpointsRequest) returns (stream SubscribeCheckpointsResponse);
+}
+
+// Request message for SubscriptionService.SubscribeCheckpoints
+message SubscribeCheckpointsRequest {
+  // Optional. Mask for specifying which parts of the
+  // SubscribeCheckpointsResponse should be returned.
+  optional google.protobuf.FieldMask read_mask = 1;
+}
+
+// Response message for SubscriptionService.SubscribeCheckpoints
+message SubscribeCheckpointsResponse {
+  // Required. The checkpoint sequence number and value of the current cursor
+  // into the checkpoint stream
+  optional uint64 cursor = 1;
+
+  // The requested data for this checkpoint
+  optional Checkpoint checkpoint = 2;
+}