Merge pull request #863 from rsksmart/feature/FLY-807

Feature/FLY-807 - Emergency pause functionality

Author: Luisfc68

.mockery.yaml

@@ -40,6 +40,8 @@ packages:
       DefaultCredentialsProvider:
   github.com/rsksmart/liquidity-provider-server/internal/adapters/entrypoints/rest/handlers:
     interfaces:
+      ResignUseCase:
+      AcceptQuoteUseCase:
       GetAssetsReportUseCase:
       PeginStatusUseCase:
       PegoutStatusUseCase:
@@ -64,6 +66,7 @@ packages:
         PegConfiguration:
   github.com/rsksmart/liquidity-provider-server/internal/entities/blockchain:
     interfaces:
+      Pausable:
       BitcoinWallet:
       RootstockRpcServer:
       PeginContract:

internal/adapters/dataproviders/rootstock/bindings.go

@@ -46,7 +46,16 @@ type RskBridgeBinding interface {
 	FilterBatchPegoutCreated(opts *bind.FilterOpts, btcTxHash [][32]byte) (*bindings.RskBridgeBatchPegoutCreatedIterator, error)
 }
 
+type PausableBinding interface {
+	PauseStatus(opts *bind.CallOpts) (struct {
+		IsPaused bool
+		Reason   string
+		Since    uint64
+	}, error)
+}
+
 type PegoutBinding interface {
+	PausableBinding
 	HashPegOutQuote(opts *bind.CallOpts, quote bindings.QuotesPegOutQuote) ([32]byte, error)
 	RefundPegOut(opts *bind.TransactOpts, quoteHash [32]byte, btcTx []byte, btcBlockHeaderHash [32]byte, partialMerkleTree *big.Int, merkleBranchHashes [][32]byte) (*types.Transaction, error)
 	FilterPegOutDeposit(opts *bind.FilterOpts, quoteHash [][32]byte, sender []common.Address, timestamp []*big.Int) (*bindings.IPegOutPegOutDepositIterator, error)
@@ -63,6 +72,7 @@ type PegoutContractAdapter interface {
 }
 
 type PeginBinding interface {
+	PausableBinding
 	HashPegInQuote(opts *bind.CallOpts, quote bindings.QuotesPegInQuote) ([32]byte, error)
 	RegisterPegIn(opts *bind.TransactOpts, quote bindings.QuotesPegInQuote, signature []byte, btcRawTransaction []byte, partialMerkleTree []byte, height *big.Int) (*types.Transaction, error)
 	CallForUser(opts *bind.TransactOpts, quote bindings.QuotesPegInQuote) (*types.Transaction, error)
@@ -76,6 +86,7 @@ type PeginContractAdapter interface {
 }
 
 type DiscoveryBinding interface {
+	PausableBinding
 	IsOperational(opts *bind.CallOpts, providerType uint8, addr common.Address) (bool, error)
 	GetProviders(opts *bind.CallOpts) ([]bindings.FlyoverLiquidityProvider, error)
 	GetProvider(opts *bind.CallOpts, providerAddress common.Address) (bindings.FlyoverLiquidityProvider, error)
@@ -86,6 +97,7 @@ type DiscoveryBinding interface {
 }
 
 type CollateralManagementBinding interface {
+	PausableBinding
 	FilterPenalized(opts *bind.FilterOpts, liquidityProvider []common.Address, punisher []common.Address, quoteHash [][32]byte) (*bindings.ICollateralManagementPenalizedIterator, error)
 	Resign(opts *bind.TransactOpts) (*types.Transaction, error)
 	GetPegInCollateral(opts *bind.CallOpts, addr common.Address) (*big.Int, error)

internal/adapters/dataproviders/rootstock/bindings/flyover_contracts.go

@@ -240,3 +240,12 @@ func (collateral *collateralManagementContractImpl) GetPenalizedEvents(ctx conte
 	}
 	return result, nil
 }
+
+func (collateral *collateralManagementContractImpl) PausedStatus() (blockchain.PauseStatus, error) {
+	opts := new(bind.CallOpts)
+	return rskRetry(
+		collateral.retryParams.Retries,
+		collateral.retryParams.Sleep,
+		func() (blockchain.PauseStatus, error) { return collateral.contract.PauseStatus(opts) },
+	)
+}

internal/adapters/dataproviders/rootstock/collateral_management_contract.go

@@ -8,6 +8,7 @@ import (
 	"github.com/rsksmart/liquidity-provider-server/internal/adapters/dataproviders/rootstock"
 	"github.com/rsksmart/liquidity-provider-server/internal/adapters/dataproviders/rootstock/bindings"
 	"github.com/rsksmart/liquidity-provider-server/internal/entities"
+	"github.com/rsksmart/liquidity-provider-server/internal/entities/blockchain"
 	"github.com/rsksmart/liquidity-provider-server/internal/entities/penalization"
 	"github.com/rsksmart/liquidity-provider-server/test"
 	"github.com/rsksmart/liquidity-provider-server/test/mocks"
@@ -364,3 +365,29 @@ func TestLiquidityBridgeContractImpl_GetPunishmentEvents(t *testing.T) {
 		iteratorMock.AssertExpectations(t)
 	})
 }
+
+func TestCollateralManagementContractImpl_PausedStatus(t *testing.T) {
+	contractBinding := new(mocks.CollateralManagementAdapterMock)
+	contract := rootstock.NewCollateralManagementContractImpl(dummyClient, test.AnyRskAddress, test.AnyAddress, contractBinding, nil, rootstock.RetryParams{}, time.Duration(1), Abis)
+	t.Run("should return pause status result", func(t *testing.T) {
+		contractBinding.EXPECT().PauseStatus(mock.Anything).Return(struct {
+			IsPaused bool
+			Reason   string
+			Since    uint64
+		}{IsPaused: true, Reason: "test", Since: 123}, nil).Once()
+		result, err := contract.PausedStatus()
+		require.NoError(t, err)
+		assert.Equal(t, blockchain.PauseStatus{IsPaused: true, Reason: "test", Since: 123}, result)
+	})
+	t.Run("should handle error checking pause status", func(t *testing.T) {
+		contractBinding.EXPECT().PauseStatus(mock.Anything).Return(struct {
+			IsPaused bool
+			Reason   string
+			Since    uint64
+		}{}, assert.AnError).Once()
+		result, err := contract.PausedStatus()
+		require.Error(t, err)
+		assert.Empty(t, result)
+	})
+	contractBinding.AssertExpectations(t)
+}

internal/adapters/dataproviders/rootstock/collateral_management_contract_test.go

@@ -212,6 +212,15 @@ func (discovery *discoveryContractImpl) IsOperational(providerType liquidity_pro
 		})
 }
 
