Improving client config naming now that it is in the models package (#35)

Tanz0rz · web-flow · commit bcfbca98fa8e · 2024-03-12T17:09:10.000-06:00
diff --git a/README.md b/README.md
@@ -68,7 +68,7 @@ func main() {
 	// Build the config for the client
 	config := models.ClientConfig{
 		DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
-		Web3HttpProviders: []models.Web3ProviderConfig{
+		Web3HttpProviders: []models.Web3Provider{
 			{
 				ChainId: chains.Polygon,
 				Url:     web3providers.Polygon,
diff --git a/client/client.go b/client/client.go
@@ -42,8 +42,8 @@ type Client struct {
 	OrderbookApi *OrderbookService
 }
 
-// NewClient creates and initializes a new Client instance based on the provided Config.
-func NewClient(config models.Config) (*Client, error) {
+// NewClient creates and initializes a new Client instance based on the provided ClientConfig.
+func NewClient(config models.ClientConfig) (*Client, error) {
 	err := config.Validate()
 	if err != nil {
 		return nil, fmt.Errorf("config validation error: %v", err)
diff --git a/client/client_test.go b/client/client_test.go
@@ -11,7 +11,7 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-var SimpleEthereumConfig = models.Config{
+var SimpleEthereumConfig = models.ClientConfig{
 	DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 	Web3HttpProviders: []models.Web3Provider{
 		{
@@ -24,12 +24,12 @@ var SimpleEthereumConfig = models.Config{
 func TestNewConfig(t *testing.T) {
 	testcases := []struct {
 		description              string
-		config                   models.Config
+		config                   models.ClientConfig
 		expectedErrorDescription string
 	}{
 		{
 			description: "Success",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: "abc123",
 				Web3HttpProviders: []models.Web3Provider{
 					{
@@ -42,7 +42,7 @@ func TestNewConfig(t *testing.T) {
 		},
 		{
 			description: "Error - no API key",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: "",
 				Web3HttpProviders: []models.Web3Provider{
 					{
@@ -55,7 +55,7 @@ func TestNewConfig(t *testing.T) {
 		},
 		{
 			description: "Error - no web3 provider key",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: "123",
 			},
 			expectedErrorDescription: "config validation error: at least one web3 provider URL is required",
diff --git a/client/client_test_helpers.go b/client/client_test_helpers.go
@@ -27,7 +27,7 @@ func setup() (*Client, *http.ServeMux, string, func(), error) {
 	// the base URL of the client will have its destination swapped to use this new test server for requests
 	server := httptest.NewServer(mux)
 	c, err := NewClient(
-		models.Config{
+		models.ClientConfig{
 			DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 			Web3HttpProviders: []models.Web3Provider{
 				{
diff --git a/client/examples/orderbook/create_order/main.go b/client/examples/orderbook/create_order/main.go
@@ -16,7 +16,7 @@ import (
 func main() {
 
 	// Build the config for the client
-	config := models.Config{
+	config := models.ClientConfig{
 		DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 		Web3HttpProviders: []models.Web3Provider{
 			{
diff --git a/client/examples/orderbook/get_orders/main.go b/client/examples/orderbook/get_orders/main.go
@@ -15,7 +15,7 @@ import (
 func main() {
 
 	// Build the config for the client
-	config := models.Config{
+	config := models.ClientConfig{
 		DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 		Web3HttpProviders: []models.Web3Provider{
 			{
diff --git a/client/examples/swap/get_swap/main.go b/client/examples/swap/get_swap/main.go
@@ -18,7 +18,7 @@ import (
 func main() {
 
 	// Build the config for the client
-	config := models.Config{
+	config := models.ClientConfig{
 		DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 		Web3HttpProviders: []models.Web3Provider{
 			{
diff --git a/client/models/client_types.go b/client/models/client_types.go
@@ -2,7 +2,7 @@ package models
 
 import "fmt"
 
-type Config struct {
+type ClientConfig struct {
 	DevPortalApiKey   string
 	Web3HttpProviders []Web3Provider
 }
@@ -12,7 +12,7 @@ type Web3Provider struct {
 	Url     string
 }
 
-func (c *Config) Validate() error {
+func (c *ClientConfig) Validate() error {
 
 	if c.DevPortalApiKey == "" {
 		return fmt.Errorf("API key is required")
diff --git a/client/orderbook_e2e_test.go b/client/orderbook_e2e_test.go
@@ -22,13 +22,13 @@ func TestCreateOrderE2E(t *testing.T) {
 
 	testcases := []struct {
 		description       string
-		config            models.Config
+		config            models.ClientConfig
 		createOrderParams models.CreateOrderParams
 		expectedOutput    string
 	}{
 		{
 			description: "Arbitrum - Create limit order offering 1 FRAX for 1 DAI",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 				Web3HttpProviders: []models.Web3Provider{
 					{
@@ -51,7 +51,7 @@ func TestCreateOrderE2E(t *testing.T) {
 		},
 		{
 			description: "Polygon - Create limit order offering 1 FRAX for 1 DAI",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 				Web3HttpProviders: []models.Web3Provider{
 					{
@@ -74,7 +74,7 @@ func TestCreateOrderE2E(t *testing.T) {
 		},
 		{
 			description: "Ethereum - Create limit order offering 1 1INCH for 1 DAI",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 				Web3HttpProviders: []models.Web3Provider{
 					{
@@ -98,7 +98,7 @@ func TestCreateOrderE2E(t *testing.T) {
 		},
 		{
 			description: "BSC - Create limit order offering 1 USDC for 1 DAI",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 				Web3HttpProviders: []models.Web3Provider{
 					{
diff --git a/client/orderbook_integration_test.go b/client/orderbook_integration_test.go
@@ -54,7 +54,7 @@ func TestCreateOrderIntegration(t *testing.T) {
 		},
 	}
 
-	c, err := NewClient(models.Config{
+	c, err := NewClient(models.ClientConfig{
 		DevPortalApiKey: helpers.GetenvSafe("DEV_PORTAL_TOKEN"),
 		Web3HttpProviders: []models.Web3Provider{
 			{
diff --git a/client/swap_actions_e2e_test.go b/client/swap_actions_e2e_test.go
@@ -26,7 +26,7 @@ func TestSwapTokensTenderlyE2E(t *testing.T) {
 	testcases := []struct {
 		description         string
 		tenderlyDescription string
-		config              models.Config
+		config              models.ClientConfig
 		swapParams          models.SwapTokensParams
 		stateOverrides      map[string]tenderly.StateObject
 		approvalType        onchain.ApprovalType
@@ -35,7 +35,7 @@ func TestSwapTokensTenderlyE2E(t *testing.T) {
 		{
 			description:         "Polygon - Swap 0.01 DAI for USDC - Approval - Does not support traditional permit interface",
 			tenderlyDescription: "DP-DAI->USDC-Approval",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 				Web3HttpProviders: []models.Web3Provider{
 					{
@@ -72,7 +72,7 @@ func TestSwapTokensTenderlyE2E(t *testing.T) {
 		{
 			description:         "Polygon - Swap 0.01 USDC for DAI - Permit - Contract has a version value of 2",
 			tenderlyDescription: "DP-USDC->DAI-Approval",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 				Web3HttpProviders: []models.Web3Provider{
 					{
@@ -109,7 +109,7 @@ func TestSwapTokensTenderlyE2E(t *testing.T) {
 		{
 			description:         "Polygon - Swap 0.01 FRAX for USDC - Approval - Forced",
 			tenderlyDescription: "DP-FRAX->USDC-Approval",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 				Web3HttpProviders: []models.Web3Provider{
 					{
@@ -146,7 +146,7 @@ func TestSwapTokensTenderlyE2E(t *testing.T) {
 		{
 			description:         "Polygon - Swap 0.01 FRAX for USDC - Permit",
 			tenderlyDescription: "DP-FRAX->USDC-Permit",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 				Web3HttpProviders: []models.Web3Provider{
 					{
@@ -183,7 +183,7 @@ func TestSwapTokensTenderlyE2E(t *testing.T) {
 		{
 			description:         "Arbitrum - Swap 0.01 USDC for DAI - Approve - Arbitrum unsupported right now",
 			tenderlyDescription: "DP-USDC->DAI-Approve",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 				Web3HttpProviders: []models.Web3Provider{
 					{
@@ -220,7 +220,7 @@ func TestSwapTokensTenderlyE2E(t *testing.T) {
 		{
 			description:         "Arbitrum - Swap $0.01 worth of ETH for USDC - Native token for ERC20",
 			tenderlyDescription: "DP-ETH->USDC",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 				Web3HttpProviders: []models.Web3Provider{
 					{
@@ -257,7 +257,7 @@ func TestSwapTokensTenderlyE2E(t *testing.T) {
 		{
 			description:         "Ethereum - Swap $0.01 worth of 1inch for ETH - Force Permit1",
 			tenderlyDescription: "DP-1inch->ETH-Permit1",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 				Web3HttpProviders: []models.Web3Provider{
 					{
@@ -294,7 +294,7 @@ func TestSwapTokensTenderlyE2E(t *testing.T) {
 		{
 			description:         "Ethereum - Swap $0.01 worth of USDC for ETH - Version 2 - Permit1",
 			tenderlyDescription: "DP-1inch->ETH-Permit1",
-			config: models.Config{
+			config: models.ClientConfig{
 				DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),
 				Web3HttpProviders: []models.Web3Provider{
 					{

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ func main() {`
`68`	`68`	`// Build the config for the client`
`69`	`69`	`config := models.ClientConfig{`
`70`	`70`	`DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),`
`71`		`- Web3HttpProviders: []models.Web3ProviderConfig{`
	`71`	`+ Web3HttpProviders: []models.Web3Provider{`
`72`	`72`	`{`
`73`	`73`	`ChainId: chains.Polygon,`
`74`	`74`	`Url: web3providers.Polygon,`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import (`
`11`	`11`	`"github.com/stretchr/testify/require"`
`12`	`12`	`)`
`13`	`13`
`14`		`-var SimpleEthereumConfig = models.Config{`
	`14`	`+var SimpleEthereumConfig = models.ClientConfig{`
`15`	`15`	`DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),`
`16`	`16`	`Web3HttpProviders: []models.Web3Provider{`
`17`	`17`	`{`
`@@ -24,12 +24,12 @@ var SimpleEthereumConfig = models.Config{`
`24`	`24`	`func TestNewConfig(t *testing.T) {`
`25`	`25`	`testcases := []struct {`
`26`	`26`	`description string`
`27`		`- config models.Config`
	`27`	`+ config models.ClientConfig`
`28`	`28`	`expectedErrorDescription string`
`29`	`29`	`}{`
`30`	`30`	`{`
`31`	`31`	`description: "Success",`
`32`		`- config: models.Config{`
	`32`	`+ config: models.ClientConfig{`
`33`	`33`	`DevPortalApiKey: "abc123",`
`34`	`34`	`Web3HttpProviders: []models.Web3Provider{`
`35`	`35`	`{`
`@@ -42,7 +42,7 @@ func TestNewConfig(t *testing.T) {`
`42`	`42`	`},`
`43`	`43`	`{`
`44`	`44`	`description: "Error - no API key",`
`45`		`- config: models.Config{`
	`45`	`+ config: models.ClientConfig{`
`46`	`46`	`DevPortalApiKey: "",`
`47`	`47`	`Web3HttpProviders: []models.Web3Provider{`
`48`	`48`	`{`
`@@ -55,7 +55,7 @@ func TestNewConfig(t *testing.T) {`
`55`	`55`	`},`
`56`	`56`	`{`
`57`	`57`	`description: "Error - no web3 provider key",`
`58`		`- config: models.Config{`
	`58`	`+ config: models.ClientConfig{`
`59`	`59`	`DevPortalApiKey: "123",`
`60`	`60`	`},`
`61`	`61`	`expectedErrorDescription: "config validation error: at least one web3 provider URL is required",`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ func setup() (Client, http.ServeMux, string, func(), error) {`
`27`	`27`	`// the base URL of the client will have its destination swapped to use this new test server for requests`
`28`	`28`	`server := httptest.NewServer(mux)`
`29`	`29`	`c, err := NewClient(`
`30`		`- models.Config{`
	`30`	`+ models.ClientConfig{`
`31`	`31`	`DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),`
`32`	`32`	`Web3HttpProviders: []models.Web3Provider{`
`33`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ import (`
`16`	`16`	`func main() {`
`17`	`17`
`18`	`18`	`// Build the config for the client`
`19`		`- config := models.Config{`
	`19`	`+ config := models.ClientConfig{`
`20`	`20`	`DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),`
`21`	`21`	`Web3HttpProviders: []models.Web3Provider{`
`22`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ import (`
`15`	`15`	`func main() {`
`16`	`16`
`17`	`17`	`// Build the config for the client`
`18`		`- config := models.Config{`
	`18`	`+ config := models.ClientConfig{`
`19`	`19`	`DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),`
`20`	`20`	`Web3HttpProviders: []models.Web3Provider{`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ import (`
`18`	`18`	`func main() {`
`19`	`19`
`20`	`20`	`// Build the config for the client`
`21`		`- config := models.Config{`
	`21`	`+ config := models.ClientConfig{`
`22`	`22`	`DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),`
`23`	`23`	`Web3HttpProviders: []models.Web3Provider{`
`24`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ package models`
`2`	`2`
`3`	`3`	`import "fmt"`
`4`	`4`
`5`		`-type Config struct {`
	`5`	`+type ClientConfig struct {`
`6`	`6`	`DevPortalApiKey string`
`7`	`7`	`Web3HttpProviders []Web3Provider`
`8`	`8`	`}`
`@@ -12,7 +12,7 @@ type Web3Provider struct {`
`12`	`12`	`Url string`
`13`	`13`	`}`
`14`	`14`
`15`		`-func (c *Config) Validate() error {`
	`15`	`+func (c *ClientConfig) Validate() error {`
`16`	`16`
`17`	`17`	`if c.DevPortalApiKey == "" {`
`18`	`18`	`return fmt.Errorf("API key is required")`
Original file line number	Diff line number	Diff line change
`@@ -22,13 +22,13 @@ func TestCreateOrderE2E(t *testing.T) {`
`22`	`22`
`23`	`23`	`testcases := []struct {`
`24`	`24`	`description string`
`25`		`- config models.Config`
	`25`	`+ config models.ClientConfig`
`26`	`26`	`createOrderParams models.CreateOrderParams`
`27`	`27`	`expectedOutput string`
`28`	`28`	`}{`
`29`	`29`	`{`
`30`	`30`	`description: "Arbitrum - Create limit order offering 1 FRAX for 1 DAI",`
`31`		`- config: models.Config{`
	`31`	`+ config: models.ClientConfig{`
`32`	`32`	`DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),`
`33`	`33`	`Web3HttpProviders: []models.Web3Provider{`
`34`	`34`	`{`
`@@ -51,7 +51,7 @@ func TestCreateOrderE2E(t *testing.T) {`
`51`	`51`	`},`
`52`	`52`	`{`
`53`	`53`	`description: "Polygon - Create limit order offering 1 FRAX for 1 DAI",`
`54`		`- config: models.Config{`
	`54`	`+ config: models.ClientConfig{`
`55`	`55`	`DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),`
`56`	`56`	`Web3HttpProviders: []models.Web3Provider{`
`57`	`57`	`{`
`@@ -74,7 +74,7 @@ func TestCreateOrderE2E(t *testing.T) {`
`74`	`74`	`},`
`75`	`75`	`{`
`76`	`76`	`description: "Ethereum - Create limit order offering 1 1INCH for 1 DAI",`
`77`		`- config: models.Config{`
	`77`	`+ config: models.ClientConfig{`
`78`	`78`	`DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),`
`79`	`79`	`Web3HttpProviders: []models.Web3Provider{`
`80`	`80`	`{`
`@@ -98,7 +98,7 @@ func TestCreateOrderE2E(t *testing.T) {`
`98`	`98`	`},`
`99`	`99`	`{`
`100`	`100`	`description: "BSC - Create limit order offering 1 USDC for 1 DAI",`
`101`		`- config: models.Config{`
	`101`	`+ config: models.ClientConfig{`
`102`	`102`	`DevPortalApiKey: os.Getenv("DEV_PORTAL_TOKEN"),`
`103`	`103`	`Web3HttpProviders: []models.Web3Provider{`
`104`	`104`	`{`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ func TestCreateOrderIntegration(t *testing.T) {`
`54`	`54`	`},`
`55`	`55`	`}`
`56`	`56`
`57`		`- c, err := NewClient(models.Config{`
	`57`	`+ c, err := NewClient(models.ClientConfig{`
`58`	`58`	`DevPortalApiKey: helpers.GetenvSafe("DEV_PORTAL_TOKEN"),`
`59`	`59`	`Web3HttpProviders: []models.Web3Provider{`
`60`	`60`	`{`