Merge pull request #11 from CompassLabs/aidar/com-4714-sdk-examples-in-the-examples-mono

adding looping use cases

Author: royalnine

aave_looping/python_example/.python-version

@@ -0,0 +1 @@
+aave-looping

aave_looping/python_example/README.md

@@ -0,0 +1,33 @@
+# Aave Looping Example
+
+This Python project demonstrates how to perform Aave looping using the Compass Labs API SDK.
+
+## Requirements
+
+- Python 3.11+
+- Poetry for dependency management
+
+## Dependencies
+
+- web3
+- python-dotenv
+- compass-api-sdk
+
+## Setup
+
+1. Install dependencies:
+```bash
+poetry install
+```
+
+2. Create a `.env` file with your configuration:
+```bash
+COMPASS_API_KEY=your_api_key
+PRIVATE_KEY=your_private_key
+RPC_URL=your_rpc_url
+```
+
+3. Run the example:
+```bash
+poetry run python src/main.py
+``` 

aave_looping/python_example/poetry.toml

@@ -0,0 +1,2 @@
+[virtualenvs]
+in-project = true

aave_looping/python_example/pyproject.toml

@@ -0,0 +1,18 @@
+[tool.poetry]
+name = "aave-looping-example"
+version = "0.1.0"
+description = "Example of Aave looping in Python"
+authors = ["Compass Labs"]
+readme = "README.md"
+package-mode = false
+
+[tool.poetry.dependencies]
+python = "^3.11"
+web3 = "^7.12.0"
+python-dotenv = "^1.1.0"
+compass-api-sdk = "^0.9.10"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

aave_looping/python_example/src/main.py

@@ -0,0 +1,48 @@
+from compass_api_sdk import CompassAPI
+import os
+import dotenv
+from web3 import Web3
+from eth_account import Account
+
+dotenv.load_dotenv()
+
+PRIVATE_KEY = os.getenv("PRIVATE_KEY")
+RPC_URL = os.getenv("RPC_URL")
+COMPASS_API_KEY = os.getenv("COMPASS_API_KEY")
+
+def main():
+    sdk = CompassAPI(api_key_auth=COMPASS_API_KEY)
+    
+    private_key = PRIVATE_KEY
+    if not private_key.startswith("0x"):
+        private_key = f"0x{private_key}"
+    
+    w3 = Web3(Web3.HTTPProvider(RPC_URL))
+    account = Account.from_key(private_key)
+    
+    auth = sdk.transaction_batching.authorization(
+        chain="ethereum:mainnet",
+        sender=account.address
+    )
+    
+    signed_auth = Account.sign_authorization(auth.model_dump(by_alias=True), private_key)
+    
+    looping_tx = sdk.transaction_batching.aave_loop(
+        chain="ethereum:mainnet",
+        sender=account.address,
+        signed_authorization=signed_auth.model_dump(),
+        collateral_token="USDC",
+        borrow_token="WETH",
+        initial_collateral_amount=10,
+        multiplier=1.5,
+        max_slippage_percent=2.5,
+        loan_to_value=70
+    )
+    
+    signed_tx = w3.eth.account.sign_transaction(looping_tx.model_dump(by_alias=True), private_key)
+    tx_hash = w3.eth.send_raw_transaction(signed_tx.raw_transaction)
+    
+    print(f"Transaction hash: {tx_hash.hex()}")
+
+if __name__ == "__main__":
+    main()

aave_looping/typescript_example/.prettierrc

@@ -0,0 +1,8 @@
+{
+    "useTabs": false,
+    "tabWidth": 2,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "es5",
+    "printWidth": 100
+}

aave_looping/typescript_example/README.md

