Setup refactored Aggregation SDK

.gitignore

@@ -1,3 +1,9 @@
 .idea/
 .vscode/
 /tmp
+/bin
+
+### macOS ###
+*.DS_Store
+.AppleDouble
+.LSOverride

aggregation/aggregation.go

@@ -1,36 +1,83 @@
 package aggregation
 
 import (
-	"math/big"
-	"net/url"
-
-	"github.com/1inch/1inch-sdk-go/internal/common"
+	"github.com/1inch/1inch-sdk-go/common"
 	"github.com/1inch/1inch-sdk-go/internal/http_executor"
-	"github.com/1inch/1inch-sdk-go/internal/web3_provider"
+	"github.com/1inch/1inch-sdk-go/internal/transaction-builder"
+	"github.com/1inch/1inch-sdk-go/internal/web3-provider"
 )
 
-type api struct {
-	httpExecutor common.HttpExecutor
+type Configuration struct {
+	WalletConfiguration *WalletConfiguration
+	ChainId             uint64
+
+	ApiKey string
+	ApiURL string
+
+	API api
+}
+
+type WalletConfiguration struct {
+	PrivateKey string
+	NodeURL    string
+
+	Wallet    common.Wallet
+	TxBuilder common.TransactionBuilderFactory
 }
 
 type Client struct {
 	api
-	Wallet common.Wallet
+	Wallet    common.Wallet
+	TxBuilder common.TransactionBuilderFactory
 }
 
-// todo: not done
-func DefaultClient() *Client {
-	// todo: move to input params, that will be validated before
-	u, _ := url.Parse("https://api.1inch.dev")
-	executor := http_executor.DefaultHttpClient(u, "")
-	api := api{
-		httpExecutor: &executor,
-	}
+type api struct {
+	chainId      uint64
+	httpExecutor common.HttpExecutor
+}
 
-	w := web3_provider.DefaultWalletProvider("", "", big.NewInt(1))
+func NewClient(cfg *Configuration) (*Client, error) {
 	c := Client{
-		api:    api,
-		Wallet: w,
+		api: cfg.API,
+	}
+
+	if cfg.WalletConfiguration != nil {
+		c.Wallet = cfg.WalletConfiguration.Wallet
+	}
+
+	return &c, nil
+}
+
+func NewDefaultConfiguration(nodeUrl string, privateKey string, chainId uint64, apiUrl string, apiKey string) (*Configuration, error) {
+	executor, err := http_executor.DefaultHttpClient(apiUrl, apiKey)
+	if err != nil {
+		return nil, err
+	}
+
+	a := api{
+		chainId:      chainId,
+		httpExecutor: executor,
 	}
-	return &c
+
+	walletCfg, err := NewDefaultWalletConfiguration(nodeUrl, privateKey, chainId)
+	if err != nil {
+		return nil, err
+	}
+	return &Configuration{
+		WalletConfiguration: walletCfg,
+		API:                 a,
+	}, nil
+}
+
+func NewDefaultWalletConfiguration(nodeUrl string, privateKey string, chainId uint64) (*WalletConfiguration, error) {
+	w, err := web3_provider.DefaultWalletProvider(privateKey, nodeUrl, chainId)
+	if err != nil {
+		return nil, err
+	}
+
+	f := transaction_builder.NewFactory(w)
+	return &WalletConfiguration{
+		Wallet:    w,
+		TxBuilder: f,
+	}, nil
 }

aggregation/api.go

@@ -4,12 +4,13 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/1inch/1inch-sdk-go/internal/common"
+	"github.com/1inch/1inch-sdk-go/aggregation/models"
+	"github.com/1inch/1inch-sdk-go/common"
 )
 
 // GetApproveAllowance returns the allowance the 1inch router has to spend a token on behalf of a wallet
-func (api *api) GetApproveAllowance(ctx context.Context, params ApproveAllowanceParams) (*AllowanceResponse, error) {
-	u := fmt.Sprintf("/swap/v5.2/%d/approve/allowance", params.ChainId)
+func (api *api) GetApproveAllowance(ctx context.Context, params models.ApproveAllowanceParams) (*models.AllowanceResponse, error) {
+	u := fmt.Sprintf("/swap/v5.2/%d/approve/allowance", api.chainId)
 
 	err := params.Validate()
 	if err != nil {
@@ -23,7 +24,7 @@ func (api *api) GetApproveAllowance(ctx context.Context, params ApproveAllowance
 		Body:   nil,
 	}
 
-	var allowanceResponse AllowanceResponse
+	var allowanceResponse models.AllowanceResponse
 	err = api.httpExecutor.ExecuteRequest(ctx, payload, &allowanceResponse)
 	if err != nil {
 		return nil, err
@@ -33,8 +34,8 @@ func (api *api) GetApproveAllowance(ctx context.Context, params ApproveAllowance
 }
 
 // GetApproveSpender returns the address of the 1inch router contract
-func (api *api) GetApproveSpender(ctx context.Context, params ApproveSpenderParams) (*SpenderResponse, error) {
-	u := fmt.Sprintf("/swap/v5.2/%d/approve/spender", params.ChainId)
+func (api *api) GetApproveSpender(ctx context.Context, params models.ApproveSpenderParams) (*models.SpenderResponse, error) {
+	u := fmt.Sprintf("/swap/v5.2/%d/approve/spender", api.chainId)
 
 	err := params.Validate()
 	if err != nil {
@@ -48,7 +49,7 @@ func (api *api) GetApproveSpender(ctx context.Context, params ApproveSpenderPara
 		Body:   nil,
 	}
 
-	var spender SpenderResponse
+	var spender models.SpenderResponse
 	err = api.httpExecutor.ExecuteRequest(ctx, payload, &spender)
 	if err != nil {
 		return nil, err
@@ -58,8 +59,8 @@ func (api *api) GetApproveSpender(ctx context.Context, params ApproveSpenderPara
 }
 
 // GetApproveTransaction returns the transaction data for approving the 1inch router to spend a token on behalf of a wallet
-func (api *api) GetApproveTransaction(ctx context.Context, params ApproveTransactionParams) (*ApproveCallDataResponse, error) {
-	u := fmt.Sprintf("/swap/v5.2/%d/approve/transaction", params.ChainId)
+func (api *api) GetApproveTransaction(ctx context.Context, params models.ApproveTransactionParams) (*models.ApproveCallDataResponse, error) {
+	u := fmt.Sprintf("/swap/v5.2/%d/approve/transaction", api.chainId)
 
 	err := params.Validate()
 	if err != nil {
@@ -73,7 +74,7 @@ func (api *api) GetApproveTransaction(ctx context.Context, params ApproveTransac
 		Body:   nil,
 	}
 
-	var approveCallData ApproveCallDataResponse
+	var approveCallData models.ApproveCallDataResponse
 	err = api.httpExecutor.ExecuteRequest(ctx, payload, &approveCallData)
 	if err != nil {
 		return nil, err
@@ -82,8 +83,8 @@ func (api *api) GetApproveTransaction(ctx context.Context, params ApproveTransac
 }
 
 // GetLiquiditySources returns all liquidity sources tracked by the 1inch Aggregation Protocol for a given chain
-func (api *api) GetLiquiditySources(ctx context.Context, params GetLiquiditySourcesParams) (*ProtocolsResponse, error) {
-	u := fmt.Sprintf("/swap/v5.2/%d/liquidity-sources", params.ChainId)
+func (api *api) GetLiquiditySources(ctx context.Context, params models.GetLiquiditySourcesParams) (*models.ProtocolsResponse, error) {
+	u := fmt.Sprintf("/swap/v5.2/%d/liquidity-sources", api.chainId)
 
 	err := params.Validate()
 	if err != nil {
@@ -97,7 +98,7 @@ func (api *api) GetLiquiditySources(ctx context.Context, params GetLiquiditySour
 		Body:   nil,
 	}
 
-	var liquiditySources ProtocolsResponse
+	var liquiditySources models.ProtocolsResponse
 	err = api.httpExecutor.ExecuteRequest(ctx, payload, &liquiditySources)
 	if err != nil {
 		return nil, err
@@ -107,8 +108,8 @@ func (api *api) GetLiquiditySources(ctx context.Context, params GetLiquiditySour
 }
 
 // GetQuote returns the quote for a potential swap through the Aggregation Protocol
-func (api *api) GetQuote(ctx context.Context, params GetQuoteParams) (*QuoteResponse, error) {
-	u := fmt.Sprintf("/swap/v5.2/%d/quote", params.ChainId)
+func (api *api) GetQuote(ctx context.Context, params models.GetQuoteParams) (*models.QuoteResponse, error) {
+	u := fmt.Sprintf("/swap/v5.2/%d/quote", api.chainId)
 
 	err := params.Validate()
 	if err != nil {
@@ -121,7 +122,7 @@ func (api *api) GetQuote(ctx context.Context, params GetQuoteParams) (*QuoteResp
 		U:      u,
 	}
 
-	var quote QuoteResponse
+	var quote models.QuoteResponse
 	err = api.httpExecutor.ExecuteRequest(ctx, payload, &quote)
 	if err != nil {
 		return nil, err
@@ -131,28 +132,22 @@ func (api *api) GetQuote(ctx context.Context, params GetQuoteParams) (*QuoteResp
 }
 
 // GetSwap returns a swap quote with transaction data that can be used to execute a swap through the Aggregation Protocol
-func (api *api) GetSwap(ctx context.Context, params GetSwapParams) (*SwapResponse, error) {
-	u := fmt.Sprintf("/swap/v5.2/%d/swap", params.ChainId)
+func (api *api) GetSwap(ctx context.Context, params models.AggregationControllerGetSwapParams) (*models.SwapResponse, error) {
+	u := fmt.Sprintf("/swap/v5.2/%d/swap", api.chainId)
 
 	err := params.Validate()
 	if err != nil {
 		return nil, err
 	}
 
-	// Token info is used by certain parts of the SDK and more info by default is helpful to integrators
-	// Because we use generated structs with concrete types, extra data is forced on regardless of what the user passes in.
-	params.IncludeTokensInfo = true
-	params.IncludeGas = true
-	params.IncludeProtocols = true
-
 	payload := common.RequestPayload{
 		Method: "GET",
-		Params: params.AggregationControllerGetSwapParams,
+		Params: params,
 		U:      u,
 		Body:   nil,
 	}
 
-	var swapResponse SwapResponse
+	var swapResponse models.SwapResponse
 	err = api.httpExecutor.ExecuteRequest(ctx, payload, &swapResponse)
 	if err != nil {
 		return nil, err
@@ -162,8 +157,8 @@ func (api *api) GetSwap(ctx context.Context, params GetSwapParams) (*SwapRespons
 }
 
 // GetTokens returns all tokens officially tracked by the 1inch Aggregation Protocol for a given chain
-func (api *api) GetTokens(ctx context.Context, params GetTokensParams) (*TokensResponse, error) {
-	u := fmt.Sprintf("/swap/v5.2/%d/tokens", params.ChainId)
+func (api *api) GetTokens(ctx context.Context, params models.GetTokensParams) (*models.TokensResponse, error) {
+	u := fmt.Sprintf("/swap/v5.2/%d/tokens", api.chainId)
 
 	err := params.Validate()
 	if err != nil {
@@ -177,7 +172,7 @@ func (api *api) GetTokens(ctx context.Context, params GetTokensParams) (*TokensR
 		Body:   nil,
 	}
 
-	var tokens TokensResponse
+	var tokens models.TokensResponse
 	err = api.httpExecutor.ExecuteRequest(ctx, payload, &tokens)
 	if err != nil {
 		return nil, err

aggregation/api_test.go

@@ -6,8 +6,9 @@ import (
 	"reflect"
 	"testing"
 
-	"github.com/1inch/1inch-sdk-go/internal/common"
-	"github.com/1inch/1inch-sdk-go/internal/helpers/consts/chains"
+	"github.com/1inch/1inch-sdk-go/aggregation/models"
+	"github.com/1inch/1inch-sdk-go/common"
+	"github.com/1inch/1inch-sdk-go/constants"
 )
 
 type MockHttpExecutor struct {
@@ -36,8 +37,8 @@ func (m *MockHttpExecutor) ExecuteRequest(ctx context.Context, payload common.Re
 func TestGetQuote(t *testing.T) {
 	ctx := context.Background()
 
-	mockedResp := QuoteResponse{
-		FromToken: &TokenInfo{
+	mockedResp := models.QuoteResponse{
+		FromToken: &models.TokenInfo{
 			Address:  "0x6b175474e89094c44da98b954eedeac495271d0f",
 			Symbol:   "DAI",
 			Name:     "Dai Stablecoin",
@@ -50,7 +51,7 @@ func TestGetQuote(t *testing.T) {
 		},
 		Gas:      181416,
 		ToAmount: "289424403260095",
-		ToToken: &TokenInfo{
+		ToToken: &models.TokenInfo{
 			Address:  "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
 			Symbol:   "WETH",
 			Name:     "Wrapped Ether",
@@ -61,7 +62,7 @@ func TestGetQuote(t *testing.T) {
 				"tokens",
 			},
 		},
-		Protocols: [][][]SelectedProtocol{
+		Protocols: [][][]models.SelectedProtocol{
 			{
 				{
 					{
@@ -80,9 +81,9 @@ func TestGetQuote(t *testing.T) {
 	}
 	api := api{httpExecutor: mockExecutor}
 
-	params := GetQuoteParams{
-		ChainId: chains.Ethereum,
-		AggregationControllerGetQuoteParams: AggregationControllerGetQuoteParams{
+	params := models.GetQuoteParams{
+		ChainId: constants.EthereumChainId,
+		AggregationControllerGetQuoteParams: models.AggregationControllerGetQuoteParams{
 			Src:               "0x6b175474e89094c44da98b954eedeac495271d0f",
 			Dst:               "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
 			Amount:            "1000000000000000000",