feat: upload btc execution metadata to ipfs

app/app.go

@@ -17,6 +17,7 @@ import (
 	"github.com/ChainSafe/sygma-relayer/chains"
 	"github.com/ChainSafe/sygma-relayer/chains/btc"
 	"github.com/ChainSafe/sygma-relayer/chains/btc/mempool"
+	"github.com/ChainSafe/sygma-relayer/chains/btc/uploader"
 	"github.com/ChainSafe/sygma-relayer/chains/evm"
 	"github.com/ChainSafe/sygma-relayer/chains/evm/calls/contracts/bridge"
 	"github.com/ChainSafe/sygma-relayer/chains/evm/calls/events"
@@ -331,6 +332,8 @@ func Run() error {
 
 				mempool := mempool.NewMempoolAPI(config.MempoolUrl)
 				mh := &btcExecutor.BtcMessageHandler{}
+				uploader := uploader.NewIPFSUploader(config.UploaderConfig)
+
 				executor := btcExecutor.NewExecutor(
 					propStore,
 					host,
@@ -341,7 +344,8 @@ func Run() error {
 					mempool,
 					resources,
 					config.Network,
-					exitLock)
+					exitLock,
+					uploader)
 
 				btcChain := btc.NewBtcChain(listener, executor, mh, *config.GeneralChainConfig.Id)
 				domains[*config.GeneralChainConfig.Id] = btcChain

chains/btc/config/config.go

@@ -32,18 +32,23 @@ type Resource struct {
 	Script     []byte
 }
 
+type UploaderConfig struct {
+	URL   string `mapstructure:"url" default:"https://api.pinata.cloud/pinning/pinFileToIPFS"`
+	Token string `mapstructure:"token" default:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySW5mb3JtYXRpb24iOnsiaWQiOiJkOTU2YTZiNC1mOWFlLTRmZDctYTc5My0zZTFmM2FjYzc4MjIiLCJlbWFpbCI6InRjYXIxMjEyOTNAZ21haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsInBpbl9wb2xpY3kiOnsicmVnaW9ucyI6W3siZGVzaXJlZFJlcGxpY2F0aW9uQ291bnQiOjEsImlkIjoiRlJBMSJ9LHsiZGVzaXJlZFJlcGxpY2F0aW9uQ291bnQiOjEsImlkIjoiTllDMSJ9XSwidmVyc2lvbiI6MX0sIm1mYV9lbmFibGVkIjpmYWxzZSwic3RhdHVzIjoiQUNUSVZFIn0sImF1dGhlbnRpY2F0aW9uVHlwZSI6InNjb3BlZEtleSIsInNjb3BlZEtleUtleSI6ImNkZDljZGFmYWJhOTYxMGYxNDdjIiwic2NvcGVkS2V5U2VjcmV0IjoiMGI0OTQ4NmZjMTYzNmQxZTIyZTE5OGFlZWViOGE2NmRjMDM4NmRmNWRlOTkyY2NlOTlkZDBiYzQ5YzBiODdmYSIsImV4cCI6MTc1MzM2MTkxN30.xP92Ts9661M3CjxIEKobZ_jwdIPmxb_m2POJ4mpNBss"`
+}
 type RawBtcConfig struct {
 	chain.GeneralChainConfig `mapstructure:",squash"`
-	Resources                []RawResource `mapstrcture:"resources"`
-	StartBlock               int64         `mapstructure:"startBlock"`
-	FeeAddress               string        `mapstructure:"feeAddress"`
-	Username                 string        `mapstructure:"username"`
-	Password                 string        `mapstructure:"password"`
-	BlockInterval            int64         `mapstructure:"blockInterval" default:"5"`
-	BlockRetryInterval       uint64        `mapstructure:"blockRetryInterval" default:"5"`
-	BlockConfirmations       int64         `mapstructure:"blockConfirmations" default:"10"`
-	Network                  string        `mapstructure:"network" default:"mainnet"`
-	MempoolUrl               string        `mapstructure:"mempoolUrl"`
+	Resources                []RawResource  `mapstrcture:"resources"`
+	StartBlock               int64          `mapstructure:"startBlock"`
+	FeeAddress               string         `mapstructure:"feeAddress"`
+	Username                 string         `mapstructure:"username"`
+	Password                 string         `mapstructure:"password"`
+	BlockInterval            int64          `mapstructure:"blockInterval" default:"5"`
+	BlockRetryInterval       uint64         `mapstructure:"blockRetryInterval" default:"5"`
+	BlockConfirmations       int64          `mapstructure:"blockConfirmations" default:"10"`
+	Network                  string         `mapstructure:"network" default:"mainnet"`
+	MempoolUrl               string         `mapstructure:"mempoolUrl"`
+	UploaderConfig           UploaderConfig `mapstructure:"uploaderConfig"`
 }
 
 func (c *RawBtcConfig) Validate() error {
@@ -79,6 +84,7 @@ type BtcConfig struct {
 	Script             []byte
 	MempoolUrl         string
 	Network            chaincfg.Params
+	UploaderConfig     UploaderConfig
 }
 
 // NewBtcConfig decodes and validates an instance of an BtcConfig from
@@ -152,6 +158,7 @@ func NewBtcConfig(chainConfig map[string]interface{}) (*BtcConfig, error) {
 		MempoolUrl:         c.MempoolUrl,
 		FeeAddress:         feeAddress,
 		Resources:          resources,
+		UploaderConfig:     c.UploaderConfig,
 	}
 	return config, nil
 }

chains/btc/config/config_test.go

@@ -113,6 +113,10 @@ func (s *NewBtcConfigTestSuite) Test_ValidConfig() {
 				Tweak:      "tweak",
 			},
 		},
+		"uploaderConfig": config.UploaderConfig{
+			URL:   "https://testIPFSProvider.com",
+			Token: "testToken",
+		},
 	}
 
 	actualConfig, err := config.NewBtcConfig(rawConfig)
