add deprecation notice

0xbcdev · 0xbcdev · commit d5fa3f84d258 · 2025-01-28T01:03:22.000+07:00
diff --git a/cmd/convert/abi_string.go b/cmd/convert/abi_string.go
@@ -3,6 +3,7 @@ package convert
 import (
 	"encoding/hex"
 	"fmt"
+	"github.com/bcdevtools/devd/v2/constants"
 	"regexp"
 	"strings"
 
@@ -12,11 +13,14 @@ import (
 
 func GetConvertAbiStringCmd() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "abi_string [hex or text]",
-		Short: `Convert ABI encoded hex to string or vice versa.`,
+		Use:     "abi_string [hex or text]",
+		Aliases: []string{"abi-string"},
+		Short:   `Convert ABI encoded hex to string or vice versa.`,
 		Long: `Convert ABI encoded hex to string or vice versa.
 Support pipe.`,
 		Run: func(cmd *cobra.Command, args []string) {
+			utils.PrintfStdErr("WARN: from v3, this command will be renamed to `%s convert abi-string` (`-` instead of '_')\n", constants.BINARY_NAME)
+
 			args, err := utils.ProvidedArgsOrFromPipe(args)
 			utils.ExitOnErr(err, "failed to get args from pipe")
 			utils.RequireArgs(args, cmd)
diff --git a/cmd/convert/decimal_to_hexadecimal.go b/cmd/convert/decimal_to_hexadecimal.go
@@ -2,6 +2,7 @@ package convert
 
 import (
 	"fmt"
+	"github.com/bcdevtools/devd/v2/constants"
 	"math/big"
 	"os"
 	"strings"
@@ -18,6 +19,8 @@ func GetConvertDecimalToHexadecimalCmd() *cobra.Command {
 		Long: `Convert decimal to hexadecimal.
 Support pipe.`,
 		Run: func(cmd *cobra.Command, args []string) {
+			utils.PrintfStdErr("WARN: from v3, this command will be renamed to `%s convert hex [dec]`\n", constants.BINARY_NAME)
+
 			args, err := utils.ProvidedArgsOrFromPipe(args)
 			utils.ExitOnErr(err, "failed to get args from pipe")
 			utils.RequireExactArgsCount(args, 1, cmd)
diff --git a/cmd/convert/decode_base64.go b/cmd/convert/decode_base64.go
@@ -3,6 +3,7 @@ package convert
 import (
 	"encoding/base64"
 	"fmt"
+	"github.com/bcdevtools/devd/v2/constants"
 
 	"github.com/bcdevtools/devd/v2/cmd/utils"
 	"github.com/spf13/cobra"
@@ -16,6 +17,8 @@ func GetDecodeBase64CaseCmd() *cobra.Command {
 		Long: `Decode base64.
 Support pipe.`,
 		Run: func(cmd *cobra.Command, args []string) {
+			utils.PrintfStdErr("WARN: from v3, this command will be renamed to `%s convert base64 ... --decode`\n", constants.BINARY_NAME)
+
 			args, err := utils.ProvidedArgsOrFromPipe(args)
 			utils.ExitOnErr(err, "failed to get args from pipe")
 			utils.RequireExactArgsCount(args, 1, cmd)
diff --git a/cmd/convert/decode_raw_evm_tx.go b/cmd/convert/decode_raw_evm_tx.go
@@ -2,6 +2,7 @@ package convert
 
 import (
 	"fmt"
+	"github.com/bcdevtools/devd/v2/constants"
 	"os"
 	"regexp"
 	"strings"
@@ -12,10 +13,13 @@ import (
 
 func GetDecodeRawEvmTxCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "decode_raw_tx [raw RLP-encoded EVM tx hex]",
-		Short: `Decode the raw RLP-encoded EVM tx to see inner details, additional information will be injected with prefix '_'`,
-		Args:  cobra.ExactArgs(1),
+		Use:     "decode_raw_tx [raw RLP-encoded EVM tx hex]",
+		Aliases: []string{"raw-tx"},
+		Short:   `Decode the raw RLP-encoded EVM tx to see inner details, additional information will be injected with prefix '_'`,
+		Args:    cobra.ExactArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
+			utils.PrintfStdErr("WARN: from v3, this command will be moved and renamed to `%s debug raw-tx ...`\n", constants.BINARY_NAME)
+
 			rawTx := strings.ToLower(args[0])
 			if !regexp.MustCompile(`^(0x)?[a-fA-F\d]+$`).MatchString(rawTx) {
 				utils.PrintlnStdErr("ERR: invalid raw EVM tx, must be valid hex-encoded string")
diff --git a/cmd/convert/encode_base64.go b/cmd/convert/encode_base64.go
@@ -3,6 +3,7 @@ package convert
 import (
 	"encoding/base64"
 	"fmt"
+	"github.com/bcdevtools/devd/v2/constants"
 	"strings"
 
 	"github.com/bcdevtools/devd/v2/cmd/utils"
@@ -18,6 +19,8 @@ func GetEncodeBase64CaseCmd() *cobra.Command {
 		Long: `Encode input text into base64.
 Support pipe.`,
 		Run: func(cmd *cobra.Command, args []string) {
+			utils.PrintfStdErr("WARN: from v3, this command will be renamed to `%s convert base64 ...`\n", constants.BINARY_NAME)
+
 			args, err := utils.ProvidedArgsOrFromPipe(args)
 			utils.ExitOnErr(err, "failed to get args from pipe")
 			utils.RequireArgs(args, cmd)
diff --git a/cmd/convert/hexadecimal_to_decimal.go b/cmd/convert/hexadecimal_to_decimal.go
@@ -2,6 +2,7 @@ package convert
 
 import (
 	"fmt"
+	"github.com/bcdevtools/devd/v2/constants"
 	"math/big"
 	"os"
 	"regexp"
@@ -19,6 +20,8 @@ func GetConvertHexadecimalToDecimalCmd() *cobra.Command {
 		Long: `Convert hexadecimal to decimal.
 Support pipe.`,
 		Run: func(cmd *cobra.Command, args []string) {
+			utils.PrintfStdErr("WARN: from v3, this command will be renamed to `%s convert hex [0xHex]`\n", constants.BINARY_NAME)
+
 			args, err := utils.ProvidedArgsOrFromPipe(args)
 			utils.ExitOnErr(err, "failed to get args from pipe")
 			utils.RequireExactArgsCount(args, 1, cmd)
diff --git a/cmd/convert/solc_sig.go b/cmd/convert/solc_sig.go
@@ -2,6 +2,7 @@ package convert
 
 import (
 	"fmt"
+	"github.com/bcdevtools/devd/v2/constants"
 	"regexp"
 	"strings"
 
@@ -14,8 +15,9 @@ import (
 // GetConvertSolcSignatureCmd creates a helper command that convert EVM method/event into keccak256 hash and 4 bytes signature
 func GetConvertSolcSignatureCmd() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "solc_sig [method or event]",
-		Short: "Convert Solidity method/event signature into hashed signature and 4 bytes signature.",
+		Use:     "solc_sig [method or event]",
+		Aliases: []string{"solc-sig"},
+		Short:   "Convert Solidity method/event signature into hashed signature and 4 bytes signature.",
 		Long: `Convert Solidity method/event signature into hashed signature and 4 bytes signature.
 Output will be 4 lines:
 1. Type: Method/Event
@@ -25,6 +27,8 @@ Output will be 4 lines:
 `,
 		Args: cobra.MinimumNArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
+			utils.PrintfStdErr("WARN: from v3, this command will be renamed to `%s convert solc-sig ...`\n", constants.BINARY_NAME)
+
 			_interface := strings.Join(args, " ")
 
 			_4BytesSig, hash, finalInterface, err := getSignatureFromInterface(_interface)
diff --git a/cmd/convert/to_lower_case.go b/cmd/convert/to_lower_case.go
@@ -2,6 +2,7 @@ package convert
 
 import (
 	"fmt"
+	"github.com/bcdevtools/devd/v2/constants"
 	"strings"
 
 	"github.com/bcdevtools/devd/v2/cmd/utils"
@@ -17,6 +18,8 @@ func GetConvertToLowerCaseCmd() *cobra.Command {
 		Long: `Convert input text into lower case.
 Support pipe.`,
 		Run: func(cmd *cobra.Command, args []string) {
+			utils.PrintfStdErr("WARN: from v3, this command will be renamed to `%s convert case ...`\n", constants.BINARY_NAME)
+
 			var err error
 			args, err = utils.ProvidedArgsOrFromPipe(args)
 			utils.ExitOnErr(err, "failed to get args from pipe")
diff --git a/cmd/convert/to_upper_case.go b/cmd/convert/to_upper_case.go
@@ -2,6 +2,7 @@ package convert
 
 import (
 	"fmt"
+	"github.com/bcdevtools/devd/v2/constants"
 	"strings"
 
 	"github.com/bcdevtools/devd/v2/cmd/utils"
@@ -17,6 +18,8 @@ func GetConvertToUpperCaseCmd() *cobra.Command {
 		Long: `Convert input text into upper case.
 Support pipe.`,
 		Run: func(cmd *cobra.Command, args []string) {
+			utils.PrintfStdErr("WARN: from v3, this command will be renamed to `%s convert case ... --upper`\n", constants.BINARY_NAME)
+
 			var err error
 			args, err = utils.ProvidedArgsOrFromPipe(args)
 			utils.ExitOnErr(err, "failed to get args from pipe")
diff --git a/cmd/query/eth_getBlockByNumber.go b/cmd/query/eth_getBlockByNumber.go
@@ -3,6 +3,7 @@ package query
 import (
 	"encoding/json"
 	"fmt"
+	"github.com/bcdevtools/devd/v2/constants"
 	ethtypes "github.com/ethereum/go-ethereum/core/types"
 	"math/big"
 	"os"
@@ -21,6 +22,8 @@ func GetQueryBlockCommand() *cobra.Command {
 		Short:   "eth_getBlockByNumber",
 		Args:    cobra.ExactArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
+			utils.PrintfStdErr("WARN! Deprecation notice: from v3, command alias `block` will be removed, please use `%s q eth_getBlockByNumber ...` instead of `%s q block ...`\n", constants.BINARY_NAME, constants.BINARY_NAME)
+
 			_, rpc := mustGetEthClient(cmd, false)
 
 			input := strings.ToLower(args[0])
diff --git a/cmd/query/eth_getTransactionByHash.go b/cmd/query/eth_getTransactionByHash.go
@@ -3,6 +3,7 @@ package query
 import (
 	"context"
 	"fmt"
+	"github.com/bcdevtools/devd/v2/constants"
 	"os"
 	"regexp"
 	"strings"
@@ -19,6 +20,8 @@ func GetQueryTxCommand() *cobra.Command {
 		Short:   "eth_getTransactionByHash",
 		Args:    cobra.ExactArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
+			utils.PrintfStdErr("WARN! Deprecation notice: from v3, command alias `tx` will be removed, please use `%s q eth_getTransactionByHash ...` instead of `%s q tx ...`\n", constants.BINARY_NAME, constants.BINARY_NAME)
+
 			ethClient, _ := mustGetEthClient(cmd, false)
 
 			input := strings.ToLower(args[0])
diff --git a/cmd/query/evm.go b/cmd/query/evm.go
@@ -32,6 +32,12 @@ func mustGetEthClient(cmd *cobra.Command, fallbackDeprecatedFlagHost bool) (ethC
 		inputSource = "default"
 	}
 
+	if inputSource == "flag" {
+		utils.PrintfStdErr("WARN: from v3, use `--evm-rpc` instead of `--%s`, this old flag will no longer functioning\n", flagRpc)
+	} else {
+		utils.PrintfStdErr("WARN: from v3, flag `--%s` will be renamed to `--evm-rpc`\n", flagRpc)
+	}
+
 	utils.PrintlnStdErr("INF: Connecting to EVM Json-RPC", rpc, fmt.Sprintf("(from %s)", inputSource))
 
 	ethClient8545, err = ethclient.Dial(rpc)
diff --git a/cmd/tx/deploy-erc20.go b/cmd/tx/deploy-erc20.go
@@ -1,6 +1,8 @@
 package tx
 
 import (
+	"github.com/bcdevtools/devd/v2/cmd/utils"
+	"github.com/bcdevtools/devd/v2/constants"
 	"github.com/spf13/cobra"
 )
 
@@ -14,6 +16,8 @@ func GetDeployErc20EvmTxCommand() *cobra.Command {
 		Short: "Deploy an ERC20 contract",
 		Args:  cobra.NoArgs,
 		Run: func(cmd *cobra.Command, args []string) {
+			utils.PrintfStdErr("WARN: from v3, this command will be removed, please use `%s tx deploy-contract erc20`\n", constants.BINARY_NAME)
+
 			deployEvmContract(BytecodeErc20Contract, cmd)
 		},
 	}
diff --git a/cmd/tx/evm.go b/cmd/tx/evm.go
@@ -32,6 +32,12 @@ func mustGetEthClient(cmd *cobra.Command) (ethClient8545 *ethclient.Client, rpc
 		inputSource = "default"
 	}
 
+	if inputSource == "flag" {
+		utils.PrintfStdErr("WARN: from v3, use `--evm-rpc` instead of `--%s`, this old flag will no longer functioning\n", flagRpc)
+	} else {
+		utils.PrintfStdErr("WARN: from v3, flag `--%s` will be renamed to `--evm-rpc`\n", flagRpc)
+	}
+
 	utils.PrintlnStdErr("INF: Connecting to EVM Json-RPC", rpc, fmt.Sprintf("(from %s)", inputSource))
 
 	ethClient8545, err = ethclient.Dial(rpc)