+func (discovery *discoveryContractImpl) PausedStatus() (blockchain.PauseStatus, error) {
+	opts := new(bind.CallOpts)
+	return rskRetry(
+		discovery.retryParams.Retries,
+		discovery.retryParams.Sleep,
+		func() (blockchain.PauseStatus, error) { return discovery.contract.PauseStatus(opts) },
+	)
+}
+
 func (discovery *discoveryContractImpl) toContractProviderType(providerType liquidity_provider.ProviderType) (uint8, error) {
 	if !providerType.IsValid() {
 		return 0, liquidity_provider.InvalidProviderTypeError

internal/adapters/dataproviders/rootstock/discovery_contract.go

@@ -435,3 +435,29 @@ func TestDiscoveryContractImpl_IsOperational(t *testing.T) {
 		})
 	})
 }
+
+func TestDiscoveryContractImpl_PausedStatus(t *testing.T) {
+	contractBinding := &mocks.DiscoveryBindingMock{}
+	discovery := rootstock.NewDiscoveryContractImpl(dummyClient, test.AnyAddress, contractBinding, nil, rootstock.RetryParams{}, time.Duration(1), Abis)
+	t.Run("should return pause status result", func(t *testing.T) {
+		contractBinding.EXPECT().PauseStatus(mock.Anything).Return(struct {
+			IsPaused bool
+			Reason   string
+			Since    uint64
+		}{IsPaused: true, Reason: "test", Since: 123}, nil).Once()
+		result, err := discovery.PausedStatus()
+		require.NoError(t, err)
+		assert.Equal(t, blockchain.PauseStatus{IsPaused: true, Reason: "test", Since: 123}, result)
+	})
+	t.Run("should handle error checking pause status", func(t *testing.T) {
+		contractBinding.EXPECT().PauseStatus(mock.Anything).Return(struct {
+			IsPaused bool
+			Reason   string
+			Since    uint64
+		}{}, assert.AnError).Once()
+		result, err := discovery.PausedStatus()
+		require.Error(t, err)
+		assert.Empty(t, result)
+	})
+	contractBinding.AssertExpectations(t)
+}

