address: Update Address interface

Author: qshuai

chaincfg/params.go

@@ -534,7 +534,7 @@ var SimNetParams = Params{
 	HDPrivateKeyID: [4]byte{0x04, 0x20, 0xb9, 0x00}, // starts with sprv
 	HDPublicKeyID:  [4]byte{0x04, 0x20, 0xbd, 0x3a}, // starts with spub
 
-	CashAddrPrefix: "bchsim",
+	CashAddrPrefix: "bchreg",
 
 	// BIP44 coin type used in the hierarchical deterministic path for
 	// address generation.

config.go

@@ -827,14 +827,7 @@ func loadConfig() (*config, []string, error) {
 	// Check mining addresses are valid and saved parsed versions.
 	cfg.miningAddrs = make([]cashutil.Address, 0, len(cfg.MiningAddrs))
 	for _, strAddr := range cfg.MiningAddrs {
-		var addr cashutil.Address
-		var err error
-
-		if len(strAddr) >= 42 {
-			addr, err = cashutil.DecodeCashAddr(strAddr, activeNetParams.Params)
-		} else {
-			addr, err = cashutil.DecodeAddress(strAddr, activeNetParams.Params)
-		}
+		addr, err := cashutil.DecodeAddress(strAddr, activeNetParams.Params)
 		if err != nil {
 			str := "%s: mining address '%s' failed to decode: %v"
 			err := fmt.Errorf(str, funcName, strAddr, err)

rpcclient/extensions.go

@@ -132,7 +132,7 @@ func (c *Client) ListAddressTransactionsAsync(addresses []cashutil.Address, acco
 	// Convert addresses to strings.
 	addrs := make([]string, 0, len(addresses))
 	for _, addr := range addresses {
-		addrs = append(addrs, addr.EncodeAddress())
+		addrs = append(addrs, addr.EncodeAddress(true))
 	}
 	cmd := btcjson.NewListAddressTransactionsCmd(addrs, &account)
 	return c.sendCmd(cmd)

rpcclient/notify.go

@@ -1332,7 +1332,7 @@ func (c *Client) LoadTxFilterAsync(reload bool, addresses []cashutil.Address,
 
 	addrStrs := make([]string, len(addresses))
 	for i, a := range addresses {
-		addrStrs[i] = a.EncodeAddress()
+		addrStrs[i] = a.EncodeAddress(true)
 	}
 	outPointObjects := make([]btcjson.OutPoint, len(outPoints))
 	for i := range outPoints {

rpcclient/rawtransactions.go

@@ -551,7 +551,7 @@ func (r FutureSearchRawTransactionsResult) Receive() ([]*wire.MsgTx, error) {
 //
 // See SearchRawTransactions for the blocking version and more details.
 func (c *Client) SearchRawTransactionsAsync(address cashutil.Address, skip, count int, reverse bool, filterAddrs []string) FutureSearchRawTransactionsResult {
-	addr := address.EncodeAddress()
+	addr := address.EncodeAddress(true)
 	verbose := btcjson.Int(0)
 	cmd := btcjson.NewSearchRawTransactionsCmd(addr, verbose, &skip, &count,
 		nil, &reverse, &filterAddrs)
@@ -600,7 +600,7 @@ func (r FutureSearchRawTransactionsVerboseResult) Receive() ([]*btcjson.SearchRa
 func (c *Client) SearchRawTransactionsVerboseAsync(address cashutil.Address, skip,
 	count int, includePrevOut, reverse bool, filterAddrs *[]string) FutureSearchRawTransactionsVerboseResult {
 
-	addr := address.EncodeAddress()
+	addr := address.EncodeAddress(true)
 	verbose := btcjson.Int(1)
 	var prevOut *int
 	if includePrevOut {

rpcclient/wallet.go

@@ -206,7 +206,7 @@ func (c *Client) ListUnspentMinMaxAsync(minConf, maxConf int) FutureListUnspentR
 func (c *Client) ListUnspentMinMaxAddressesAsync(minConf, maxConf int, addrs []cashutil.Address) FutureListUnspentResult {
 	addrStrs := make([]string, 0, len(addrs))
 	for _, a := range addrs {
-		addrStrs = append(addrStrs, a.EncodeAddress())
+		addrStrs = append(addrStrs, a.EncodeAddress(true))
 	}
 
 	cmd := btcjson.NewListUnspentCmd(&minConf, &maxConf, &addrStrs)
@@ -471,7 +471,7 @@ func (r FutureSendToAddressResult) Receive() (*chainhash.Hash, error) {
 //
 // See SendToAddress for the blocking version and more details.
 func (c *Client) SendToAddressAsync(address cashutil.Address, amount cashutil.Amount) FutureSendToAddressResult {
-	addr := address.EncodeAddress()
+	addr := address.EncodeAddress(true)
 	cmd := btcjson.NewSendToAddressCmd(addr, amount.ToBCH(), nil, nil)
 	return c.sendCmd(cmd)
 }
@@ -497,7 +497,7 @@ func (c *Client) SendToAddressCommentAsync(address cashutil.Address,
 	amount cashutil.Amount, comment,
 	commentTo string) FutureSendToAddressResult {
 
-	addr := address.EncodeAddress()
+	addr := address.EncodeAddress(true)
 	cmd := btcjson.NewSendToAddressCmd(addr, amount.ToBCH(), &comment,
 		&commentTo)
 	return c.sendCmd(cmd)
@@ -550,7 +550,7 @@ func (r FutureSendFromResult) Receive() (*chainhash.Hash, error) {
 //
 // See SendFrom for the blocking version and more details.
 func (c *Client) SendFromAsync(fromAccount string, toAddress cashutil.Address, amount cashutil.Amount) FutureSendFromResult {
-	addr := toAddress.EncodeAddress()
+	addr := toAddress.EncodeAddress(true)
 	cmd := btcjson.NewSendFromCmd(fromAccount, addr, amount.ToBCH(), nil,
 		nil, nil)
 	return c.sendCmd(cmd)
@@ -574,7 +574,7 @@ func (c *Client) SendFrom(fromAccount string, toAddress cashutil.Address, amount
 //
 // See SendFromMinConf for the blocking version and more details.
 func (c *Client) SendFromMinConfAsync(fromAccount string, toAddress cashutil.Address, amount cashutil.Amount, minConfirms int) FutureSendFromResult {
-	addr := toAddress.EncodeAddress()
+	addr := toAddress.EncodeAddress(true)
 	cmd := btcjson.NewSendFromCmd(fromAccount, addr, amount.ToBCH(),
 		&minConfirms, nil, nil)
 	return c.sendCmd(cmd)
@@ -603,7 +603,7 @@ func (c *Client) SendFromCommentAsync(fromAccount string,
 	toAddress cashutil.Address, amount cashutil.Amount, minConfirms int,
 	comment, commentTo string) FutureSendFromResult {
 
-	addr := toAddress.EncodeAddress()
+	addr := toAddress.EncodeAddress(true)
 	cmd := btcjson.NewSendFromCmd(fromAccount, addr, amount.ToBCH(),
 		&minConfirms, &comment, &commentTo)
 	return c.sendCmd(cmd)
@@ -660,7 +660,7 @@ func (r FutureSendManyResult) Receive() (*chainhash.Hash, error) {
 func (c *Client) SendManyAsync(fromAccount string, amounts map[cashutil.Address]cashutil.Amount) FutureSendManyResult {
 	convertedAmounts := make(map[string]float64, len(amounts))
 	for addr, amount := range amounts {
-		convertedAmounts[addr.EncodeAddress()] = amount.ToBCH()
+		convertedAmounts[addr.EncodeAddress(true)] = amount.ToBCH()
 	}
 	cmd := btcjson.NewSendManyCmd(fromAccount, convertedAmounts, nil, nil)
 	return c.sendCmd(cmd)
@@ -689,7 +689,7 @@ func (c *Client) SendManyMinConfAsync(fromAccount string,
 
 	convertedAmounts := make(map[string]float64, len(amounts))
 	for addr, amount := range amounts {
-		convertedAmounts[addr.EncodeAddress()] = amount.ToBCH()
+		convertedAmounts[addr.EncodeAddress(true)] = amount.ToBCH()
 	}
 	cmd := btcjson.NewSendManyCmd(fromAccount, convertedAmounts,
 		&minConfirms, nil)
@@ -723,7 +723,7 @@ func (c *Client) SendManyCommentAsync(fromAccount string,
 
 	convertedAmounts := make(map[string]float64, len(amounts))
 	for addr, amount := range amounts {
-		convertedAmounts[addr.EncodeAddress()] = amount.ToBCH()
+		convertedAmounts[addr.EncodeAddress(true)] = amount.ToBCH()
 	}
 	cmd := btcjson.NewSendManyCmd(fromAccount, convertedAmounts,
 		&minConfirms, &comment)
@@ -972,7 +972,7 @@ func (r FutureGetAccountResult) Receive() (string, error) {
 //
 // See GetAccount for the blocking version and more details.
 func (c *Client) GetAccountAsync(address cashutil.Address) FutureGetAccountResult {
-	addr := address.EncodeAddress()
+	addr := address.EncodeAddress(true)
 	cmd := btcjson.NewGetAccountCmd(addr)
 	return c.sendCmd(cmd)
 }
@@ -999,7 +999,7 @@ func (r FutureSetAccountResult) Receive() error {
 //
 // See SetAccount for the blocking version and more details.
 func (c *Client) SetAccountAsync(address cashutil.Address, account string) FutureSetAccountResult {
-	addr := address.EncodeAddress()
+	addr := address.EncodeAddress(true)
 	cmd := btcjson.NewSetAccountCmd(addr, account)
 	return c.sendCmd(cmd)
 }
@@ -1202,7 +1202,7 @@ func (r FutureValidateAddressResult) Receive() (*btcjson.ValidateAddressWalletRe
 //
 // See ValidateAddress for the blocking version and more details.
 func (c *Client) ValidateAddressAsync(address cashutil.Address) FutureValidateAddressResult {
-	addr := address.EncodeAddress()
+	addr := address.EncodeAddress(true)
 	cmd := btcjson.NewValidateAddressCmd(addr)
 	return c.sendCmd(cmd)
 }
@@ -1575,7 +1575,7 @@ func (r FutureGetReceivedByAddressResult) Receive() (cashutil.Amount, error) {
 //
 // See GetReceivedByAddress for the blocking version and more details.
 func (c *Client) GetReceivedByAddressAsync(address cashutil.Address) FutureGetReceivedByAddressResult {
-	addr := address.EncodeAddress()
+	addr := address.EncodeAddress(true)
 	cmd := btcjson.NewGetReceivedByAddressCmd(addr, nil)
 	return c.sendCmd(cmd)
 
@@ -1596,7 +1596,7 @@ func (c *Client) GetReceivedByAddress(address cashutil.Address) (cashutil.Amount
 //
 // See GetReceivedByAddressMinConf for the blocking version and more details.
 func (c *Client) GetReceivedByAddressMinConfAsync(address cashutil.Address, minConfirms int) FutureGetReceivedByAddressResult {
-	addr := address.EncodeAddress()
+	addr := address.EncodeAddress(true)
 	cmd := btcjson.NewGetReceivedByAddressCmd(addr, &minConfirms)
 	return c.sendCmd(cmd)
 }
@@ -1885,7 +1885,7 @@ func (r FutureSignMessageResult) Receive() (string, error) {
 //
 // See SignMessage for the blocking version and more details.
 func (c *Client) SignMessageAsync(address cashutil.Address, message string) FutureSignMessageResult {
-	addr := address.EncodeAddress()
+	addr := address.EncodeAddress(true)
 	cmd := btcjson.NewSignMessageCmd(addr, message)
 	return c.sendCmd(cmd)
 }
@@ -1926,7 +1926,7 @@ func (r FutureVerifyMessageResult) Receive() (bool, error) {
 //
 // See VerifyMessage for the blocking version and more details.
 func (c *Client) VerifyMessageAsync(address cashutil.Address, signature, message string) FutureVerifyMessageResult {
-	addr := address.EncodeAddress()
+	addr := address.EncodeAddress(true)
 	cmd := btcjson.NewVerifyMessageCmd(addr, signature, message)
 	return c.sendCmd(cmd)
 }
@@ -1972,7 +1972,7 @@ func (r FutureDumpPrivKeyResult) Receive() (*cashutil.WIF, error) {
 //
 // See DumpPrivKey for the blocking version and more details.
 func (c *Client) DumpPrivKeyAsync(address cashutil.Address) FutureDumpPrivKeyResult {
-	addr := address.EncodeAddress()
+	addr := address.EncodeAddress(true)
 	cmd := btcjson.NewDumpPrivKeyCmd(addr)
 	return c.sendCmd(cmd)
 }

rpcserver.go

@@ -554,7 +554,7 @@ func handleCreateRawTransaction(s *rpcServer, cmd interface{}, closeChan <-chan
 		}
 
 		// Decode the provided address.
-		addr, err := cashutil.DecodeCashAddr(encodedAddr, params)
+		addr, err := cashutil.DecodeAddress(encodedAddr, params)
 		if err != nil {
 			return nil, &btcjson.RPCError{
 				Code:    btcjson.ErrRPCInvalidAddressOrKey,
@@ -688,7 +688,7 @@ func createVoutList(mtx *wire.MsgTx, chainParams *chaincfg.Params, filterAddrMap
 		passesFilter := len(filterAddrMap) == 0
 		encodedAddrs := make([]string, len(addrs))
 		for j, addr := range addrs {
-			encodedAddr := cashutil.EncodeCashAddr(addr, chainParams)
+			encodedAddr := addr.EncodeAddress(true)
 			encodedAddrs[j] = encodedAddr
 
 			// No need to check the map again if the filter already
@@ -811,7 +811,7 @@ func handleDecodeScript(s *rpcServer, cmd interface{}, closeChan <-chan struct{}
 		s.cfg.ChainParams)
 	addresses := make([]string, len(addrs))
 	for i, addr := range addrs {
-		addresses[i] = cashutil.EncodeCashAddr(addr, s.cfg.ChainParams)
+		addresses[i] = addr.EncodeAddress(true)
 	}
 
 	// Convert the script itself to a pay-to-script-hash address.
@@ -829,7 +829,7 @@ func handleDecodeScript(s *rpcServer, cmd interface{}, closeChan <-chan struct{}
 		Addresses: addresses,
 	}
 	if scriptClass != txscript.ScriptHashTy {
-		reply.P2sh = cashutil.EncodeCashAddr(p2sh, s.cfg.ChainParams)
+		reply.P2sh = p2sh.EncodeAddress(true)
 	}
 	return reply, nil
 }
@@ -2698,7 +2698,7 @@ func handleGetTxOut(s *rpcServer, cmd interface{}, closeChan <-chan struct{}) (i
 		s.cfg.ChainParams)
 	addresses := make([]string, len(addrs))
 	for i, addr := range addrs {
-		addresses[i] = cashutil.EncodeCashAddr(addr, s.cfg.ChainParams)
+		addresses[i] = addr.EncodeAddress(true)
 	}
 
 	txOutReply := &btcjson.GetTxOutResult{
@@ -2946,7 +2946,7 @@ func createVinListPrevOut(s *rpcServer, mtx *wire.MsgTx, chainParams *chaincfg.P
 		// filter when needed.
 		encodedAddrs := make([]string, len(addrs))
 		for j, addr := range addrs {
-			encodedAddr := cashutil.EncodeCashAddr(addr, chainParams)
+			encodedAddr := addr.EncodeAddress(true)
 			encodedAddrs[j] = encodedAddr
 
 			// No need to check the map again if the filter already
@@ -3036,7 +3036,7 @@ func handleSearchRawTransactions(s *rpcServer, cmd interface{}, closeChan <-chan
 
 	// Attempt to decode the supplied address.
 	params := s.cfg.ChainParams
-	addr, err := cashutil.DecodeCashAddr(c.Address, params)
+	addr, err := cashutil.DecodeAddress(c.Address, params)
 	if err != nil {
 		return nil, &btcjson.RPCError{
 			Code:    btcjson.ErrRPCInvalidAddressOrKey,
@@ -3433,13 +3433,13 @@ func handleValidateAddress(s *rpcServer, cmd interface{}, closeChan <-chan struc
 	c := cmd.(*btcjson.ValidateAddressCmd)
 
 	result := btcjson.ValidateAddressChainResult{}
-	addr, err := cashutil.DecodeCashAddr(c.Address, s.cfg.ChainParams)
+	addr, err := cashutil.DecodeAddress(c.Address, s.cfg.ChainParams)
 	if err != nil {
 		// Return the default value (false) for IsValid.
 		return result, nil
 	}
 
-	result.Address = cashutil.EncodeCashAddr(addr, s.cfg.ChainParams)
+	result.Address = addr.EncodeAddress(true)
 	result.IsValid = true
 
 	return result, nil
@@ -3448,21 +3448,22 @@ func handleValidateAddress(s *rpcServer, cmd interface{}, closeChan <-chan struc
 func convCashAddr(s *rpcServer, cmd interface{}, closeChan <-chan struct{}) (interface{}, error) {
 	c := cmd.(*btcjson.ConvCashAddrCmd)
 
-	if len(c.Address) >= 42 {
-		addr, err := cashutil.DecodeCashAddr(c.Address, s.cfg.ChainParams)
-		if err != nil {
-			return nil, btcjson.ErrRPCInvalidParams
-		}
-
-		return addr.EncodeAddress(), nil
-	}
-
 	addr, err := cashutil.DecodeAddress(c.Address, s.cfg.ChainParams)
 	if err != nil {
 		return nil, btcjson.ErrRPCInvalidParams
 	}
 
-	return cashutil.EncodeCashAddr(addr, s.cfg.ChainParams), nil
+	// bitcoin cash base32-encoded address:
+	// 1. mainnet:  bitcoincash: + 42 bytes = 12 + 42
+	// 2. testnet3: bchtest:     + 42 bytes = 8  + 42
+	// 3. regtest:  bchreg:      + 42 bytes = 7  + 42
+	// if the address does not have the prefix: length = 42
+	// if the address have the prefix: max length = 42 + 12
+	if len(c.Address) >= 42 && len(c.Address) <= 42+12 {
+		return addr.EncodeAddress(false), nil
+	}
+
+	return addr.EncodeAddress(true), nil
 }
 
 func verifyChain(s *rpcServer, level, depth int32) error {
@@ -3522,7 +3523,7 @@ func handleVerifyMessage(s *rpcServer, cmd interface{}, closeChan <-chan struct{
 
 	// Decode the provided address.
 	params := s.cfg.ChainParams
-	addr, err := cashutil.DecodeCashAddr(c.Address, params)
+	addr, err := cashutil.DecodeAddress(c.Address, params)
 	if err != nil {
 		return nil, &btcjson.RPCError{
 			Code:    btcjson.ErrRPCInvalidAddressOrKey,
@@ -3576,7 +3577,7 @@ func handleVerifyMessage(s *rpcServer, cmd interface{}, closeChan <-chan struct{
 	}
 
 	// Return boolean if addresses match.
-	return cashutil.EncodeCashAddr(address, s.cfg.ChainParams) == c.Address, nil
+	return address.EncodeAddress(true) == c.Address, nil
 }
 
 // handleVersion implements the version command.

rpcwebsocket.go

@@ -321,7 +321,7 @@ func (f *wsClientFilter) addAddress(a cashutil.Address) {
 		}
 	}
 
-	f.otherAddresses[a.EncodeAddress()] = struct{}{}
+	f.otherAddresses[a.EncodeAddress(true)] = struct{}{}
 }
 
 // addAddressStr parses an address from a string and then adds it to the
@@ -373,7 +373,7 @@ func (f *wsClientFilter) existsAddress(a cashutil.Address) bool {
 		}
 	}
 
-	_, ok := f.otherAddresses[a.EncodeAddress()]
+	_, ok := f.otherAddresses[a.EncodeAddress(true)]
 	return ok
 }
 
@@ -405,7 +405,7 @@ func (f *wsClientFilter) removeAddress(a cashutil.Address) {
 		}
 	}
 
-	delete(f.otherAddresses, a.EncodeAddress())
+	delete(f.otherAddresses, a.EncodeAddress(true))
 }
 
 // removeAddressStr parses an address from a string and then removes it from the
@@ -1006,7 +1006,7 @@ func (m *wsNotificationManager) notifyForTxOuts(ops map[wire.OutPoint]map[chan s
 		}
 
 		for _, txAddr := range txAddrs {
-			cmap, ok := addrs[txAddr.EncodeAddress()]
+			cmap, ok := addrs[txAddr.EncodeAddress(true)]
 			if !ok {
 				continue
 			}
@@ -2098,7 +2098,7 @@ func rescanBlock(wsc *wsClient, lookups *rescanKeys, blk *cashutil.Block) {
 				default:
 					// A new address type must have been added.  Encode as a
 					// payment address string and check the fallback map.
-					addrStr := addr.EncodeAddress()
+					addrStr := addr.EncodeAddress(true)
 					_, ok := lookups.fallbacks[addrStr]
 					if !ok {
 						continue