Merge pull request #753 from rsksmart/feature/GBI-2792

feat: add RSKIP 305 support

Author: Luisfc68

docker-compose/docker-compose.yml

@@ -97,8 +97,8 @@ services:
       - LBC_ADDR
       - RSK_BRIDGE_ADDR
       - RSK_REQUIRED_BRIDGE_CONFIRMATIONS
-      - IRIS_ACTIVATION_HEIGHT
       - ERP_KEYS
+      - USE_SEGWIT_FEDERATION
       - ACCOUNT_NUM
       - DAO_FEE_COLLECTOR_ADDRESS
       - KEY_SECRET

docker-compose/local/docker-compose.lps.yml

@@ -25,8 +25,8 @@ services:
       - LBC_ADDR
       - RSK_BRIDGE_ADDR
       - RSK_REQUIRED_BRIDGE_CONFIRMATIONS
-      - IRIS_ACTIVATION_HEIGHT
       - ERP_KEYS
+      - USE_SEGWIT_FEDERATION
       - ACCOUNT_NUM
       - DAO_FEE_COLLECTOR_ADDRESS
       - KEY_SECRET

docker-compose/mainnet/docker-compose.yml

@@ -41,8 +41,8 @@ services:
       - LBC_ADDR
       - RSK_BRIDGE_ADDR
       - RSK_REQUIRED_BRIDGE_CONFIRMATIONS
-      - IRIS_ACTIVATION_HEIGHT
       - ERP_KEYS
+      - USE_SEGWIT_FEDERATION
       - ACCOUNT_NUM
       - DAO_FEE_COLLECTOR_ADDRESS
       - KEY_SECRET

docs/Environment.md

