chore: deprecate legacy features on x/token,collection (Finschia#1201)

* Deprecate all the x/token features * Deprecate x/collection fungible token features * Deprecate x/collection attach features * Update CHANGELOG.md * Lint * Apply feedbacks on the PR
0Tech · Jan 5, 2024 · 3babbe5 · 3babbe5
1 parent a1bab87
commit 3babbe5
Show file tree

Hide file tree

Showing 31 changed files with 1,191 additions and 681 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -57,7 +57,12 @@ issues:
     - text: "SA1019: codec.LegacyAmino is deprecated"
       linters:
         - staticcheck
-    - text: "SA1019: collection."
+    - path: x/collection
+      text: "SA1019: collection."
+      linters:
+        - staticcheck
+    - path: x/token
+      text: "SA1019: token."
       linters:
         - staticcheck
     - path: "legacy"

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -71,3 +71,4 @@ Ref: https://keepachangelog.com/en/1.0.0/
 ### Document Updates
 * (docs) [\#1059](https://github.com/Finschia/finschia-sdk/pull/1059) create ERRORS.md for x/module
 * (docs) [\#1083](https://github.com/Finschia/finschia-sdk/pull/1083) Add detailed explanation about default events
+* (x/token,collection) [#1201](https://github.com/Finschia/finschia-sdk/pull/1201) Deprecate legacy features on x/token,collection
diff --git a/Makefile b/Makefile
@@ -340,7 +340,7 @@ lint: golangci-lint
 	find . -name '*.go' -type f -not -path "*.git*" | xargs gofmt -d -s
 
 golangci-lint:
-	@go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.51.2
+	@go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.55.2
 
 lint-fix: golangci-lint
 	golangci-lint run --fix --out-format=tab --issues-exit-code=0

diff --git a/baseapp/testutil/messages.pb.go b/baseapp/testutil/messages.pb.go
diff --git a/docs/core/proto-docs.md b/docs/core/proto-docs.md
@@ -9063,8 +9063,6 @@ Contract defines the information of the contract for the collection.
 <a name="lbm.collection.v1.FT"></a>
 
 ### FT
-Deprecated: use FTClass
-
 FT defines the information of fungible token.
 
 
@@ -9188,8 +9186,8 @@ Params defines the parameters for the collection module.
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| `depth_limit` | [uint32](#uint32) |  |  |
-| `width_limit` | [uint32](#uint32) |  |  |
+| `depth_limit` | [uint32](#uint32) |  | **Deprecated.**  |
+| `width_limit` | [uint32](#uint32) |  | **Deprecated.**  |
 
 
 
@@ -9841,7 +9839,7 @@ GenesisState defines the collection module's genesis state.
 | `next_token_ids` | [ContractNextTokenIDs](#lbm.collection.v1.ContractNextTokenIDs) | repeated | next ids for (non-fungible) tokens. |
 | `balances` | [ContractBalances](#lbm.collection.v1.ContractBalances) | repeated | balances is an array containing the balances of all the accounts. |
 | `nfts` | [ContractNFTs](#lbm.collection.v1.ContractNFTs) | repeated | nfts is an array containing the nfts. |
-| `parents` | [ContractTokenRelations](#lbm.collection.v1.ContractTokenRelations) | repeated | parents represents the parents of (non-fungible) tokens. |
+| `parents` | [ContractTokenRelations](#lbm.collection.v1.ContractTokenRelations) | repeated | **Deprecated.** parents represents the parents of (non-fungible) tokens. |
 | `grants` | [ContractGrants](#lbm.collection.v1.ContractGrants) | repeated | grants defines the grant information. |
 | `authorizations` | [ContractAuthorizations](#lbm.collection.v1.ContractAuthorizations) | repeated | authorizations defines the approve information. |
 | `supplies` | [ContractStatistics](#lbm.collection.v1.ContractStatistics) | repeated | supplies represents the total supplies of tokens. |
@@ -9861,7 +9859,7 @@ NextClassIDs defines the next class ids of the contract.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `contract_id` | [string](#string) |  | contract id associated with the contract. |
-| `fungible` | [string](#string) |  | id for the fungible tokens. |
+| `fungible` | [string](#string) |  | **Deprecated.** id for the fungible tokens. |
 | `non_fungible` | [string](#string) |  | id for the non-fungible tokens. |
 
 

diff --git a/proto/lbm/collection/v1/collection.proto b/proto/lbm/collection/v1/collection.proto
@@ -10,8 +10,8 @@ import "cosmos_proto/cosmos.proto";
 
 // Params defines the parameters for the collection module.
 message Params {
-  uint32 depth_limit = 1;
-  uint32 width_limit = 2;
+  uint32 depth_limit = 1 [deprecated = true];
+  uint32 width_limit = 2 [deprecated = true];
 }
 
 // Contract defines the information of the contract for the collection.
@@ -30,6 +30,7 @@ message Contract {
 //
 // Since: 0.46.0 (finschia)
 message FTClass {
+  option deprecated                          = true;
   option (gogoproto.goproto_getters)         = true;
   option (cosmos_proto.implements_interface) = "TokenClass";
 
@@ -94,10 +95,9 @@ message OwnerNFT {
   string owner = 5;
 }
 
-// Deprecated: use FTClass
-//
 // FT defines the information of fungible token.
 message FT {
+  option deprecated                          = true;
   option (cosmos_proto.implements_interface) = "Token";
 
   // contract id associated with the contract.
@@ -140,7 +140,8 @@ message Coin {
   // token id associated with the token.
   string token_id = 1;
   // amount of the token.
-  string amount = 2 [(gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Int", (gogoproto.nullable) = false];
+  string amount = 2
+      [(gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Int", (gogoproto.nullable) = false];
 }
 
 // Grant defines permission given to a grantee.

diff --git a/proto/lbm/collection/v1/event.proto b/proto/lbm/collection/v1/event.proto
@@ -82,6 +82,8 @@ message EventCreatedContract {
 //
 // Since: 0.46.0 (finschia)
 message EventCreatedFTClass {
+  option deprecated = true;
+
   // contract id associated with the contract.
   string contract_id = 1;
   // address which triggered the create.
@@ -147,6 +149,8 @@ message EventRenounced {
 //
 // Since: 0.46.0 (finschia)
 message EventMintedFT {
+  option deprecated = true;
+
   // contract id associated with the contract.
   string contract_id = 1;
   // address which triggered the mint.
@@ -236,6 +240,8 @@ message EventModifiedNFT {
 //
 // Since: 0.46.0 (finschia)
 message EventAttached {
+  option deprecated = true;
+
   // contract id associated with the contract.
   string contract_id = 1;
   // address which triggered the attach.
@@ -252,6 +258,8 @@ message EventAttached {
 //
 // Since: 0.46.0 (finschia)
 message EventDetached {
+  option deprecated = true;
+
   // contract id associated with the contract.
   string contract_id = 1;
   // address which triggered the detach.
@@ -268,6 +276,8 @@ message EventDetached {
 //
 // Since: 0.46.0 (finschia)
 message EventOwnerChanged {
+  option deprecated = true;
+
   // contract id associated with the contract.
   string contract_id = 1;
   // token id associated with the token.
@@ -282,6 +292,8 @@ message EventOwnerChanged {
 //
 // Since: 0.46.0 (finschia)
 message EventRootChanged {
+  option deprecated = true;
+
   // contract id associated with the contract.
   string contract_id = 1;
   // token id associated with the token.

diff --git a/proto/lbm/collection/v1/genesis.proto b/proto/lbm/collection/v1/genesis.proto
@@ -33,7 +33,7 @@ message GenesisState {
   repeated ContractNFTs nfts = 7 [(gogoproto.nullable) = false];
 
   // parents represents the parents of (non-fungible) tokens.
-  repeated ContractTokenRelations parents = 8 [(gogoproto.nullable) = false];
+  repeated ContractTokenRelations parents = 8 [deprecated = true, (gogoproto.nullable) = false];
 
   // grants defines the grant information.
   repeated ContractGrants grants = 9 [(gogoproto.nullable) = false];
@@ -70,7 +70,8 @@ message ClassStatistics {
   // class id associated with the token class.
   string class_id = 1;
   // statistics
-  string amount = 2 [(gogoproto.nullable) = false, (gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Int"];
+  string amount = 2
+      [(gogoproto.nullable) = false, (gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Int"];
 }
 
 // Balance defines a balance of an address.
@@ -119,9 +120,14 @@ message NextClassIDs {
   // contract id associated with the contract.
   string contract_id = 1;
   // id for the fungible tokens.
-  string fungible = 2 [(gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Uint", (gogoproto.nullable) = false];
+  string fungible = 2 [
+    deprecated             = true,
+    (gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Uint",
+    (gogoproto.nullable)   = false
+  ];
   // id for the non-fungible tokens.
-  string non_fungible = 3 [(gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Uint", (gogoproto.nullable) = false];
+  string non_fungible = 3
+      [(gogoproto.customtype) = "github.com/Finschia/finschia-sdk/types.Uint", (gogoproto.nullable) = false];
 }
 
 // ContractNextTokenIDs defines the next token ids belong to a contract.
@@ -140,6 +146,8 @@ message NextTokenID {
 
 // ContractTokenRelations defines token relations belong to a contract.
 message ContractTokenRelations {
+  option deprecated = true;
+
   // contract id associated with the contract.
   string contract_id = 1;
   // relations
@@ -148,8 +156,10 @@ message ContractTokenRelations {
 
 // TokenRelation defines relations between two tokens.
 message TokenRelation {
+  option deprecated = true;
+
   // self
   string self = 1;
   // other
   string other = 2;
-}
+}