feat(proto): Proto API v2 [DEV-1786]

proto/buf.yaml

@@ -15,9 +15,12 @@ breaking:
     - FILE
 
 lint:
+  ignore:
+    - cheqd/did/v1
+    - cheqd/resource/v1
   use:
     - DEFAULT
-    - COMMENTS
   except:
     - SERVICE_SUFFIX
     - RPC_REQUEST_STANDARD_NAME
+    - RPC_RESPONSE_STANDARD_NAME

proto/cheqd/v1/did.proto → proto/cheqd/did/v1/did.proto

@@ -4,7 +4,7 @@ package cheqdid.cheqdnode.cheqd.v1;
 option go_package = "github.com/cheqd/cheqd-node/x/cheqd/types";
 
 import "google/protobuf/any.proto";
-import "cheqd/v1/common.proto";
+import "cheqd/did/v1/common.proto";
 
 message Did {
   repeated string context = 1; // optional

proto/cheqd/v1/genesis.proto → proto/cheqd/did/v1/genesis.proto

@@ -3,7 +3,7 @@ package cheqdid.cheqdnode.cheqd.v1;
 
 option go_package = "github.com/cheqd/cheqd-node/x/cheqd/types";
 
-import "cheqd/v1/stateValue.proto";
+import "cheqd/did/v1/stateValue.proto";
 
 // GenesisState defines the cheqd module's genesis state.
 message GenesisState {

proto/cheqd/v1/query.proto → proto/cheqd/did/v1/query.proto

@@ -4,8 +4,8 @@ package cheqdid.cheqdnode.cheqd.v1;
 option go_package = "github.com/cheqd/cheqd-node/x/cheqd/types";
 
 import "google/api/annotations.proto";
-import "cheqd/v1/did.proto";
-import "cheqd/v1/stateValue.proto";
+import "cheqd/did/v1/did.proto";
+import "cheqd/did/v1/stateValue.proto";
 
 
 // Query defines the gRPC querier service.

proto/cheqd/v1/tx.proto → proto/cheqd/did/v1/tx.proto

@@ -4,7 +4,7 @@ package cheqdid.cheqdnode.cheqd.v1;
 option go_package = "github.com/cheqd/cheqd-node/x/cheqd/types";
 
 import "google/protobuf/any.proto";
-import "cheqd/v1/did.proto";
+import "cheqd/did/v1/did.proto";
 
 // Msg defines the Msg service.
 service Msg {

proto/cheqd/did/v2/diddoc.proto

@@ -0,0 +1,44 @@
+syntax = "proto3";
+
+package cheqd.did.v2;
+
+option go_package = "github.com/cheqd/cheqd-node/x/cheqd/types/v2";
+
+message DidDoc {
+  repeated string context = 1;
+  string id = 2;
+  repeated string controller = 3;
+  repeated VerificationMethod verification_method = 4;
+  repeated string authentication = 5;
+  repeated string assertion_method = 6;
+  repeated string capability_invocation = 7;
+  repeated string capability_delegation = 8;
+  repeated string key_agreement = 9;
+  repeated Service service = 10;
+  repeated string also_known_as = 11;
+}
+
+message VerificationMethod {
+  string id = 1;
+  string type = 2;
+  string controller = 3;
+  string verification_material = 4;
+}
+
+message Service {
+  string id = 1;
+  string type = 2;
+  repeated string service_endpoint = 3;
+}
+
+message DidDocWithMetadata {
+  DidDoc did_doc = 1;
+  Metadata metadata = 2;
+}
+
+message Metadata {
+  string created = 1;
+  string updated = 2;
+  bool deactivated = 3;
+  string version_id = 4;
+}

proto/cheqd/did/v2/fee.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+package cheqd.did.v2;
+
+option go_package = "github.com/cheqd/cheqd-node/x/cheqd/types/v2";
+option (gogoproto.equal_all) = true;
+
+import "gogoproto/gogo.proto";
+import "cosmos/base/v1beta1/coin.proto";
+import "cosmos_proto/cosmos.proto";
+
+// FeeParams defines the parameters for the `cheqd` module fixed fee.
+message FeeParams {
+    // Tx types define the fixed fee each for the `cheqd` module.
+    cosmos.base.v1beta1.Coin create_did = 1 [(gogoproto.nullable) = false];
+    cosmos.base.v1beta1.Coin update_did = 2 [(gogoproto.nullable) = false];
+    cosmos.base.v1beta1.Coin deactivate_did = 3 [(gogoproto.nullable) = false];
+    string burn_factor = 4 [
+        (cosmos_proto.scalar) = "cosmos.Dec",
+        (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+        (gogoproto.nullable) = false
+    ];
+}

proto/cheqd/did/v2/genesis.proto

@@ -0,0 +1,14 @@
+syntax = "proto3";
+
+package cheqd.did.v2;
+
+import "cheqd/did/v2/diddoc.proto";
+import "cheqd/did/v2/fee.proto";
+
+option go_package = "github.com/cheqd/cheqd-node/x/cheqd/types/v2";
+
+message GenesisState {
+  string did_namespace = 1;
+  repeated DidDocWithMetadata did_docs = 2;
+  FeeParams fee_params = 3;
+}

proto/cheqd/did/v2/query.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+package cheqd.did.v2;
+
+import "google/api/annotations.proto";
+import "cheqd/did/v2/diddoc.proto";
+
+option go_package = "github.com/cheqd/cheqd-node/x/cheqd/types/v2";
+
+service Query {
+	rpc DidDoc(QueryGetDidDocRequest) returns (QueryGetDidDocResponse) {
+		option (google.api.http).get = "/cheqd/did/v2/diddoc/{id}";
+	}
+}
+
+message QueryGetDidDocRequest {
+	string id = 1;
+}
+
+message QueryGetDidDocResponse {
+	DidDocWithMetadata value = 1;
+}

proto/cheqd/did/v2/tx.proto

@@ -0,0 +1,64 @@
+syntax = "proto3";
+
+package cheqd.did.v2;
+
+import "cheqd/did/v2/diddoc.proto";
+
+option go_package = "github.com/cheqd/cheqd-node/x/cheqd/types/v2";
+
+service Msg {
+  rpc CreateDidDoc(MsgCreateDidDoc) returns (MsgCreateDidDocResponse);
+  rpc UpdateDidDoc(MsgUpdateDidDoc) returns (MsgUpdateDidDocResponse);
+}
+
+message MsgCreateDidDoc {
+  MsgCreateDidDocPayload payload = 1;
+  repeated SignInfo signatures = 2;
+}
+
+message MsgUpdateDidDoc {
+  MsgUpdateDidDocPayload payload = 1;
+  repeated SignInfo signatures = 2;
+}
+
+message SignInfo {
+  string verification_method_id = 1;
+  bytes signature = 2;
+}
+
+message MsgCreateDidDocPayload {
+  repeated string context = 1;
+  string id = 2;
+  repeated string controller = 3;
+  repeated VerificationMethod verification_method = 4;
+  repeated string authentication = 5;
+  repeated string assertion_method = 6;
+  repeated string capability_invocation = 7;
+  repeated string capability_delegation = 8;
+  repeated string key_agreement = 9;
+  repeated string also_known_as = 10;
+  repeated Service service = 11;
+}
+
+message MsgCreateDidDocResponse {
+  DidDocWithMetadata value = 1;
+}
+
+message MsgUpdateDidDocPayload {
+  repeated string context = 1;
+  string id = 2;
+  repeated string controller = 3;
+  repeated VerificationMethod verification_method = 4;
+  repeated string authentication = 5;
+  repeated string assertion_method = 6;
+  repeated string capability_invocation = 7;
+  repeated string capability_delegation = 8;
+  repeated string key_agreement = 9;
+  repeated string also_known_as = 10;
+  repeated Service service = 11;
+  string version_id = 12;
+}
+
+message MsgUpdateDidDocResponse {
+  DidDocWithMetadata value = 1;
+}

proto/resource/v1/genesis.proto → proto/cheqd/resource/v1/genesis.proto

@@ -3,7 +3,7 @@ package cheqdid.cheqdnode.resource.v1;
 
 option go_package = "github.com/cheqd/cheqd-node/x/resource/types";
 
-import "resource/v1/resource.proto";
+import "cheqd/resource/v1/resource.proto";
 
 // GenesisState defines the cheqd module's genesis state.
 message GenesisState {

proto/resource/v1/query.proto → proto/cheqd/resource/v1/query.proto

@@ -4,7 +4,7 @@ package cheqdid.cheqdnode.resource.v1;
 option go_package = "github.com/cheqd/cheqd-node/x/resource/types";
 
 import "google/api/annotations.proto";
-import "resource/v1/resource.proto";
+import "cheqd/resource/v1/resource.proto";
 
 
 // Query defines the gRPC querier service.

proto/resource/v1/tx.proto → proto/cheqd/resource/v1/tx.proto

@@ -3,8 +3,8 @@ package cheqdid.cheqdnode.resource.v1;
 
 option go_package = "github.com/cheqd/cheqd-node/x/resource/types";
 
-import "cheqd/v1/tx.proto";
-import "resource/v1/resource.proto";
+import "cheqd/did/v1/tx.proto";
+import "cheqd/resource/v1/resource.proto";
 
 // Msg defines the Msg service.
 service Msg {

proto/cheqd/resource/v2/fee.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+package cheqd.resource.v2;
+
+option go_package = "github.com/cheqd/cheqd-node/x/resource/types/v2";
+option (gogoproto.equal_all) = true;
+
+import "gogoproto/gogo.proto";
+import "cosmos/base/v1beta1/coin.proto";
+import "cosmos_proto/cosmos.proto";
+
+// FeeParams defines the parameters for the `resource` module fixed fee.
+message FeeParams {
+    // Media types define the fixed fee each for the `resource` module.
+    cosmos.base.v1beta1.Coin image = 1 [(gogoproto.nullable) = false];
+    cosmos.base.v1beta1.Coin json = 2 [(gogoproto.nullable) = false];
+    cosmos.base.v1beta1.Coin default = 3 [(gogoproto.nullable) = false];
+    string burn_factor = 4 [
+        (cosmos_proto.scalar) = "cosmos.Dec",
+        (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+        (gogoproto.nullable) = false
+    ];
+}

proto/cheqd/resource/v2/genesis.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+
+package cheqd.resource.v2;
+
+import "cheqd/resource/v2/resource.proto";
+import "cheqd/resource/v2/fee.proto";
+
+option go_package = "github.com/cheqd/cheqd-node/x/resource/types/v2";
+
+message GenesisState {
+  repeated ResourceWithMetadata resources = 1;
+  FeeParams fee_params = 2;
+}

proto/cheqd/resource/v2/query.proto

@@ -0,0 +1,58 @@
+syntax = "proto3";
+
+package cheqd.resource.v2;
+
+import "google/api/annotations.proto";
+import "cheqd/resource/v2/resource.proto";
+
+option go_package = "github.com/cheqd/cheqd-node/x/resource/types/v2";
+
+service Query {
+  rpc Resource(QueryGetResourceRequest) returns (QueryGetResourceResponse) {
+    option (google.api.http).get = "/cheqd/resource/v2/collection/{collection_id}/resources/{id}";
+  }
+  rpc ResourceMetadata(QueryGetResourceMetadataRequest) returns (QueryGetResourceMetadataResponse) {
+    option (google.api.http).get = "/cheqd/resource/v2/collection/{collection_id}/resources/{id}/metadata";
+  }
+  rpc CollectionResources(QueryGetCollectionResourcesRequest) returns (QueryGetCollectionResourcesResponse) {
+    option (google.api.http).get = "/cheqd/resource/v2/collection/{collection_id}/resources";
+  }
+  rpc AllResourceVersions(QueryGetAllResourceVersionsRequest) returns (QueryGetAllResourceVersionsResponse) {
+    option (google.api.http).get = "/cheqd/resource/v2/collection/{collection_id}/resources/versions/{name}";
+  }
+}
+
+message QueryGetResourceRequest {
+  string collection_id = 1;
+  string id = 2;
+}
+
+message QueryGetResourceResponse {
+  ResourceWithMetadata resource = 1;
+}
+
+message QueryGetResourceMetadataRequest {
+  string collection_id = 1;
+  string id = 2;
+}
+
+message QueryGetResourceMetadataResponse {
+  Metadata resource = 1;
+}
+
+message QueryGetCollectionResourcesRequest {
+  string collection_id = 1;
+}
+
+message QueryGetCollectionResourcesResponse {
+  repeated Metadata resources = 1;
+}
+
+message QueryGetAllResourceVersionsRequest {
+  string collection_id = 1;
+  string name = 2;
+}
+
+message QueryGetAllResourceVersionsResponse {
+  repeated Metadata resources = 1;
+}

proto/cheqd/resource/v2/resource.proto

@@ -0,0 +1,29 @@
+syntax = "proto3";
+
+package cheqd.resource.v2;
+
+option go_package = "github.com/cheqd/cheqd-node/x/resource/types/v2";
+
+message Resource {
+  bytes data = 1;
+}
+
+message ResourceWithMetadata {
+  Resource resource = 1;
+  Metadata metadata = 2;
+}
+
+message Metadata {
+  string collection_id = 1;
+  string id = 2;
+  string name = 3;
+  string version = 4;
+  string resource_type = 5;
+  repeated string also_known_as = 6;
+
+  string media_type = 7;
+  string created = 8;
+  bytes checksum = 9;
+  string previous_version_id = 10;
+  string next_version_id = 11;
+}