@@ -23,8 +23,8 @@ These are the environment variables required by the liquidity provider server (L
 | `LBC_ADDR` | Address of the Liquidity Bridge Contract (LBC). | `0x8901a2Bbf639bFD21A97004BA4D7aE2BD00B8DA8` | YES |
 | `RSK_BRIDGE_ADDR` | Address of the Rootstock bridge. | `0x0000000000000000000000000000000001000006` | YES |
 | `RSK_REQUIRED_BRIDGE_CONFIRMATIONS` | The number of confirmations that need to pass before being able to register a pegin, it changes depending on the network. | `100` | YES |
-| `IRIS_ACTIVATION_HEIGHT` | Block number where the iris update is activated, depends on the network. | `1500000` | YES |
 | `ERP_KEYS` | Keys that are used as a secondary multisig that would be allowed to spend UTXOs after a year they were created. |`0216c23b2ea8e4f11c3f9e22711addb1d16a93964796913830856b568cc3ea21d3`,`0275562901dd8faae20de0a4166362a4f82188db77dbed4ca887422ea1ec185f14`,`034db69f2112f4fb1bb6141bf6e2bd6631f0484d0bd95b16767902c9fe219d4a6f` | YES |
+| `USE_SEGWIT_FEDERATION` | Wether to generate the federation address as a P2SH-P2WSH or not | true | NO |
 | `ACCOUNT_NUM` | The keystore account number to use. If not provided default value will be 0. | `0` | NO |
 | `DAO_FEE_COLLECTOR_ADDRESS` | Address of the DAO fee collector. | `0x86B6534687A176A476C16083a373fB9Fe4FAb449` | YES |
 | `KEY_SECRET` | Name of the secret of AWS secrets manager that contains the encrypted json of the liquidity provider RSK account. Only required if `SECRET_SRC` is `aws`. | `FlyoverTestEnv/LPS-KEY` | NO |

internal/adapters/dataproviders/bitcoin/scripts.go

@@ -0,0 +1,38 @@
+package bitcoin
+
+import (
+	"crypto/sha256"
+	"errors"
+	"github.com/btcsuite/btcd/btcutil"
+	"github.com/btcsuite/btcd/chaincfg"
+	"github.com/btcsuite/btcd/txscript"
+)
+
+func ScriptToP2shP2wsh(script []byte) ([]byte, error) {
+	if len(script) == 0 {
+		return nil, errors.New("script cannot be empty")
+	}
+
+	witnessScriptHash := sha256.Sum256(script)
+	segwitScript, err := txscript.NewScriptBuilder().
+		AddOp(txscript.OP_0).
+		AddData(witnessScriptHash[:]).
+		Script()
+	if err != nil {
+		return nil, err
+	}
+
+	return segwitScript, nil
+}
+
+func ScriptToAddressP2shP2wsh(script []byte, btcParams *chaincfg.Params) (*btcutil.AddressScriptHash, error) {
+	if btcParams == nil {
+		return nil, errors.New("bitcoin network parameters cannot be nil")
+	}
+	segwitScript, err := ScriptToP2shP2wsh(script)
+	if err != nil {
+		return nil, err
+	}
+
+	return btcutil.NewAddressScriptHash(segwitScript, btcParams)
+}

internal/adapters/dataproviders/bitcoin/scripts_test.go

@@ -0,0 +1,88 @@
+package bitcoin_test
+
+import (
+	"encoding/hex"
+	"github.com/btcsuite/btcd/chaincfg"
+	"github.com/rsksmart/liquidity-provider-server/internal/adapters/dataproviders/bitcoin"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"testing"
+)
+
+type ScriptEntry struct {
+	Name          string
+	ScriptHex     string
+	SegwitProgram string
+	P2SHP2WSHAddr string
+}
+
+var ScriptDataset = []ScriptEntry{
+	{
+		Name:          "2-of-3 Multisig",
+		ScriptHex:     "52210279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f817982103828d9817f20b62f5c8c6fba48e33cfad4b9a2ed81ebb57e947d48f5e9f0f5b1d21027d1fe0e10b7a65f2aa5c3b2e0f593c9f8db3c9f5a639146e0d8df0f0bdcb0a3653ae",
+		SegwitProgram: "00208bf61295ed4b6005a0452aa64873a49eabbc9204db0f5b51cf82c02805a3e6d9",
+		P2SHP2WSHAddr: "3BwNcbMRRbsQ2V3dT5GLZeos2FGLh46NAY",
+	},
+	{
+		Name:          "CSV",
+		ScriptHex:     "a9144733f37cf4db86fbc2efed2500b4f4e49f3120238763b175",
+		SegwitProgram: "002097dfc3e76a746db584e46036ab39e3473b4d7ce704da1f514e06be7a7056b110",
+		P2SHP2WSHAddr: "3KgrN1XJms8tGm9zkLuUWv7R4aP3h2oQSL",
+	},
+	{
+		Name:          "IF/ELSE",
+		ScriptHex:     "63210279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f8179867522103828d9817f20b62f5c8c6fba48e33cfad4b9a2ed81ebb57e947d48f5e9f0f5b1d68ac",
+		SegwitProgram: "00204f6f9370bd1dd3783180f01c78fc31bd03c5cb62fdbc48d6973362044ff36fe1",
+		P2SHP2WSHAddr: "3622fSbuttx3uVUwgHnRRPZeNtSRHQsQB8",
+	},
+}
+
+func TestScriptToAddressP2shP2wsh(t *testing.T) {
+	for _, test := range ScriptDataset {
+		t.Run("should parse "+test.Name, func(t *testing.T) {
+			script, err := hex.DecodeString(test.ScriptHex)
+			require.NoError(t, err)
+			result, err := bitcoin.ScriptToAddressP2shP2wsh(script, &chaincfg.MainNetParams)
+			require.NoError(t, err)
+			assert.Equal(t, test.P2SHP2WSHAddr, result.EncodeAddress())
+		})
+	}
+	t.Run("should return error for empty script", func(t *testing.T) {
+		const errorMsg = "script cannot be empty"
+		nilResult, nilErr := bitcoin.ScriptToAddressP2shP2wsh(nil, &chaincfg.MainNetParams)
+		emptyResult, emptyErr := bitcoin.ScriptToAddressP2shP2wsh([]byte{}, &chaincfg.MainNetParams)
+		require.ErrorContains(t, nilErr, errorMsg)
+		require.Error(t, emptyErr, errorMsg)
+		assert.Nil(t, nilResult)
+		assert.Nil(t, emptyResult)
+	})
+
+	t.Run("should return error for empty network params", func(t *testing.T) {
+		script, err := hex.DecodeString(ScriptDataset[0].ScriptHex)
+		require.NoError(t, err)
+		result, err := bitcoin.ScriptToAddressP2shP2wsh(script, nil)
+		assert.Nil(t, result)
+		assert.Error(t, err)
+	})
+}
+
+func TestScriptToP2shP2wsh(t *testing.T) {
+	for _, test := range ScriptDataset {
+		t.Run("should parse "+test.Name, func(t *testing.T) {
+			script, err := hex.DecodeString(test.ScriptHex)
+			require.NoError(t, err)
+			result, err := bitcoin.ScriptToP2shP2wsh(script)
+			require.NoError(t, err)
+			assert.Equal(t, test.SegwitProgram, hex.EncodeToString(result))
+		})
+	}
+	t.Run("should return error for empty script", func(t *testing.T) {
+		const errorMsg = "script cannot be empty"
+		nilResult, nilErr := bitcoin.ScriptToP2shP2wsh(nil)
+		emptyResult, emptyErr := bitcoin.ScriptToP2shP2wsh([]byte{})
+		require.ErrorContains(t, nilErr, errorMsg)
+		require.Error(t, emptyErr, errorMsg)
+		assert.Nil(t, nilResult)
+		assert.Nil(t, emptyResult)
+	})
+}

internal/adapters/dataproviders/rootstock/bridge.go

@@ -24,21 +24,21 @@ const registerCoinbaseTxGasLimit = 100000
 type rskBridgeImpl struct {
 	address               string
 	requiredConfirmations uint64
-	irisActivationHeight  int64
 	erpKeys               []string
 	contract              RskBridgeAdapter
 	client                RpcClientBinding
 	btcParams             *chaincfg.Params
 	retryParams           RetryParams
 	signer                TransactionSigner
 	miningTimeout         time.Duration
+	useSegwitFederation   bool
 }
 
 type RskBridgeConfig struct {
 	Address               string
 	RequiredConfirmations uint64
-	IrisActivationHeight  int64
 	ErpKeys               []string
+	UseSegwitFederation   bool
 }
 
 func NewRskBridgeImpl(
@@ -53,14 +53,14 @@ func NewRskBridgeImpl(
 	return &rskBridgeImpl{
 		address:               config.Address,
 		requiredConfirmations: config.RequiredConfirmations,
-		irisActivationHeight:  config.IrisActivationHeight,
 		erpKeys:               config.ErpKeys,
 		contract:              contract,
 		client:                client.client,
 		btcParams:             btcParams,
 		retryParams:           retryParams,
 		signer:                signer,
 		miningTimeout:         miningTimeout,
+		useSegwitFederation:   config.UseSegwitFederation,
 	}
 }
 
@@ -166,8 +166,8 @@ func (bridge *rskBridgeImpl) FetchFederationInfo() (rootstock.FederationInfo, er
 		PubKeys:              pubKeys,
 		FedAddress:           fedAddress,
 		ActiveFedBlockHeight: activeFedBlockHeight.Int64(),
-		IrisActivationHeight: bridge.irisActivationHeight,
 		ErpKeys:              bridge.erpKeys,
+		UseSegwit:            bridge.useSegwitFederation,
 	}, nil
 }
 

internal/adapters/dataproviders/rootstock/bridge_test.go

@@ -32,7 +32,7 @@ const (
 )
 
 func TestNewRskBridgeImpl(t *testing.T) {
-	config := rootstock.RskBridgeConfig{Address: test.AnyAddress, RequiredConfirmations: 10, IrisActivationHeight: 100, ErpKeys: []string{"key1", "key2", "key3"}}
+	config := rootstock.RskBridgeConfig{Address: test.AnyAddress, RequiredConfirmations: 10, ErpKeys: []string{"key1", "key2", "key3"}, UseSegwitFederation: true}
 	client := rootstock.NewRskClient(&mocks.RpcClientBindingMock{})
 	bridge := rootstock.NewRskBridgeImpl(config, &mocks.RskBridgeAdapterMock{}, client, &chaincfg.TestNet3Params, rootstock.RetryParams{Retries: 1, Sleep: time.Duration(1)}, &mocks.TransactionSignerMock{}, time.Duration(1))
 	test.AssertNonZeroValues(t, bridge)
@@ -52,7 +52,7 @@ func TestRskBridgeImpl_GetFedAddress(t *testing.T) {
 	t.Run("Success", func(t *testing.T) {
 		bridgeMock := &mocks.RskBridgeAdapterMock{}
 		bridgeMock.On("GetFederationAddress", mock.Anything).Return(test.AnyAddress, nil)
-		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{IrisActivationHeight: 100}, bridgeMock, dummyClient, nil, rootstock.RetryParams{}, nil, time.Duration(1))
+		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{}, bridgeMock, dummyClient, nil, rootstock.RetryParams{}, nil, time.Duration(1))
 		result, err := bridge.GetFedAddress()
 		assert.Equal(t, test.AnyAddress, result)
 		require.NoError(t, err)
@@ -61,7 +61,7 @@ func TestRskBridgeImpl_GetFedAddress(t *testing.T) {
 	t.Run("Error handling on GetFederationAddress call fail", func(t *testing.T) {
 		bridgeMock := &mocks.RskBridgeAdapterMock{}
 		bridgeMock.On("GetFederationAddress", mock.Anything).Return("", assert.AnError)
-		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{IrisActivationHeight: 100}, bridgeMock, dummyClient, nil, rootstock.RetryParams{}, nil, time.Duration(1))
+		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{}, bridgeMock, dummyClient, nil, rootstock.RetryParams{}, nil, time.Duration(1))
 		result, err := bridge.GetFedAddress()
 		assert.Empty(t, result)
 		require.Error(t, err)
@@ -72,7 +72,7 @@ func TestRskBridgeImpl_GetMinimumLockTxValue(t *testing.T) {
 	t.Run("Success", func(t *testing.T) {
 		bridgeMock := &mocks.RskBridgeAdapterMock{}
 		bridgeMock.On("GetMinimumLockTxValue", mock.Anything).Return(big.NewInt(5), nil)
-		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{IrisActivationHeight: 100}, bridgeMock, dummyClient, nil, rootstock.RetryParams{}, nil, time.Duration(1))
+		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{}, bridgeMock, dummyClient, nil, rootstock.RetryParams{}, nil, time.Duration(1))
 		result, err := bridge.GetMinimumLockTxValue()
 		assert.IsType(t, &entities.Wei{}, result)
 		assert.Equal(t, entities.NewWei(50000000000), result)
@@ -82,15 +82,15 @@ func TestRskBridgeImpl_GetMinimumLockTxValue(t *testing.T) {
 	t.Run("Error handling on GetMinimumLockTxValue call fail", func(t *testing.T) {
 		bridgeMock := &mocks.RskBridgeAdapterMock{}
 		bridgeMock.On("GetMinimumLockTxValue", mock.Anything).Return(nil, assert.AnError)
-		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{IrisActivationHeight: 100}, bridgeMock, dummyClient, nil, rootstock.RetryParams{}, nil, time.Duration(1))
+		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{}, bridgeMock, dummyClient, nil, rootstock.RetryParams{}, nil, time.Duration(1))
 		result, err := bridge.GetMinimumLockTxValue()
 		assert.Nil(t, result)
 		require.Error(t, err)
 	})
 }
 
 func TestRskBridgeImpl_GetFlyoverDerivationAddress(t *testing.T) {
-	const redeemScriptString = "522102cd53fc53a07f211641a677d250f6de99caf620e8e77071e811a28b3bcddf0be1210362634ab57dae9cb373a5d536e66a8c4f67468bbcfb063809bab643072d78a1242103c5946b3fbae03a654237da863c9ed534e0878657175b132b8ca630f245df04db53ae"
+	const redeemScriptString = "64522102cd53fc53a07f211641a677d250f6de99caf620e8e77071e811a28b3bcddf0be1210362634ab57dae9cb373a5d536e66a8c4f67468bbcfb063809bab643072d78a1242103c5946b3fbae03a654237da863c9ed534e0878657175b132b8ca630f245df04db53ae670350cd00b27553210257c293086c4d4fe8943deda5f890a37d11bebd140e220faa76258a41d077b4d42103c2660a46aa73078ee6016dee953488566426cf55fc8011edd0085634d75395f92103cd3e383ec6e12719a6c69515e5559bcbe037d0aa24c187e1e26ce932e22ad7b32102370a9838e4d15708ad14a104ee5606b36caaaaf739d833e67770ce9fd9b3ec8054ae68"
 	lbcAddress, err := hex.DecodeString("2ff74F841b95E000625b3A77fed03714874C4fEa")
 	require.NoError(t, err)
 	quoteHash, err := hex.DecodeString("4a3eca107f22707e5dbc79964f3e6c21ec5e354e0903391245d9fdbe6bd2b2f0")
@@ -106,7 +106,7 @@ func TestRskBridgeImpl_GetFlyoverDerivationAddress(t *testing.T) {
 		LpBtcAddress:         lpBtcAddress,
 		QuoteHash:            quoteHash,
 	}
-	args.FedInfo.FedAddress = "2N5muMepJizJE1gR7FbHJU6CD18V3BpNF9p"
+	args.FedInfo.FedAddress = "2NCxHG5oK8CWLDrBpTQq6pgKE8jyoB2DpTe"
 	t.Run("Success", func(t *testing.T) {
 		var testError error
 		var redeemScriptBytes []byte
@@ -115,11 +115,11 @@ func TestRskBridgeImpl_GetFlyoverDerivationAddress(t *testing.T) {
 		redeemScriptBytes, testError = hex.DecodeString(redeemScriptString)
 		require.NoError(t, testError)
 		bridgeMock.On("GetActivePowpegRedeemScript", mock.Anything).Return(redeemScriptBytes, nil)
-		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{IrisActivationHeight: 100}, bridgeMock, dummyClient, &chaincfg.TestNet3Params, rootstock.RetryParams{}, nil, time.Duration(1))
+		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{}, bridgeMock, dummyClient, &chaincfg.TestNet3Params, rootstock.RetryParams{}, nil, time.Duration(1))
 		result, testError = bridge.GetFlyoverDerivationAddress(args)
 		assert.Equal(t, rsk.FlyoverDerivation{
-			Address:      "2Mx7jaPHtsgJTbqGnjU5UqBpkekHgfigXay",
-			RedeemScript: "20ff883edd54f8cb22464a8181ed62652fcdb0028e0ada18f9828afd76e0df2c7275522102cd53fc53a07f211641a677d250f6de99caf620e8e77071e811a28b3bcddf0be1210362634ab57dae9cb373a5d536e66a8c4f67468bbcfb063809bab643072d78a1242103c5946b3fbae03a654237da863c9ed534e0878657175b132b8ca630f245df04db53ae",
+			Address:      "2MxeEHVx71taCeVsXFsfQ7TKK6v943PFVEu",
+			RedeemScript: "20ff883edd54f8cb22464a8181ed62652fcdb0028e0ada18f9828afd76e0df2c727564522102cd53fc53a07f211641a677d250f6de99caf620e8e77071e811a28b3bcddf0be1210362634ab57dae9cb373a5d536e66a8c4f67468bbcfb063809bab643072d78a1242103c5946b3fbae03a654237da863c9ed534e0878657175b132b8ca630f245df04db53ae670350cd00b27553210257c293086c4d4fe8943deda5f890a37d11bebd140e220faa76258a41d077b4d42103c2660a46aa73078ee6016dee953488566426cf55fc8011edd0085634d75395f92103cd3e383ec6e12719a6c69515e5559bcbe037d0aa24c187e1e26ce932e22ad7b32102370a9838e4d15708ad14a104ee5606b36caaaaf739d833e67770ce9fd9b3ec8054ae68",
 		}, result)
 		require.NoError(t, testError)
 		bridgeMock.AssertExpectations(t)
@@ -129,7 +129,7 @@ func TestRskBridgeImpl_GetFlyoverDerivationAddress(t *testing.T) {
 		var result rsk.FlyoverDerivation
 		bridgeMock := &mocks.RskBridgeAdapterMock{}
 		bridgeMock.On("GetActivePowpegRedeemScript", mock.Anything).Return(nil, assert.AnError)
-		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{IrisActivationHeight: 100}, bridgeMock, dummyClient, &chaincfg.TestNet3Params, rootstock.RetryParams{}, nil, time.Duration(1))
+		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{}, bridgeMock, dummyClient, &chaincfg.TestNet3Params, rootstock.RetryParams{}, nil, time.Duration(1))
 		result, testError = bridge.GetFlyoverDerivationAddress(args)
 		assert.Empty(t, result)
 		require.ErrorContains(t, testError, "error retreiving fed redeem script from bridge")
@@ -146,7 +146,7 @@ func TestRskBridgeImpl_FetchFederationInfo(t *testing.T) {
 		bridgeMock.On("GetFederationAddress", mock.Anything).Return(test.AnyAddress, nil).Once()
 		bridgeMock.On("GetActiveFederationCreationBlockHeight", mock.Anything).Return(big.NewInt(500), nil).Once()
 
-		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{IrisActivationHeight: 100, ErpKeys: []string{"key1", "key2", "key3"}},
+		bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{ErpKeys: []string{"key1", "key2", "key3"}, UseSegwitFederation: true},
 			bridgeMock, dummyClient, &chaincfg.TestNet3Params, rootstock.RetryParams{}, nil, time.Duration(1))
 		fedInfo, err := bridge.FetchFederationInfo()
 		require.NoError(t, err)
@@ -156,8 +156,8 @@ func TestRskBridgeImpl_FetchFederationInfo(t *testing.T) {
 			FedAddress:           test.AnyAddress,
 			PubKeys:              []string{"010203", "0a0b0c"},
 			ActiveFedBlockHeight: 500,
-			IrisActivationHeight: 100,
 			ErpKeys:              []string{"key1", "key2", "key3"},
+			UseSegwit:            true,
 		}, fedInfo)
 		bridgeMock.AssertExpectations(t)
 	})
@@ -166,7 +166,7 @@ func TestRskBridgeImpl_FetchFederationInfo(t *testing.T) {
 		for _, setUp := range fetchFedInfoErrorSetUps() {
 			bridgeMock := &mocks.RskBridgeAdapterMock{}
 			setUp(bridgeMock)
-			bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{IrisActivationHeight: 100}, bridgeMock, dummyClient, &chaincfg.TestNet3Params, rootstock.RetryParams{}, nil, time.Duration(1))
+			bridge := rootstock.NewRskBridgeImpl(rootstock.RskBridgeConfig{}, bridgeMock, dummyClient, &chaincfg.TestNet3Params, rootstock.RetryParams{}, nil, time.Duration(1))
 			result, err := bridge.FetchFederationInfo()
 			require.Error(t, err)
 			assert.Empty(t, result)