Merge #257

257: Improve template project experience r=luckysori a=luckysori

Fixes #205.

Co-authored-by: Lucas Soriano del Pino <l.soriano.del.pino@gmail.com>

Author: bors[bot]

new_project/.gitignore

@@ -1 +1,2 @@
 yarn-error.log
+node_modules/

new_project/README.md

@@ -0,0 +1,24 @@
+This project was bootstrapped with [Create Comit App](https://github.com/comit-network/create-comit-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `yarn create comit-app start-env`
+
+Sets up the development environment, starting blockchain nodes and COMIT nodes.
+
+This command will take hold of your terminal; to run an application using the environment you will have to use a separate terminal.
+To clean up the environment, press `CTRL-C`.
+
+### `yarn start`
+
+Displays the environment variables created during environment set-up.
+
+## Example Projects
+
+There are 3 example projects included in the `examples` directory which may guide you when developing your COMIT application:
+
+- [Simple Bitcoin for Ether atomic swap using COMIT](./examples/btc_eth/README.md).
+- [Simple ERC20 token for Bitcoin atomic swap using COMIT](./examples/erc20_btc/README.md).
+- [Two applications interacting to negotiate and execute an atomic swap](./examples/separate_apps/README.md).

new_project/examples/btc_eth/src/index.ts

@@ -123,7 +123,7 @@ function createSwap(maker: Actor, taker: Actor): SwapRequest {
 function checkEnvFile(path: string) {
     if (!fs.existsSync(path)) {
         console.log(
-            "Could not find %s file. Did you run \\`create-comit-app start-env\\`?",
+            "Could not find file %s. Did you run `yarn create comit-app start-env`?",
             path
         );
         process.exit(1);

new_project/examples/erc20_btc/src/index.ts

@@ -140,7 +140,7 @@ function createSwap(maker: Actor, taker: Actor): SwapRequest {
 function checkEnvFile(path: string) {
     if (!fs.existsSync(path)) {
         console.log(
-            "Could not find %s file. Did you run \\`create-comit-app start-env\\`?",
+            "Could not find file %s. Did you run `yarn create comit-app start-env`?",
             path
         );
         process.exit(1);

new_project/examples/separate_apps/src/lib.ts

@@ -32,7 +32,7 @@ export async function createActor(index: number): Promise<Actor> {
 export function checkEnvFile(path: string) {
     if (!fs.existsSync(path)) {
         console.log(
-            "Could not find %s file. Did you run \\`create-comit-app start-env\\`?",
+            "Could not find file %s. Did you run `yarn create comit-app start-env`?",
             path
         );
         process.exit(1);

new_project/package.json

@@ -1,7 +1,14 @@
 {
   "name": "new_project",
-  "version": "1.0.0",
+  "version": "0.1.0",
+  "private": true,
+  "main": "index.js",
+  "scripts": {
+    "start": "DOTENV_CONFIG_PATH=$HOME/.create-comit-app/env node -r dotenv/config ./src/index.js"
+  },
   "dependencies": {
-    "comit-sdk": "^0.7.0"
+    "comit-sdk": "^0.7.1",
+    "dotenv": "^8.2.0",
+    "readline-sync": "^1.4.10"
   }
 }

new_project/src/index.js

@@ -0,0 +1,46 @@
+const fs = require("fs");
+
+const configPath = process.env.DOTENV_CONFIG_PATH;
+
+if (fs.existsSync(configPath)) {
+  console.log("Environment configuration:");
+
+  // Bitcoin HD keys with address funded during environment set-up.
+  // Used to initialize Bitcoin wallets with funds.
+  console.log("Bitcoin HD keys:");
+  console.log("1. ", process.env.BITCOIN_HD_KEY_0);
+  console.log("2. ", process.env.BITCOIN_HD_KEY_1);
+
+  // The URI of the regtest Bitcoin node created during environment set-up.
+  // Used to initialize Bitcoin wallets connected to the correct local network.
+  console.log("Bitcoin node P2P URI: ", process.env.BITCOIN_P2P_URI);
+
+  // Ethereum private keys with address funded during environment set-up.
+  // Used to initialize Ethereum wallets with funds.
+  console.log("Ethereum private keys:");
+  console.log("1. ", process.env.ETHEREUM_KEY_0);
+  console.log("2. ", process.env.ETHEREUM_KEY_1);
+
+  // The URL for the HTTP API of the regtest Ethereum node created during environment set-up.
+  // Used to initialize Ethereum wallets connected to the correct local network.
+  console.log("Ethereum node HTTP URL: ", process.env.ETHEREUM_NODE_HTTP_URL);
+
+  // The contract address of the ERC20 token deployed on the regtest network during environment set-up.
+  // Used to identify the ERC20 token when performing swaps.
+  console.log(
+    "ERC20 token contract address: ",
+    process.env.ERC20_CONTRACT_ADDRESS
+  );
+
+  // HTTP API URLs for the instances of cnd created during environment set-up.
+  // Used to interact with said instances of cnd. In particular, it allows for
+  // instantiating `ComitClient`s when using `comit-sdk`.
+  console.log("cnd HTTP API URLs:");
+  console.log("1. ", process.env.HTTP_URL_CND_0);
+  console.log("2. ", process.env.HTTP_URL_CND_1);
+} else {
+  console.log(
+    "Could not find file %s. Did you run `yarn create comit-app start-env`?",
+    configPath
+  );
+}