deposit_erc1155.go

package erc1155

import (
	"fmt"
	"math/big"
	"strings"

	"github.com/spf13/cobra"
	"github.com/umbracle/ethgo"

	"github.com/0xPolygon/polygon-edge/command"
	"github.com/0xPolygon/polygon-edge/command/bridge/common"
	"github.com/0xPolygon/polygon-edge/command/rootchain/helper"
	"github.com/0xPolygon/polygon-edge/consensus/polybft/contractsapi"
	helperCommon "github.com/0xPolygon/polygon-edge/helper/common"
	"github.com/0xPolygon/polygon-edge/txrelayer"
	"github.com/0xPolygon/polygon-edge/types"
)

type depositERC1155Params struct {
	*common.ERC1155BridgeParams
	minterKey string
}

var (
	// depositParams is abstraction for provided bridge parameter values
	dp *depositERC1155Params = &depositERC1155Params{ERC1155BridgeParams: common.NewERC1155BridgeParams()}
)

// GetCommand returns the bridge deposit command
func GetCommand() *cobra.Command {
	depositCmd := &cobra.Command{
		Use:     "deposit-erc1155",
		Short:   "Deposits ERC 1155 tokens from the origin to the destination chain",
		PreRunE: preRunCommand,
		Run:     runCommand,
	}

	dp.RegisterCommonFlags(depositCmd)

	depositCmd.Flags().StringSliceVar(
		&dp.Amounts,
		common.AmountsFlag,
		nil,
		"amounts that are sent to the receivers accounts",
	)

	depositCmd.Flags().StringSliceVar(
		&dp.TokenIDs,
		common.TokenIDsFlag,
		nil,
		"token ids that are sent to the receivers accounts",
	)

	depositCmd.Flags().StringVar(
		&dp.TokenAddr,
		common.RootTokenFlag,
		"",
		"root ERC 1155 token address",
	)

	depositCmd.Flags().StringVar(
		&dp.PredicateAddr,
		common.RootPredicateFlag,
		"",
		"root ERC 1155 token predicate address",
	)

	depositCmd.Flags().StringVar(
		&dp.minterKey,
		common.MinterKeyFlag,
		"",
		common.MinterKeyFlagDesc,
	)

	_ = depositCmd.MarkFlagRequired(common.ReceiversFlag)
	_ = depositCmd.MarkFlagRequired(common.AmountsFlag)
	_ = depositCmd.MarkFlagRequired(common.TokenIDsFlag)
	_ = depositCmd.MarkFlagRequired(common.RootTokenFlag)
	_ = depositCmd.MarkFlagRequired(common.RootPredicateFlag)

	return depositCmd
}

func preRunCommand(_ *cobra.Command, _ []string) error {
	return dp.Validate()
}

