feat: global refactoring (#38)

Co-authored-by: Tanz0rz <[email protected]>
Co-authored-by: Roman Averianov <[email protected]>

Author: 3 people

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @jeyldii @krboktv @Tanz0rz @enorage

.github/workflows/pr.yml

@@ -0,0 +1,40 @@
+name: PR validation
+
+on:
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - '**.png'
+      - .gitignore
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code into workspace directory
+        uses: actions/checkout@v3
+
+      - name: Set up Go 1.21
+        uses: actions/setup-go@v3
+        with:
+          go-version: '1.21.0'
+
+      - name: Unit tests
+        run: make test
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go 1.21
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.21
+      - name: Checkout code into workspace directory
+        uses: actions/checkout@v3
+
+      - name: Lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          args: --timeout=3m
+          version: v1.54.1
+          skip-cache: true

.github/workflows/release.yml

@@ -0,0 +1,40 @@
+name: Release new version
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        type: choice
+        description: Version
+        options:
+          - patch
+          - minor
+          - major
+          - prerelease
+
+jobs:
+  create:
+    name: Create Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.21.0'
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.event.inputs.version }}
+          release_name: Release ${{ github.event.inputs.version }}
+          draft: false
+          prerelease: false

.gitignore

@@ -1,4 +1,9 @@
 .idea/
 .vscode/
