Dev Requirements

Creating rsa key pairs

openssl genrsa -out private-key.pem 2048

openssl rsa -in private-key.pem -outform PEM -pubout -out public-key.pem

Create the configuration file for app runtime.

{
  "port": 6150,
  "pubkey_path": "/path_to_publick_key.pem",
  "privkey_path": "/path_to_private_key.pem",
  "redis_connection_string": "redis://localhost",
  "token_expiration_time": 300,
  "proxy_routes": [
    {
      "inbound_route": "/dev",
      "outbound_route": "http://localhost:8000",
      "proxy_type": "quicknode",
      "authorized": false,
      "allowed_rpc_methods": [
        "eth_blockNumber",
        "eth_gasPrice"
      ],
      "rate_limiter": null
    }
  ],
  "rate_limiter": {
    "rp_1_min": 30,
    "rp_5_min": 100,
    "rp_15_min": 200,
    "rp_30_min": 350,
    "rp_60_min": 575
  }
}

Expose configuration file's path as an environment variable in AUTH_APP_CONFIG_PATH.

Important Note: The environment where the application will be deployed, the timezone MUST be as UTC. Also, make sure redis is version 6.*

Architecture

Execution flow:

1. Client sends the request.

2. Redirect either to websocket or http handler.

3. If the incoming request comes from the same network, step 4 will be by-passed.

4. Request Handling in the Middleware:

   For Quicknode:

   • Status Checker:

     • Blocked: Return 403 Forbidden immediately.
     • Allowed: Process continues with the rate limiter.
     • Trusted: Bypass rate limiter and proof of funding.

   • Rate Limiter:

     • First, verify the signed message. If not valid, return 401 Unauthorized immediately.
     • If valid, calculate the request count with the time interval specified in the application configuration. If the wallet address has sent too many requests than the expected amount, process continues with the proof of funding. If not, bypass the proof of funding.

   • Proof of Funding:

     • Return 406 Not Acceptable if the wallet has a 0 balance. Otherwise, assume the request is valid and process it as usual.

   For Moralis:

   • Status Checker:

     • Blocked: Return 403 Forbidden immediately.
     • Allowed: Process continues with the rate limiter.
     • Trusted: Bypass the rate limiter.

   • Rate Limiter:

     • First, verify the signed message. If not valid, return 401 Unauthorized immediately.
     • If valid, calculate the request count with the time interval specified in the application configuration. If the wallet address has sent too many requests, return an error 406 Not Acceptable indicating that the wallet address must wait for some time before making more requests.

5. Find target route by requested endpoint.

6. Check if requested rpc call is allowed in application configuration.

7. Generate JWT token with RSA algorithm using pub-priv keys specified in the application configuration, and insert the token to the request header.

8. Drop hop headers.

9. Send request to the target route, then return the same response to the client.

Example Request

curl -v --url "'$mm2_address'" -s --data '{
	"userpass": "'$userpass'",
	"mmrpc": "2.0",
	"method": "enable_eth_with_tokens",
	"params": {
		"ticker": "ETH",
		"nodes": [
			{"url": "'$atomicdex_gui_auth_address'", "gui_auth": true }
		],
		"swap_contract_address": "0x24ABE4c71FC658C91313b6552cd40cD808b3Ea80",
		"erc20_tokens_requests": [
			{
				"ticker": "USDC-ERC20"
			},
			{
				"ticker": "SHIB-ERC20"
			}
		]
	},
	"id": 0
}'

How to run KomodoDefi-Proxy Service with Docker Compose

If you want to test features locally, you can run Docker containers using Docker Compose commands.

1. Update Configuration: In the .config_test file, update the proxy_routes field by adding ProxyRoutes with the necessary parameters.

2. Run Containers in Detached Mode: To start the containers, run the following command. This will build the images if they are not already built or if changes are detected in the Dockerfile or the build context.

   docker compose up -d

3. Follow the Logs: Open a new terminal window or tab and execute this command to follow the logs of all services defined in the Docker Compose file. The -f (or --follow) option ensures that new log entries are continuously displayed as they are produced, while the -t (or --timestamps) option adds timestamps to each log entry.

   docker compose logs -f -t

4. Stop the Containers:

   docker compose down