func runCommand(cmd *cobra.Command, _ []string) {
	outputter := command.InitializeOutputter(cmd)
	defer outputter.WriteOutput()

	depositorKey, err := helper.DecodePrivateKey(dp.SenderKey)
	if err != nil {
		outputter.SetError(fmt.Errorf("failed to initialize depositor private key: %w", err))
	}

	depositorAddr := depositorKey.Address()

	txRelayer, err := txrelayer.NewTxRelayer(txrelayer.WithIPAddress(dp.JSONRPCAddr))
	if err != nil {
		outputter.SetError(fmt.Errorf("failed to initialize tx relayer: %w", err))

		return
	}

	amounts := make([]*big.Int, len(dp.Amounts))
	tokenIDs := make([]*big.Int, len(dp.TokenIDs))

	for i := range dp.Receivers {
		amountRaw := dp.Amounts[i]
		tokenIDRaw := dp.TokenIDs[i]

		amount, err := helperCommon.ParseUint256orHex(&amountRaw)
		if err != nil {
			outputter.SetError(fmt.Errorf("failed to decode provided amount %s: %w", amountRaw, err))

			return
		}

		amounts[i] = amount

		tokenID, err := helperCommon.ParseUint256orHex(&tokenIDRaw)
		if err != nil {
			outputter.SetError(fmt.Errorf("failed to decode provided token id %s: %w", tokenIDRaw, err))

			return
		}

		tokenIDs[i] = tokenID
	}

	if dp.minterKey != "" {
		minterKey, err := helper.DecodePrivateKey(dp.minterKey)
		if err != nil {
			outputter.SetError(fmt.Errorf("invalid minter key provided: %w", err))

			return
		}

		// mint tokens to depositor, so he is able to send them
		mintTxn, err := createMintTxn(types.Address(depositorAddr), types.Address(depositorAddr), amounts, tokenIDs)
		if err != nil {
			outputter.SetError(fmt.Errorf("mint transaction creation failed: %w", err))

			return
		}

		receipt, err := txRelayer.SendTransaction(mintTxn, minterKey)
		if err != nil {
			outputter.SetError(fmt.Errorf("failed to send mint transaction to depositor %s: %w", depositorAddr, err))

			return
		}

		if receipt.Status == uint64(types.ReceiptFailed) {
			outputter.SetError(fmt.Errorf("failed to mint tokens to depositor %s", depositorAddr))

			return
		}
	}

	// approve root erc1155 predicate
	approveTxn, err := createApproveERC1155PredicateTxn(
		types.StringToAddress(dp.PredicateAddr),
		types.StringToAddress(dp.TokenAddr))
	if err != nil {
		outputter.SetError(fmt.Errorf("failed to create root erc 1155 approve transaction: %w", err))

		return
	}

	receipt, err := txRelayer.SendTransaction(approveTxn, depositorKey)
	if err != nil {
		outputter.SetError(fmt.Errorf("failed to send root erc 1155 approve transaction: %w", err))

		return
	}

	if receipt.Status == uint64(types.ReceiptFailed) {
		outputter.SetError(fmt.Errorf("failed to approve root erc 1155 predicate"))

		return
	}

	receivers := make([]ethgo.Address, len(dp.Receivers))
	for i, receiverRaw := range dp.Receivers {
		receivers[i] = ethgo.Address(types.StringToAddress(receiverRaw))
	}

	// deposit tokens
	depositTxn, err := createDepositTxn(depositorAddr, receivers, amounts, tokenIDs)
	if err != nil {
		outputter.SetError(fmt.Errorf("failed to create tx input: %w", err))

		return
	}

	receipt, err = txRelayer.SendTransaction(depositTxn, depositorKey)
	if err != nil {
		outputter.SetError(fmt.Errorf("sending deposit transactions failed (receivers: %s, amount: %s): %w",
			strings.Join(dp.Receivers, ", "), strings.Join(dp.Amounts, ", "), err))

		return
	}

	if receipt.Status == uint64(types.ReceiptFailed) {
		outputter.SetError(fmt.Errorf("sending deposit transactions failed (receivers: %s, amounts: %s)",
			strings.Join(dp.Receivers, ", "), strings.Join(dp.Amounts, ", ")))

		return
	}

	res := &common.BridgeTxResult{
		Sender:       depositorAddr.String(),
		Receivers:    dp.Receivers,
		Amounts:      dp.Amounts,
		TokenIDs:     dp.TokenIDs,
		BlockNumbers: []uint64{receipt.BlockNumber},
		Title:        "DEPOSIT ERC 1155",
	}

	if dp.ChildChainMintable {
		exitEventIDs, err := common.ExtractExitEventIDs(receipt)
		if err != nil {
			outputter.SetError(fmt.Errorf("failed to extract exit event: %w", err))

			return
		}

		res.ExitEventIDs = exitEventIDs
	}

	// populate child token address if a token is mapped alongside with deposit
	childToken, err := common.ExtractChildTokenAddr(receipt, dp.ChildChainMintable)
	if err != nil {
		outputter.SetError(fmt.Errorf("failed to extract child token address: %w", err))

		return
	}

	res.ChildTokenAddr = childToken

	outputter.SetCommandResult(res)
}

// createDepositTxn encodes parameters for deposit function on rootchain predicate contract
func createDepositTxn(sender ethgo.Address, receivers []ethgo.Address,
	amounts, tokenIDs []*big.Int) (*ethgo.Transaction, error) {
	depositBatchFn := &contractsapi.DepositBatchRootERC1155PredicateFn{
		RootToken: types.StringToAddress(dp.TokenAddr),
		Receivers: receivers,
		TokenIDs:  tokenIDs,
		Amounts:   amounts,
	}

	input, err := depositBatchFn.EncodeAbi()
	if err != nil {
		return nil, fmt.Errorf("failed to encode provided parameters: %w", err)
	}

	addr := ethgo.Address(types.StringToAddress(dp.PredicateAddr))

	return helper.CreateTransaction(sender, &addr, input,
		nil, !dp.ChildChainMintable), nil
}

// createMintTxn encodes parameters for mint function on rootchain token contract
func createMintTxn(sender, receiver types.Address, amounts, tokenIDs []*big.Int) (*ethgo.Transaction, error) {
	mintFn := &contractsapi.MintBatchRootERC1155Fn{
		To:      receiver,
		Amounts: amounts,
		IDs:     tokenIDs,
	}

	input, err := mintFn.EncodeAbi()
	if err != nil {
		return nil, fmt.Errorf("failed to encode provided parameters: %w", err)
	}

	addr := ethgo.Address(types.StringToAddress(dp.TokenAddr))

	return helper.CreateTransaction(ethgo.Address(sender), &addr,
		input, nil, !dp.ChildChainMintable), nil
}

// createApproveERC1155PredicateTxn sends approve transaction
// to ERC1155 token for ERC1155 predicate so that it is able to spend given tokens
func createApproveERC1155PredicateTxn(rootERC1155Predicate,
	rootERC1155Token types.Address) (*ethgo.Transaction, error) {
	approveFnParams := &contractsapi.SetApprovalForAllRootERC1155Fn{
		Operator: rootERC1155Predicate,
		Approved: true,
	}

	input, err := approveFnParams.EncodeAbi()
	if err != nil {
		return nil, fmt.Errorf("failed to encode parameters for RootERC1155.setApprovalForAll. error: %w", err)
	}

	addr := ethgo.Address(rootERC1155Token)

	return helper.CreateTransaction(ethgo.ZeroAddress, &addr,
		input, nil, !dp.ChildChainMintable), nil
}