-swagger-dynamic/*.json
 /tmp
+/bin
+
+### macOS ###
+*.DS_Store
+.AppleDouble
+.LSOverride

CHANGELOG.md

@@ -1,53 +1,69 @@
 # Release(March 9, 2024)
+
 Tag: [v0.0.3-developer-preview](https://github.com/1inch/1inch-sdk/releases/tag/v0.0.3-developer-preview)
 
 ### New Features and Enhancements:
-- All non-global query configurations have been moved to the request-level params ([PR](https://github.com/1inch/1inch-sdk/pull/6))
+
+- All non-global query configurations have been moved to the request-level
+  params ([PR](https://github.com/1inch/1inch-sdk/pull/6))
     - RPC providers for all chains will now be defined/set at SDK startup
 - Query parameters now use concrete types instead of pointers ([PR](https://github.com/1inch/1inch-sdk/pull/16))
 - Limit orders created within the SDK now support auto-expiration ([PR](https://github.com/1inch/1inch-sdk/pull/23))
-- Permit1 properly supported for limit orders when possible (fallback to Approval if Permit1 does not work) ([commit](https://github.com/1inch/1inch-sdk/commit/f2e79e5f0e81503bfeeff076e41455e86e5a5120))
-- When creating a limit order, integrators can error out when an approval is needed. This is useful for integrators who want all onchain actions to be performed manually by their users ([PR](https://github.com/1inch/1inch-sdk/pull/26))
+- Permit1 properly supported for limit orders when possible (fallback to Approval if Permit1 does not
+  work) ([commit](https://github.com/1inch/1inch-sdk/commit/f2e79e5f0e81503bfeeff076e41455e86e5a5120))
+- When creating a limit order, integrators can error out when an approval is needed. This is useful for integrators who
+  want all onchain actions to be performed manually by their users ([PR](https://github.com/1inch/1inch-sdk/pull/26))
 
 ### Optimizations and Bug Fixes:
-- Tenderly forks are cleaned up automatically at the beginning of each test run ([PR](https://github.com/1inch/1inch-sdk/pull/6))
-- Validation pattern for swagger-generated input params is now fully handled on all endpoints ([PR](https://github.com/1inch/1inch-sdk/pull/8))
-- Project-wide validation scripts added to verify validation logic standards ([PR](https://github.com/1inch/1inch-sdk/pull/11))
+
+- Tenderly forks are cleaned up automatically at the beginning of each test
+  run ([PR](https://github.com/1inch/1inch-sdk/pull/6))
+- Validation pattern for swagger-generated input params is now fully handled on all
+  endpoints ([PR](https://github.com/1inch/1inch-sdk/pull/8))
+- Project-wide validation scripts added to verify validation logic
+  standards ([PR](https://github.com/1inch/1inch-sdk/pull/11))
 
 # Release(January 23, 2024)
+
 Tag: [v0.0.2-developer-preview](https://github.com/1inch/1inch-sdk/releases/tag/v0.0.2-developer-preview)
 
 ### New Features and Enhancements:
+
 - **Added Tenderly support for e2e swap tests**
     - e2e tests will now create forks, apply state overrides, and run simulations when a Tenderly API key is provided.
 - **Added approval type selection**
     - Users can choose between `Approve` and `Permit1` (`Permit2` currently unsupported)
 - **Implemented nonce cache to address RPC lag**
-    - Once a wallet has posted a transaction, the nonce of that transaction is tracked and incremented internally by the SDK.
+    - Once a wallet has posted a transaction, the nonce of that transaction is tracked and incremented internally by the
+      SDK.
 
 ### Optimizations and Bug Fixes:
+
 - Updated orderbook to use string inputs instead of integers to support all of uint256.
 - Increased gas limit and reduced permit duration to improve transactions success and debugging.
 - Moved Actions into a service within the main client to consolidate SDK structure.
 - Simplified tests and refactored onchain actions to have more uniformity across the library.
 
-# Release(January 15, 2024) 
-Tag: [v0.0.1-developer-preview](https://github.com/1inch/1inch-sdk/releases/tag/v0.0.1-developer-preview)
+# Release(January 15, 2024)
 
+Tag: [v0.0.1-developer-preview](https://github.com/1inch/1inch-sdk/releases/tag/v0.0.1-developer-preview)
 
 ### New Features and Enhancements:
 
 ### Limit Order support
+
 - Enables posting orders to the 1inch Limit Order Protocol
 - Enables reading orders from the 1inch Limit Order Protocol
 - Most endpoints from the Limit Order API supported
     - `has-active-orders-with-permit` REST endpoint still untested
 
 ### Aggregator Protocol support
+
 - All REST endpoints supported
 - Get quotes and swap data from the Aggregator Protocol
 
 ### Onchain execution support
+
 - Execute swaps onchain from within the SDK
 
 

DEVELOPMENT.md

@@ -1,24 +1,33 @@
 This SDK will be open for contributions from the community. Contribution guidelines will be added soon!
 
-
 ### Versioning
 
-This library is currently in the developer preview phase (versions 0.x.x). There will be significant changes to the design of this library leading up to a 1.0.0 release. You can expect the API calls, library structure, etc. to break between each release. Once the library version reaches 1.0.0 and beyond, it will follow traditional semver conventions.
+This library is currently in the developer preview phase (versions 0.x.x). There will be significant changes to the
+design of this library leading up to a 1.0.0 release. You can expect the API calls, library structure, etc. to break
+between each release. Once the library version reaches 1.0.0 and beyond, it will follow traditional semver conventions.
 
 ### Project structure
 
-This SDK is powered by a [client struct](https://github.com/1inch/1inch-sdk/blob/main/golang/client/client.go) that contains instances of all Services used to talk to the 1inch APIs
+This SDK is powered by a [client struct](https://github.com/1inch/1inch-sdk/blob/main/golang/client/client.go) that
+contains instances of all Services used to talk to the 1inch APIs
 
-Each Service maps 1-to-1 with the underlying Dev Portal REST API. See [SwapService](https://github.com/1inch/1inch-sdk/blob/main/golang/client/swap.go) as an example. Under each function, you will find the matching REST API path)
+Each Service maps 1-to-1 with the underlying Dev Portal REST API.
+See [SwapService](https://github.com/1inch/1inch-sdk/blob/main/golang/client/swap.go) as an example. Under each
+function, you will find the matching REST API path)
 
-Each Service uses various types and functions to do its job that are kept separate from the main service file. These can be found in the accompanying folder within the client directory (see the [swap](https://github.com/1inch/1inch-sdk/tree/main/golang/client/swap) package)
+Each Service uses various types and functions to do its job that are kept separate from the main service file. These can
+be found in the accompanying folder within the client directory (see
+the [swap](https://github.com/1inch/1inch-sdk/tree/main/golang/client/swap) package)
 
 ### Type generation
 
-Type generation is done using the `generate_types.sh` script. To add a new swagger file or update an existing one, place the swagger file in `swagger-static` and run the script. It will generate the types file and place it in the appropriately-named sub-folder inside the `client` directory
+Type generation is done using the `generate_types.sh` script. To add a new openapi file or update an existing one, place
+the openapi file in `openapi` and run the script from the root of the project. It will generate the types files for all openapi specs and place them in the
+appropriately-named sub-folder inside the `generatedtypes` directory.
+
+### OpenAPI file formatting
 
-### Swagger file formatting
-For consistency, Swagger files should be formatted with `prettier`
+For consistency, openapi files should be formatted with `prettier`
 
 This can be installed globally using npm:
 

Makefile

@@ -0,0 +1,44 @@
+#! /usr/bin/make -f
+
+MAKEFLAGS += --silent
+
+# Go related variables.
+GOBASE := $(shell pwd)
+GOBIN := $(GOBASE)/bin
+GOPKG := $(.)
+# A valid GOPATH is required to use the `go get` command.
+# If $GOPATH is not specified, $HOME/go will be used by default
+GOPATH := $(if $(GOPATH),$(GOPATH),~/go)
+
+get:
+	@echo "  >  Checking if there are any missing dependencies..."
+	GOBIN=$(GOBIN) go get ./... $(get)
+
+test:
+	@echo "  >  Running unit tests"
+	GOBIN=$(GOBIN) go test -race ./...
+
+fmt:
+	@echo "  >  Running go fmt"
+	GOBIN=$(GOBIN) go fmt ./...
+
+lint: go-lint
+
+go-lint-install:
+	@echo "  >  Installing golint"
+	@curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b ./bin v1.54.1
+
+go-lint:
+	@echo "  >  Checking if golint is installed..."
+	@if [ ! -x "./bin/golangci-lint" ]; then \
+		echo "golangci-lint not found, installing..."; \
+		$(MAKE) go-lint-install; \
+	fi
+	@echo "  >  Running golint"
+	@./bin/golangci-lint version
+	@./bin/golangci-lint run --timeout=2m
+
+codegen-types:
+	@echo "Running generate_types.sh from the codegen directory..."
+	@cd codegen && ./generate_types.sh
+	@echo "Script execution completed."