Merge pull request #2 from allen0x1/dev

Dev

Author: jtomada

.env-example

@@ -0,0 +1,2 @@
+RPC_ENDPOINT="https://ssc-dao.genesysgo.net"
+WALLET_PRIVATE_KEY=abc123def456

README.md

@@ -5,25 +5,19 @@ This code was made to experiment and learn. It has not been thoroughly tested an
 
 Based on the [Jupiter Core Example](https://github.com/jup-ag/jupiter-core-example)
 
+![Jup DCA Bot Demo](img/demo.gif)
+
 ## Install
 ```
 yarn install
 ```
 ## Configure
-Create an `.env` file to store private info. Add the variables below.
-```
-CLUSTER=mainnet-beta
-WALLET_PRIVATE_KEY=abc123def456
-```
-Create your own `dcaconfig.ts`. See `dcaconfig-example.ts` for a template. 
+1. Create an `.env` file at the project root. See `.env-example`. 
+Private key can be obtained from Phantom via Settings -> Export Private Key.
+2. Create your own `dcaconfig.ts`. See `dcaconfig-example.ts` for a template. 
 
 To see example cron expressions, check out [crontab.guru](https://crontab.guru/).
 ## Run
 ```
 yarn start
 ```
-## Development
-```
-yarn add --dev node-cron
-yarn add --dev @types/node-cron
-```

img/demo.gif

@@ -1,7 +1,7 @@
 {
   "name": "jup-dca-bot",
-  "version": "1.0.0",
-  "description": "dollar cost averaging bot",
+  "version": "0.1.0",
+  "description": "Dollar cost averaging bot on Solana",
   "source": "src/index.ts",
   "main": "src/index.ts",
   "module": "dist/module.js",
@@ -15,18 +15,19 @@
   "dependencies": {
     "@jup-ag/core": "^1.0.0-beta.16",
     "@solana/wallet-adapter-base": "^0.7.1",
+    "@solana/web3.js": "^1.36.0",
     "@types/bs58": "^4.0.1",
     "@types/isomorphic-fetch": "^0.0.35",
     "bs58": "^4.0.1",
+    "cronstrue": "^1.125.0",
     "dotenv": "^10.0.0",
     "isomorphic-fetch": "^3.0.0",
-    "node-fetch": "^3.1.0",
-    "ts-node": "^10.4.0"
+    "node-cron": "^3.0.0",
+    "node-fetch": "^3.1.0"
   },
   "devDependencies": {
-    "@solana/web3.js": "^1.36.0",
     "@types/node-cron": "^3.0.1",
-    "node-cron": "^3.0.0",
+    "ts-node": "^10.7.0",
     "typescript": "^4.5.3"
   },
   "resolutions": {

package.json

@@ -1,17 +1,8 @@
-import { Cluster, Keypair } from "@solana/web3.js";
+import { Keypair } from "@solana/web3.js";
 import bs58 from "bs58";
-
 import 'dotenv/config'
 
-// Endpoints, connection
-export const ENV: Cluster = (process.env.CLUSTER as Cluster) || "mainnet-beta";
-
-// Sometimes, your RPC endpoint may reject you if you spam too many RPC calls. Sometimes, your PRC server
-// may have invalid cache and cause problems.
-export const SOLANA_RPC_ENDPOINT =
-  ENV === "devnet"
-    ? "https://api.devnet.solana.com"
-    : "https://ssc-dao.genesysgo.net";
+export const SOLANA_RPC_ENDPOINT: string = process.env.RPC_ENDPOINT!;
 
 // Wallets
 export const WALLET_PRIVATE_KEY =

src/constants/index.ts

@@ -29,4 +29,4 @@ export const dcaconfig: DcaConfig[] = [
         slippage: 1,
         cron: "* * * * *"
     },
-];
+];

src/dcaconfig-example.ts

@@ -1,14 +1,9 @@
 import fetch from "isomorphic-fetch";
-import { Jupiter, RouteInfo, TOKEN_LIST_URL } from "@jup-ag/core";
+import { Jupiter, TOKEN_LIST_URL } from "@jup-ag/core";
 import { PublicKey, Connection } from "@solana/web3.js";
 import * as cron from "node-cron";
-import {
-  ENV,
-  MINT_ADDRESSES,
-  SOLANA_RPC_ENDPOINT,
-  Token,
-  USER_KEYPAIR,
-} from "./constants";
+import cronstrue from "cronstrue";
+import {Token, MINT_ADDRESSES, USER_KEYPAIR, SOLANA_RPC_ENDPOINT} from "./constants";
 import { dcaconfig } from './dcaconfig'
 
 const jupiterSwap = async ({
@@ -61,11 +56,11 @@ const jupiterSwap = async ({
           process.stdout.write(
             `${swapResult.outputAmount / (10 ** inputToken.decimals)} `
           );
-          process.stdout.write(`${outputToken.symbol} -> `);
+          process.stdout.write(`${outputToken.symbol}: `);
           console.log(`https://solscan.io/tx/${swapResult.txid}`);
         }
       } else {
-        console.log("Error: Jupiter couldn't route.");
+        console.log("Error during jupiter.computeRoutes().");
       }
   } catch (error) {
     throw error;
@@ -74,33 +69,36 @@ const jupiterSwap = async ({
 
 const main = async () => {
   try {
-    const connection = new Connection(SOLANA_RPC_ENDPOINT); // Setup Solana
+    console.log("Starting Jupiter DCA Bot");
+
+    const cluster = "mainnet-beta"; // Force mainnet, as this uses Jupiter which is not deployed on devnet/testnet
+    const connection = new Connection(SOLANA_RPC_ENDPOINT);
     const jupiter = await Jupiter.load({
         connection,
-        cluster: ENV,
-        user: USER_KEYPAIR, // or public key
+        cluster: cluster,
+        user: USER_KEYPAIR,
     });
 
     // Fetch token list from Jupiter API
-    const tokens: Token[] = await (await fetch(TOKEN_LIST_URL[ENV])).json();
+    const tokens: Token[] = await (await fetch(TOKEN_LIST_URL[cluster])).json();
 
-    console.log("Validating dcaconfig.");
-    console.log("A job may be excluded because:");
+    console.log("Warning! dcaconfig entries may be excluded due to:");
     console.log("- invalid cron expression");
     console.log("- inputToken or outputToken does not exist in MINT_ADDRESSES");
+    console.log("Validating dcaconfig.ts ...");
     const filteredJobs = dcaconfig.filter(job => {
       return (cron.validate(job.cron) 
         && job.inputToken in MINT_ADDRESSES 
         && job.outputToken in MINT_ADDRESSES
       );
     });
 
-    console.log("Scheduling the following jobs: ");
+    console.log("Scheduling swaps:");
     filteredJobs.map(job => {
-      console.log(`${job.amount} ${job.inputToken} -> ${job.outputToken}. cron: ${job.cron}`);
+      console.log(`${job.amount} ${job.inputToken} for ${job.outputToken} ${cronstrue.toString(job.cron)}`);
     });
 
-    const scheduledJobs = filteredJobs.map(job => {
+    filteredJobs.forEach(job => {
       const inputToken = tokens.find((t) => 
         t.address == MINT_ADDRESSES[job.inputToken]
       );

src/index.ts

@@ -557,6 +557,11 @@ create-require@^1.1.0:
   resolved "https://registry.yarnpkg.com/create-require/-/create-require-1.1.1.tgz#c1d7e8f1e5f6cfc9ff65f9cd352d37348756c333"
   integrity sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==
 
+cronstrue@^1.125.0:
+  version "1.125.0"
+  resolved "https://registry.yarnpkg.com/cronstrue/-/cronstrue-1.125.0.tgz#8030816d033d00caade9b2a9f9b71e69175bcf42"
+  integrity sha512-qkC5mVbVGuuyBVXmam5anaRtbLcgfBUKajoyZqCdf/XBdgF43PsLSEm8eEi2dsI3YbqDPbLSH2mWNzM1dVqHgQ==
+
 cross-fetch@3.0.6:
   version "3.0.6"
   resolved "https://registry.yarnpkg.com/cross-fetch/-/cross-fetch-3.0.6.tgz#3a4040bc8941e653e0e9cf17f29ebcd177d3365c"
@@ -1235,10 +1240,10 @@ traverse-chain@~0.1.0:
   resolved "https://registry.yarnpkg.com/traverse-chain/-/traverse-chain-0.1.0.tgz#61dbc2d53b69ff6091a12a168fd7d433107e40f1"
   integrity sha1-YdvC1Ttp/2CRoSoWj9fUMxB+QPE=
 
-ts-node@^10.4.0:
-  version "10.6.0"
-  resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.6.0.tgz#c3f4195d5173ce3affdc8f2fd2e9a7ac8de5376a"
-  integrity sha512-CJen6+dfOXolxudBQXnVjRVvYTmTWbyz7cn+xq2XTsvnaXbHqr4gXSCNbS2Jj8yTZMuGwUoBESLaOkLascVVvg==
+ts-node@^10.7.0:
+  version "10.7.0"
+  resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.7.0.tgz#35d503d0fab3e2baa672a0e94f4b40653c2463f5"
+  integrity sha512-TbIGS4xgJoX2i3do417KSaep1uRAW/Lu+WAL2doDHC0D6ummjirVOXU5/7aiZotbQ5p1Zp9tP7U6cYhA0O7M8A==
   dependencies:
     "@cspotcode/source-map-support" "0.7.0"
     "@tsconfig/node10" "^1.0.7"