feat(osmosis): Outpost types, errors, and unit tests

CHANGELOG.md

@@ -77,6 +77,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 - (stride-outpost) [#1931](https://github.com/evmos/evmos/pull/1931) Add Stride unit testing setup.
 - (stride-outpost) [#1932](https://github.com/evmos/evmos/pull/1932) Add transaction implementation and events unit tests.
 - (stride-outpost) [#1935](https://github.com/evmos/evmos/pull/1935) Refactor RedeemStake method.
+- (osmosis-outpost) [#1921](https://github.com/evmos/evmos/pull/1921) Add Osmosis outpost types and errors.
 
 ### Bug Fixes
 

go.mod

@@ -13,6 +13,7 @@ require (
 	github.com/btcsuite/btcd/btcutil v1.1.3
 	github.com/cometbft/cometbft v0.37.3-0.20230920093934-46df7b597e3c
 	github.com/cometbft/cometbft-db v0.8.0
+	github.com/cosmos/btcutil v1.0.5
 	github.com/cosmos/cosmos-proto v1.0.0-beta.3
 	github.com/cosmos/cosmos-sdk v0.47.5
 	github.com/cosmos/go-bip39 v1.0.0
@@ -91,7 +92,6 @@ require (
 	github.com/coinbase/rosetta-sdk-go/types v1.0.0 // indirect
 	github.com/confio/ics23/go v0.9.0 // indirect
 	github.com/containerd/continuity v0.3.0 // indirect
-	github.com/cosmos/btcutil v1.0.5 // indirect
 	github.com/cosmos/gogogateway v1.2.0 // indirect
 	github.com/cosmos/iavl v0.21.0-alpha.1.0.20230904092046-df3db2d96583 // indirect
 	github.com/cosmos/ics23/go v0.10.0 // indirect

precompiles/outposts/osmosis/IOsmosisOutpost.sol

@@ -65,7 +65,7 @@ interface IOsmosisOutpost {
         address input,
         address output,
         uint256 amount,
-        string calldata slippage_percentage,
+        uint8 slippage_percentage,
         uint64 window_seconds,
         string calldata receiver
     ) external returns (bool success);

precompiles/outposts/osmosis/abi.json

@@ -108,9 +108,9 @@
 				"type": "uint256"
 			},
 			{
-				"internalType": "string",
+				"internalType": "uint8",
 				"name": "slippage_percentage",
-				"type": "string"
+				"type": "uint8"
 			},
 			{
 				"internalType": "uint64",

precompiles/outposts/osmosis/errors.go

@@ -0,0 +1,29 @@
+// Copyright Tharsis Labs Ltd.(Evmos)
+// SPDX-License-Identifier:ENCL-1.0(https://github.com/evmos/evmos/blob/main/LICENSE)
+
+package osmosis
+
+import "fmt"
+
+var (
+	// ErrEmptyReceiver is raised when the receiver used in the memo is an
+	// empty string.
+	ErrEmptyReceiver = "receiver address cannot be an empty"
+	// ErrEmptyOnFailedDelivery is raised when the onFailedDeliver field of the
+	// IBC memo is an empty string.
+	ErrEmptyOnFailedDelivery = "onFailedDelivery cannot be empty"
+	// ErrTokenPairNotFound is raised when input and output tokens are the same.
+	ErrInputEqualOutput = "input and output token cannot be the same"
+	// ErrMaxSlippagePercentage is raised when the requested slippage percentage is
+	// higher than a pre-defined amount.
+	ErrSlippagePercentage = fmt.Sprintf("slippage percentage must be: 0 < slippagePercentage <= %d", MaxSlippagePercentage)
+	// ErrMaxWindowSeconds is raised when the requested window seconds is
+	// higher than a pre-defined amount.
+	ErrWindowSeconds = fmt.Sprintf("window seconds must be: 0 < windowSeconds <= %d", MaxWindowSeconds)
+	// ErrTokenPairNotFound is raised when a token pair for a certain address
+	// is not found and it is required by the executing function.
+	ErrTokenPairNotFound = "token pair for address %s not found"
+	// ErrInputTokenNotSupported is raised when a the osmosis outpost receive a non supported
+	// input token for the swap.
+	ErrInputTokenNotSupported = "input not supported, supported tokens: %v" //#nosec G101 -- no hardcoded credentials here
+)

precompiles/outposts/osmosis/osmosis.go

@@ -32,8 +32,8 @@ var _ vm.PrecompiledContract = &Precompile{}
 //go:embed abi.json
 var f embed.FS
 
-// / Precompile is the structure that define the Osmosis outpost precompiles extending
-// / the common Precompile type.
+// Precompile is the structure that define the Osmosis outpost precompile extending
+// the common Precompile type.
 type Precompile struct {
 	cmn.Precompile
 	// IBC

precompiles/outposts/osmosis/tx.go

@@ -1,6 +1,8 @@
 // Copyright Tharsis Labs Ltd.(Evmos)
 // SPDX-License-Identifier:ENCL-1.0(https://github.com/evmos/evmos/blob/main/LICENSE)
-
+// Osmosis package contains the logic of the Osmosis outpost on the Evmos chain.
+// This outpost uses the ics20 precompile to relay IBC packets to the Osmosis
+// chain, targeting the XCSV
 package osmosis
 
 import (

precompiles/outposts/osmosis/types.go

@@ -0,0 +1,224 @@
+// Copyright Tharsis Labs Ltd.(Evmos)
+// SPDX-License-Identifier:ENCL-1.0(https://github.com/evmos/evmos/blob/main/LICENSE)
+
+package osmosis
+
+import (
+	"encoding/json"
+	"fmt"
+	"math/big"
+
+	"github.com/cosmos/cosmos-sdk/types/address"
+	// "golang.org/x/exp/slices"
+
+	"github.com/cosmos/btcutil/bech32"
+	// transfertypes "github.com/cosmos/ibc-go/v7/modules/apps/transfer/types"
+	"github.com/ethereum/go-ethereum/common"
+	cmn "github.com/evmos/evmos/v15/precompiles/common"
+)
+
+const (
+	/// MaxSlippagePercentage is the maximum slippage percentage that can be used in the
+	/// definition of the slippage for the swap.
+	MaxSlippagePercentage uint8 = 20
+	/// MaxWindowSeconds is the maximum number of seconds that can be used in the
+	/// definition of the slippage for the swap.
+	MaxWindowSeconds uint64 = 60
+)
+
+const (
+	// OsmosisDenom is the base denom in the Osmosis chain.
+	OsmosisDenom = "uosmo"
+)
+
+// Twap represents a Time-Weighted Average Price configuration.
+type Twap struct {
+	// SlippagePercentage specifies the acceptable slippage percentage for a transaction.
+	SlippagePercentage uint8 `json:"slippage_percentage"`
+	// WindowSeconds defines the duration for which the TWAP is calculated.
+	WindowSeconds uint64 `json:"window_seconds"`
+}
+
+// Slippage specify how to compute the slippage of the swap. For this version of the outpost
+// only the TWAP is allowed.
+type Slippage struct {
+	Twap *Twap `json:"twap"`
+}
+
+// OsmosisSwap represents the details for a swap transaction on the Osmosis chain
+// using the XCS V2 contract. This payload is one of the variant of the entry_point Execute
+// in the CosmWasm contract.
+//
+//nolint:revive
+type OsmosisSwap struct {
+	// OutputDenom specifies the desired output denomination for the swap.
+	OutputDenom string `json:"output_denom"`
+	// Twap represents the TWAP configuration for the swap.
+	Slippage *Slippage `json:"slippage"`
+	// Receiver is the address of the entity receiving the swapped amount.
+	Receiver string `json:"receiver"`
+	// OnFailedDelivery specifies the action to be taken in case the swap delivery fails.
+	// This can be "do_nothing" or the address on the Osmosis chain that can recover funds
+	// in case of errors.
+	OnFailedDelivery string `json:"on_failed_delivery"`
+	// NextMemo contains any additional memo information for the next operation in a PFM setting.
+	NextMemo string `json:"next_memo,omitempty"`
+}
+
+// Msg contains the OsmosisSwap details used in the memo relayed to the Osmosis ibc hook middleware.
+type Msg struct {
+	// OsmosisSwap provides details for a swap transaction. It's optional and can be omitted if not provided.
+	OsmosisSwap *OsmosisSwap `json:"osmosis_swap"`
+}
+
+// Memo wraps the message details for the IBC packet relyaed to the Osmosis chain. This include the
+// address of the smart contract that will receive the Msg.
+type Memo struct {
+	// Contract represents the address or identifier of the contract to be called.
+	Contract string `json:"contract"`
+	// Msg contains the details of the operation to be executed on the contract.
+	Msg *Msg `json:"msg"`
+}
+
+// RawPacketMetadata is the raw packet metadata used to construct a JSON string.
+type RawPacketMetadata struct {
+	// The Osmosis outpost IBC memo.
+	Memo *Memo `json:"memo"`
+}
+
+// CreatePacketWithMemo creates the IBC packet with the memo for the Osmosis
+// outpost that can be parsed by the ibc hook middleware on the Osmosis chain.
+func CreatePacketWithMemo(
+	outputDenom, receiver, contract string,
+	slippagePercentage uint8,
+	windowSeconds uint64,
+	onFailedDelivery, nextMemo string,
+) *RawPacketMetadata {
+	return &RawPacketMetadata{
+		&Memo{
+			Contract: contract,
+			Msg: &Msg{
+				OsmosisSwap: &OsmosisSwap{
+					OutputDenom: outputDenom,
+					Slippage: &Slippage{
+						&Twap{
+							SlippagePercentage: slippagePercentage,
+							WindowSeconds:      windowSeconds,
+						},
+					},
+					Receiver:         receiver,
+					OnFailedDelivery: onFailedDelivery,
+					NextMemo:         nextMemo,
+				},
+			},
+		},
+	}
+}
+
+// ConvertToJSON convert the RawPacketMetadata type into a JSON formatted
+// string.
+func (r RawPacketMetadata) String() string {
+	// Convert the struct to a JSON string
+	jsonBytes, err := json.MarshalIndent(r, "", "  ")
+	if err != nil {
+		return ""
+	}
+
+	return string(jsonBytes)
+}
+
+// Validate performs basic validation of the IBC memo for the Osmosis outpost.
+// This function assumes that memo field are parsed with ParseSwapPacketData, which
+// performs data casting ensuring outputDenom cannot be an empty string.
+func (m Memo) Validate() error {
+	osmosisSwap := m.Msg.OsmosisSwap
+
+	if osmosisSwap.OnFailedDelivery == "" {
+		return fmt.Errorf(ErrEmptyOnFailedDelivery)
+	}
+
+	// Check if account is a valid bech32 address
+	_, _, err := bech32.Decode(osmosisSwap.Receiver, address.MaxAddrLen)
+	if err != nil {
+		return err
+	}
+
+	if osmosisSwap.Slippage.Twap.SlippagePercentage == 0 || osmosisSwap.Slippage.Twap.SlippagePercentage > MaxSlippagePercentage {
+		return fmt.Errorf(ErrSlippagePercentage)
+	}
+
+	if osmosisSwap.Slippage.Twap.WindowSeconds == 0 || osmosisSwap.Slippage.Twap.WindowSeconds > MaxWindowSeconds {
+		return fmt.Errorf(ErrWindowSeconds)
+	}
+
+	return nil
+}
+
+// func tmpValidate() {
+// 	if osmosisSwap.OutputDenom == input {
+// 		return fmt.Errorf(ErrInputEqualOutput, input)
+// 	}
+//
+// 	osmoIBCDenom := transfertypes.DenomTrace{
+// 		Path:      fmt.Sprintf("%s/%s", portID, channelID),
+// 		BaseDenom: OsmosisDenom,
+// 	}.IBCDenom()
+//
+// 	// Check that the input token is evmos or osmo.
+// 	// This constraint will be removed in future
+// 	validInput := []string{stakingDenom, osmoIBCDenom}
+// 	if !slices.Contains(validInput, input) {
+// 		return fmt.Errorf(ErrInputTokenNotSupported, validInput)
+// 	}
+// }
+
+// ParseSwapPacketData parses the packet data for the Osmosis swap function.
+func ParseSwapPacketData(args []interface{}) (
+	sender, input, output common.Address,
+	amount *big.Int,
+	slippagePercentage uint8,
+	windowSeconds uint64,
+	receiver string,
+	err error,
+) {
+	if len(args) != 7 {
+		return common.Address{}, common.Address{}, common.Address{}, nil, 0, 0, "", fmt.Errorf(cmn.ErrInvalidNumberOfArgs, 7, len(args))
+	}
+
+	sender, ok := args[0].(common.Address)
+	if !ok {
+		return common.Address{}, common.Address{}, common.Address{}, nil, 0, 0, "", fmt.Errorf(cmn.ErrInvalidType, "sender", common.Address{}, args[0])
+	}
+
+	input, ok = args[1].(common.Address)
+	if !ok {
+		return common.Address{}, common.Address{}, common.Address{}, nil, 0, 0, "", fmt.Errorf(cmn.ErrInvalidType, "input", common.Address{}, args[1])
+	}
+
+	output, ok = args[2].(common.Address)
+	if !ok {
+		return common.Address{}, common.Address{}, common.Address{}, nil, 0, 0, "", fmt.Errorf(cmn.ErrInvalidType, "output", common.Address{}, args[2])
+	}
+
+	amount, ok = args[3].(*big.Int)
+	if !ok {
+		return common.Address{}, common.Address{}, common.Address{}, nil, 0, 0, "", fmt.Errorf(cmn.ErrInvalidType, "amount", big.Int{}, args[3])
+	}
+
+	slippagePercentage, ok = args[4].(uint8)
+	if !ok {
+		return common.Address{}, common.Address{}, common.Address{}, nil, 0, 0, "", fmt.Errorf(cmn.ErrInvalidType, "slippagePercentage", uint8(0), args[4])
+	}
+
+	windowSeconds, ok = args[5].(uint64)
+	if !ok {
+		return common.Address{}, common.Address{}, common.Address{}, nil, 0, 0, "", fmt.Errorf(cmn.ErrInvalidType, "windowSeconds", uint64(0), args[5])
+	}
+
+	receiver, ok = args[6].(string)
+	if !ok {
+		return common.Address{}, common.Address{}, common.Address{}, nil, 0, 0, "", fmt.Errorf(cmn.ErrInvalidType, "receiver", "", args[6])
+	}
+
+	return sender, input, output, amount, slippagePercentage, windowSeconds, receiver, nil
+}