@@ -143,5 +147,9 @@ func (s *NewBtcConfigTestSuite) Test_ValidConfig() {
 				FeeAmount:  big.NewInt(10000000),
 			},
 		},
+		UploaderConfig: config.UploaderConfig{
+			URL:   "https://testIPFSProvider.com",
+			Token: "testToken",
+		},
 	})
 }

chains/btc/executor/executor.go

@@ -10,6 +10,7 @@ import (
 	"github.com/ChainSafe/sygma-relayer/chains/btc/config"
 	"github.com/ChainSafe/sygma-relayer/chains/btc/connection"
 	"github.com/ChainSafe/sygma-relayer/chains/btc/mempool"
+	"github.com/ChainSafe/sygma-relayer/chains/btc/uploader"
 	"github.com/ChainSafe/sygma-relayer/comm"
 	"github.com/ChainSafe/sygma-relayer/store"
 	"github.com/ChainSafe/sygma-relayer/tss"
@@ -60,6 +61,7 @@ type Executor struct {
 	propMutex  sync.Mutex
 
 	exitLock *sync.RWMutex
+	uploader uploader.Uploader
 }
 
 func NewExecutor(
@@ -73,6 +75,7 @@ func NewExecutor(
 	resources map[[32]byte]config.Resource,
 	chainCfg chaincfg.Params,
 	exitLock *sync.RWMutex,
+	uploader uploader.Uploader,
 ) *Executor {
 	return &Executor{
 		propStorer:  propStorer,
@@ -85,6 +88,7 @@ func NewExecutor(
 		resources:   resources,
 		mempool:     mempool,
 		chainCfg:    chainCfg,
+		uploader:    uploader,
 	}
 }
 
@@ -273,6 +277,8 @@ func (e *Executor) rawTx(proposals []*BtcTransferProposal, resource config.Resou
 
 func (e *Executor) outputs(tx *wire.MsgTx, proposals []*BtcTransferProposal) (uint64, error) {
 	outputAmount := uint64(0)
+	var dataToUpload []map[string]interface{}
+
 	for _, prop := range proposals {
 		addr, err := btcutil.DecodeAddress(prop.Data.Recipient, &e.chainCfg)
 		if err != nil {
@@ -282,10 +288,33 @@ func (e *Executor) outputs(tx *wire.MsgTx, proposals []*BtcTransferProposal) (ui
 		if err != nil {
 			return 0, err
 		}
+
+		dataToUpload = append(dataToUpload, map[string]interface{}{
+			"sourceDomain": prop.Source,
+			"depositNonce": prop.Data.DepositNonce,
+		})
+
 		txOut := wire.NewTxOut(int64(prop.Data.Amount), destinationAddrByte)
 		tx.AddTxOut(txOut)
+
 		outputAmount += prop.Data.Amount
 	}
+
+	// Upload to IPFS
+	cid, err := e.uploader.Upload(dataToUpload)
+	if err != nil {
+		log.Error().Err(err).Msg("Error occured while uploading metadata to ipfs")
+	}
+
+	// Store the CID in OP_RETURN
+	opReturnData := []byte("syg_" + cid)
+	opReturnScript, err := txscript.NullDataScript(opReturnData)
+	if err != nil {
+		log.Error().Err(err).Msg("Error occured while constructiong OP_RETURN data")
+	}
+
+	opReturnOut := wire.NewTxOut(0, opReturnScript)
+	tx.AddTxOut(opReturnOut)
 	return outputAmount, nil
 }
 

chains/btc/uploader/ipfs.go

@@ -0,0 +1,81 @@
+package uploader
+
+import (
+	"bytes"
+	"encoding/json"
+	"io"
+	"mime/multipart"
+	"net/http"
+
+	"github.com/ChainSafe/sygma-relayer/chains/btc/config"
+)
+
+type Uploader interface {
+	Upload(proposals []map[string]interface{}) (string, error)
+}
+
+type IPFSUploader struct {
+	config config.UploaderConfig
+}
+
+func NewIPFSUploader(config config.UploaderConfig) *IPFSUploader {
+	return &IPFSUploader{config: config}
+}
+
+type IPFSResponse struct {
+	IpfsHash string `json:"IpfsHash"`
+}
+
+func (s *IPFSUploader) Upload(dataToUpload []map[string]interface{}) (string, error) {
+
+	// Convert proposals to JSON
+	jsonData, err := json.Marshal(dataToUpload)
+	if err != nil {
+		return "", err
+	}
+
+	// Create a multipart form file
+	body := new(bytes.Buffer)
+	writer := multipart.NewWriter(body)
+	part, err := writer.CreateFormFile("file", "metadata.json")
+	if err != nil {
+		return "", err
+	}
+	_, err = part.Write(jsonData)
+	if err != nil {
+		return "", err
+	}
+	writer.Close()
+
+	// Create a new request
+	req, err := http.NewRequest("POST", s.config.URL, body)
+	if err != nil {
+		return "", err
+	}
+
+	// Set the headers
+	req.Header.Add("Authorization", "Bearer "+s.config.Token)
+	req.Header.Add("Content-Type", writer.FormDataContentType())
+
+	// Make the request
+	client := &http.Client{}
+	resp, err := client.Do(req)
+	if err != nil {
+		return "", err
+	}
+	defer resp.Body.Close()
+
+	// Read the response
+	respBody, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return "", err
+	}
+
+	// Parse the response
+	var ipfsResponse IPFSResponse
+	if err := json.Unmarshal(respBody, &ipfsResponse); err != nil {
+		return "", err
+	}
+
+	return ipfsResponse.IpfsHash, nil
+}

example/app/app.go

@@ -14,10 +14,12 @@ import (
 
 	"github.com/ChainSafe/sygma-relayer/chains/btc"
 	"github.com/ChainSafe/sygma-relayer/chains/btc/mempool"
+	"github.com/ChainSafe/sygma-relayer/chains/btc/uploader"
 	substrateListener "github.com/ChainSafe/sygma-relayer/chains/substrate/listener"
 	substratePallet "github.com/ChainSafe/sygma-relayer/chains/substrate/pallet"
 	"github.com/ChainSafe/sygma-relayer/relayer/transfer"
 	propStore "github.com/ChainSafe/sygma-relayer/store"
+	"github.com/ChainSafe/sygma-relayer/tss"
 	"github.com/sygmaprotocol/sygma-core/chains/evm/listener"
 	"github.com/sygmaprotocol/sygma-core/chains/evm/transactor/gas"
 	"github.com/sygmaprotocol/sygma-core/chains/evm/transactor/transaction"
@@ -61,7 +63,6 @@ import (
 	"github.com/ChainSafe/sygma-relayer/config"
 	"github.com/ChainSafe/sygma-relayer/keyshare"
 	"github.com/ChainSafe/sygma-relayer/topology"
-	"github.com/ChainSafe/sygma-relayer/tss"
 	evmClient "github.com/sygmaprotocol/sygma-core/chains/evm/client"
 )
 
@@ -274,6 +275,7 @@ func Run() error {
 
 				mempool := mempool.NewMempoolAPI(config.MempoolUrl)
 				mh := &btcExecutor.BtcMessageHandler{}
+				uploader := uploader.NewIPFSUploader(config.UploaderConfig)
 				executor := btcExecutor.NewExecutor(
 					propStore,
 					host,
@@ -284,7 +286,8 @@ func Run() error {
 					mempool,
 					resources,
 					config.Network,
-					exitLock)
+					exitLock,
+					uploader)
 
 				btcChain := btc.NewBtcChain(listener, executor, mh, *config.GeneralChainConfig.Id)
 				chains[*config.GeneralChainConfig.Id] = btcChain