@@ -0,0 +1,51 @@
+# Aave Looping TypeScript Example
+
+This example demonstrates how to use the Compass Labs API SDK to perform Aave looping operations on Ethereum mainnet.
+
+## Prerequisites
+
+- Node.js installed
+- A private key for an Ethereum wallet with sufficient funds
+- An RPC URL for Ethereum mainnet (e.g., from Infura, Alchemy)
+- A Compass Labs API key
+
+## Setup
+
+1. Install dependencies:
+```bash
+npm install
+```
+
+2. Create a `.env` file in the root directory with the following variables:
+```
+PRIVATE_KEY=your_private_key_here
+RPC_URL=your_rpc_url_here
+COMPASS_API_KEY=your_compass_api_key_here
+```
+
+Make sure your private key is prefixed with "0x".
+
+## Running the Example
+
+Execute the TypeScript example:
+
+```bash
+npm start
+```
+
+## What the Example Does
+
+This example:
+1. Initializes the Compass Labs SDK
+2. Sets up authorization for transaction batching
+3. Creates an Aave looping transaction that:
+   - Uses USDC as collateral
+   - Borrows WETH
+   - Sets an initial collateral amount of 5 USDC
+   - Uses a multiplier of 1.5x
+   - Sets max slippage to 2.5%
+   - Sets a loan-to-value ratio of 70%
+
+## Security Note
+
+Never commit your `.env` file or expose your private key. Make sure to add `.env` to your `.gitignore` file. 

aave_looping/typescript_example/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "aave_looping_typescript_example",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "start": "tsc && node dist/index.js",
+    "dev": "ts-node --esm src/index.ts"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "@types/node": "^22.15.30",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "@compass-labs/api-sdk": "^0.5.10",
+    "dotenv": "^16.5.0",
+    "viem": "^2.30.6"
+  }
+}

aave_looping/typescript_example/src/index.ts

@@ -0,0 +1,62 @@
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+import dotenv from "dotenv";
+import { privateKeyToAccount } from 'viem/accounts'
+import { mainnet } from 'viem/chains';
+import { http, SendTransactionRequest } from 'viem';
+
+import { createWalletClient } from 'viem';
+
+dotenv.config();
+
+const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`;
+const RPC_URL = process.env.RPC_URL as string;
+
+const main = async () => {
+    const compassApiSDK = new CompassApiSDK({
+        apiKeyAuth: process.env.COMPASS_API_KEY,
+    });
+
+    const account = privateKeyToAccount(PRIVATE_KEY);
+
+    const walletClient = createWalletClient({
+        account,
+        chain: mainnet,
+        transport: http(RPC_URL as string),
+    });
+
+    const auth = await compassApiSDK.transactionBatching.authorization({
+        chain: "ethereum:mainnet",
+        sender: account.address,
+    });
+
+    const signedAuth = await walletClient.signAuthorization({
+        account,
+        contractAddress: auth.address as `0x${string}`,
+    });
+
+    const loopingTx = await compassApiSDK.transactionBatching.aaveLoop({
+        chain: "ethereum:mainnet",
+        sender: account.address,
+        signedAuthorization: {
+            nonce: signedAuth.nonce,
+            address: signedAuth.address,
+            chainId: signedAuth.chainId,
+            r: signedAuth.r,
+            s: signedAuth.s,
+            yParity: signedAuth.yParity as number,
+        },
+        collateralToken: "USDC",
+        borrowToken: "WETH",
+        initialCollateralAmount: 5,
+        multiplier: 1.5,
+        maxSlippagePercent: 2.5,
+        loanToValue: 70,
+    });
+
+    const tx = await walletClient.sendTransaction(loopingTx as unknown as SendTransactionRequest);
+
+    console.log(tx);
+}
+
+
+main();

aave_looping/typescript_example/tsconfig.json

@@ -0,0 +1,26 @@
+{
+	"compilerOptions": {
+		"target": "ES2020",
+		"module": "NodeNext",
+		"moduleResolution": "NodeNext",
+		"strict": true,
+		"esModuleInterop": true,
+		"resolveJsonModule": true,
+		"outDir": "dist",
+		"rootDir": "src",
+		"types": ["node"],
+		"sourceMap": true,
+		"inlineSourceMap": false,
+		"inlineSources": true,
+		"declaration": true,
+		"declarationMap": true,
+		"allowJs": true,
+		"checkJs": false
+	},
+	"ts-node": {
+		"esm": true,
+		"experimentalSpecifierResolution": "node"
+	},
+	"include": ["src"],
+	"exclude": ["node_modules", "dist"]
+}