internal/adapters/dataproviders/rootstock/discovery_contract_test.go

@@ -240,6 +240,15 @@ func (peginContract *peginContractImpl) RegisterPegin(params blockchain.Register
 	return transactionReceipt, nil
 }
 
+func (peginContract *peginContractImpl) PausedStatus() (blockchain.PauseStatus, error) {
+	opts := new(bind.CallOpts)
+	return rskRetry(
+		peginContract.retryParams.Retries,
+		peginContract.retryParams.Sleep,
+		func() (blockchain.PauseStatus, error) { return peginContract.contract.PauseStatus(opts) },
+	)
+}
+
 // parsePeginQuote parses a quote.PeginQuote into a bindings.QuotesPegInQuote. All BTC address fields support all address types
 // except for FedBtcAddress which must be a P2SH address.
 func parsePeginQuote(peginQuote quote.PeginQuote) (bindings.QuotesPegInQuote, error) {

internal/adapters/dataproviders/rootstock/pegin_contract.go

@@ -425,3 +425,29 @@ func TestPeginContractImpl_RegisterPegin_ErrorHandling(t *testing.T) {
 		assert.Empty(t, result)
 	})
 }
+
+func TestPeginContractImpl_PausedStatus(t *testing.T) {
+	contractBinding := &mocks.PeginContractAdapterMock{}
+	contract := rootstock.NewPeginContractImpl(dummyClient, test.AnyAddress, contractBinding, nil, rootstock.RetryParams{}, time.Duration(1), Abis)
+	t.Run("should return pause status result", func(t *testing.T) {
+		contractBinding.EXPECT().PauseStatus(mock.Anything).Return(struct {
+			IsPaused bool
+			Reason   string
+			Since    uint64
+		}{IsPaused: true, Reason: "test", Since: 123}, nil).Once()
+		result, err := contract.PausedStatus()
+		require.NoError(t, err)
+		assert.Equal(t, blockchain.PauseStatus{IsPaused: true, Reason: "test", Since: 123}, result)
+	})
+	t.Run("should handle error checking pause status", func(t *testing.T) {
+		contractBinding.EXPECT().PauseStatus(mock.Anything).Return(struct {
+			IsPaused bool
+			Reason   string
+			Since    uint64
+		}{}, assert.AnError).Once()
+		result, err := contract.PausedStatus()
+		require.Error(t, err)
+		assert.Empty(t, result)
+	})
+	contractBinding.AssertExpectations(t)
+}

internal/adapters/dataproviders/rootstock/pegin_contract_test.go

@@ -280,6 +280,15 @@ func (pegoutContract *pegoutContractImpl) GetDepositEvents(ctx context.Context,
 	return result, nil
 }
 
+func (pegoutContract *pegoutContractImpl) PausedStatus() (blockchain.PauseStatus, error) {
+	opts := new(bind.CallOpts)
+	return rskRetry(
+		pegoutContract.retryParams.Retries,
+		pegoutContract.retryParams.Sleep,
+		func() (blockchain.PauseStatus, error) { return pegoutContract.contract.PauseStatus(opts) },
+	)
+}
+
 // parsePegoutQuote parses a quote.PegoutQuote into a bindings.QuotesPegOutQuote. All BTC address fields support all address types.
 func parsePegoutQuote(pegoutQuote quote.PegoutQuote) (bindings.QuotesPegOutQuote, error) {
 	var parsedQuote bindings.QuotesPegOutQuote