R4R: Fix HTLC CLI (#2110)

* Create go.yml * Update go.yml * Update go.yml * Update go.yml * Update go.yml * Update go.yml * Update go.yml * Update go.yml * Update go.yml * Update go.yml * Update go.yml * Update go.yml * Update go.yml * Update go.yml * Update go.yml * Create testUnit.yml * Update and rename go.yml to buildAndPush.yml * Update buildAndPush.yml * Update testUnit.yml * Update buildAndPush.yml * Update buildAndPush.yml * Update testUnit.yml * Update testUnit.yml * Update testUnit.yml * update latest version * Update coinswap desc * typo fix * instead circleci with github actions * optimize * remove trigger on PR * rename Co-Authored-By: Yelong Zhang <[email protected]> * rename Co-Authored-By: Yelong Zhang <[email protected]> * rename Co-Authored-By: Yelong Zhang <[email protected]> * Update .github/workflows/testUnit.yml Co-Authored-By: Yelong Zhang <[email protected]> * Update .github/workflows/buildAndPush.yml Co-Authored-By: Yelong Zhang <[email protected]> * Update .github/workflows/buildAndPush.yml Co-Authored-By: Yelong Zhang <[email protected]> * Rename buildAndPush.yml to BuildAndPublish.yml * Update BuildAndPublish.yml * Rename testUnit.yml to TestUnit.yml * fix htlc cli * modify * fix by hint * fix * fix docs
irisnet · Dec 4, 2019 · 82402a6 · 82402a6
1 parent c082f85
commit 82402a6
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 22 deletions.
diff --git a/client/htlc/cli/flags.go b/client/htlc/cli/flags.go
@@ -24,7 +24,8 @@ func init() {
 	FsCreateHTLC.String(cli.FlagTo, "", "Bech32 encoding address to receive coins")
 	FsCreateHTLC.String(FlagReceiverOnOtherChain, "", "The claim receiving address on the other chain")
 	FsCreateHTLC.String(FlagAmount, "", "Similar to the amount in the original transfer")
-	FsCreateHTLC.BytesHex(FlagSecret, nil, "The secret for generating the hash lock, omission will be randomly generated")
+	FsCreateHTLC.BytesHex(FlagSecret, nil, "The secret for generating the hash lock, randomly generated if omitted")
+	FsCreateHTLC.BytesHex(FlagHashLock, nil, "The sha256 hash generated from secret (and timestamp if provided), generated from the secret flag if omitted")
 	FsCreateHTLC.Uint64(FlagTimestamp, 0, "The timestamp in seconds for generating the hash lock if provided")
 	FsCreateHTLC.String(FlagTimeLock, "", "The number of blocks to wait before the asset may be returned to")
 

diff --git a/client/htlc/cli/sendtx.go b/client/htlc/cli/sendtx.go
@@ -22,8 +22,9 @@ func GetCmdCreateHTLC(cdc *codec.Codec) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "create",
 		Short: "Create an HTLC",
-		Example: "iriscli htlc create --chain-id=<chain-id> --from=<key-name> --fee=0.3iris --to=<to> --receiver-on-other-chain=<receiver-on-other-chain> --amount=<amount> --secret=<secret> " +
-			"--time-lock=<time-lock> --timestamp=<timestamp>",
+		Example: "iriscli htlc create --chain-id=<chain-id> --from=<key-name> --fee=0.3iris --to=<to> --receiver-on-other-chain=<receiver-on-other-chain> " +
+			"--amount=<amount> --secret=<secret> --hash-lock=<hash-lock> --timestamp=<timestamp> --time-lock=<time-lock>",
+		PreRunE: preCheckCmd,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			cliCtx := context.NewCLIContext().
 				WithCodec(cdc).
@@ -51,29 +52,39 @@ func GetCmdCreateHTLC(cdc *codec.Codec) *cobra.Command {
 				return err
 			}
 
-			secret := make([]byte, 32)
+			timestamp := viper.GetInt64(FlagTimestamp)
+			timeLock := viper.GetInt64(FlagTimeLock)
 
-			secretStr := strings.TrimSpace(viper.GetString(FlagSecret))
-			if len(secretStr) > 0 {
-				if len(secretStr) != 2*htlc.SecretLength {
-					return fmt.Errorf("the secret must be %d bytes long", htlc.SecretLength)
-				}
+			secret := make([]byte, 32)
+			var hashLock []byte
 
-				secret, err = hex.DecodeString(secretStr)
+			flags := cmd.Flags()
+			if flags.Changed(FlagHashLock) {
+				hashLockStr := strings.TrimSpace(viper.GetString(FlagHashLock))
+				hashLock, err = hex.DecodeString(hashLockStr)
 				if err != nil {
 					return err
 				}
 			} else {
-				_, err := rand.Read(secret)
-				if err != nil {
-					return err
+				secretStr := strings.TrimSpace(viper.GetString(FlagSecret))
+				if len(secretStr) > 0 {
+					if len(secretStr) != 2*htlc.SecretLength {
+						return fmt.Errorf("the secret must be %d bytes long", htlc.SecretLength)
+					}
+
+					secret, err = hex.DecodeString(secretStr)
+					if err != nil {
+						return err
+					}
+				} else {
+					_, err := rand.Read(secret)
+					if err != nil {
+						return err
+					}
 				}
-			}
 
-			timestamp := viper.GetInt64(FlagTimestamp)
-			hashLock := htlc.GetHashLock(secret, uint64(timestamp))
-
-			timeLock := viper.GetInt64(FlagTimeLock)
+				hashLock = htlc.GetHashLock(secret, uint64(timestamp))
+			}
 
 			msg := htlc.NewMsgCreateHTLC(
 				sender, toAddr, receiverOnOtherChain, amount,
@@ -84,7 +95,7 @@ func GetCmdCreateHTLC(cdc *codec.Codec) *cobra.Command {
 			}
 
 			err = utils.SendOrPrintTx(txCtx, cliCtx, []sdk.Msg{msg})
-			if err == nil {
+			if err == nil && !flags.Changed(FlagHashLock) {
 				fmt.Println("**Important** save this secret, hashLock in a safe place.")
 				fmt.Println("It is the only way to claim or refund the locked coins from an HTLC")
 				fmt.Println()
@@ -192,3 +203,13 @@ func GetCmdRefundHTLC(cdc *codec.Codec) *cobra.Command {
 
 	return cmd
 }
+
+func preCheckCmd(cmd *cobra.Command, _ []string) error {
+	// make sure either the secret or hash lock is provided
+	flags := cmd.Flags()
+	if flags.Changed(FlagSecret) && flags.Changed(FlagHashLock) {
+		return fmt.Errorf("only one flag is allowed among the secret and hash lock")
+	}
+
+	return nil
+}
diff --git a/docs/cli-client/htlc.md b/docs/cli-client/htlc.md
@@ -32,8 +32,8 @@ iriscli htlc create --chain-id=<chain-id> --from=<key-name> --fee=0.3iris --to=<
 | --to                      | string   | Yes      |         | Bech32 encoding address to receive coins                          |
 | --receiver-on-other-chain | string   |          |         | The claim receiving address on the other chain                 |
 | --amount                  | string   | Yes      |         | Similar to the amount in the original transfer                    |
-| --secret                  | bytesHex |          |         | The secret for generating the hash lock, omission will be randomly generated |
-| --hash-lock               | bytesHex | Yes      |         | The sha256 hash generated from secret (and timestamp if provided) |
+| --secret                  | bytesHex |          |         | The secret for generating the hash lock, randomly generated if omitted |
+| --hash-lock               | bytesHex |          |         | The sha256 hash generated from secret (and timestamp if provided), generated from the secret flag if omitted |
 | --time-lock               | string   | Yes      |         | The number of blocks to wait before the asset may be returned to  |
 | --timestamp               | uint     |          |         | The timestamp in seconds for generating hash lock if provided     |
 

diff --git a/docs/zh/cli-client/htlc.md b/docs/zh/cli-client/htlc.md
@@ -33,7 +33,7 @@ iriscli htlc create --chain-id=<chain-id> --from=<key-name> --fee=0.3iris --to=<
 | --receiver-on-other-chain | bytesHex |      |      | 另一条链上的HTLC认领接收地址                          |
 | --amount                  | string   | 是   |      | 要发送的金额                                      |
 | --secret                  | bytesHex |      |      | 用于生成Hash Lock的secret, 缺省将随机生成    |
-| --hash-lock               | bytesHex | 是   |      | 由secret和时间戳（如果提供）生成的sha256哈希 |
+| --hash-lock               | bytesHex |      |      | 由secret和时间戳（如果提供）生成的sha256哈希, 缺省将根据secret标志生成 |
 | --time-lock               | string   | 是   |      | 资金锁定的区块数                                  |
 | --timestamp               | uint     |      |      | 参与生成hash lock的10位时间戳（可选）           |