feat: add script to configure private IPFS network (#458)

Author: rittme

packages/ethereum-storage/README.md

@@ -82,12 +82,23 @@ In order to use the package in a test environment, IPFS can be installed locally
 
 ```bash
 npm install ipfs --global
-ipfs init
+yarn ipfs-init #documented below
 ipfs daemon
 ```
 
 Local IPFS listening on port 5001 is used by default by the `ethereum-storage` package.
 
+### Setup IPFS private network
+
+Request uses a private network to allow all nodes to connect to each other directly,
+instead of having to navigate through the global IPFS network.
+
+To setup your IPFS node to the private network, you can run the following utility script:
+
+```bash
+yarn init-ipfs
+```
+
 ## Contributing
 
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

packages/ethereum-storage/package.json

@@ -47,7 +47,8 @@
     "test:lib": "nyc mocha --timeout=5000 --require ts-node/register --require source-map-support/register \"test/lib/**/*.ts\"",
     "test:lib:watch": "nyc mocha --watch --watch-extensions ts --timeout=5000 --require ts-node/register --require source-map-support/register \"test/lib/**/*.ts\"",
     "test:sol": "truffle test --contracts_directory=./src test/contracts/*.js",
-    "test": "yarn run test:lib && yarn run test:sol"
+    "test": "yarn run test:lib && yarn run test:sol",
+    "init-ipfs": "node scripts/init-ipfs.js"
   },
   "dependencies": {
     "@requestnetwork/types": "0.2.0",
@@ -58,9 +59,11 @@
     "ipfs-unixfs": "0.1.16",
     "keyv": "3.1.0",
     "node-fetch": "2.6.0",
+    "shelljs": "0.8.3",
     "sinon": "7.3.2",
     "web3-eth": "1.0.0-beta.37",
-    "web3-utils": "1.0.0-beta.37"
+    "web3-utils": "1.0.0-beta.37",
+    "yargs": "12.0.5"
   },
   "devDependencies": {
     "@types/bluebird": "3.5.27",

packages/ethereum-storage/scripts/init-ipfs.js

@@ -0,0 +1,111 @@
+/* eslint-disable spellcheck/spell-checker */
+const shell = require('shelljs');
+const fs = require('fs');
+const path = require('path');
+
+const argv = require('yargs')
+  .usage('Usage: $0 [options]')
+  // Allow the user to force IPFS config override
+  .option('force', {
+    alias: 'f',
+    describe: 'Force the private IPFS config even if a config already exists',
+    type: 'boolean',
+  })
+  // Get IPFS path from cli argument, environment variable or expected default path
+  .option('path', {
+    alias: 'p',
+    describe:
+      'The path to the IPFS config directory (the default path is usually already set on IPFS_PATH environment variable)',
+    nargs: 1,
+    type: 'string',
+    default: process.env.IPFS_PATH || path.join(require('os').homedir(), '.ipfs'),
+  }).argv;
+
+// Swarm key content
+const swarmKeyContent = `/key/swarm/psk/1.0.0/
+/base16/
+5f3af0599d991e5eb4c37da2472aa299759ee3350ba26c125d0c7579dd04dd52
+`;
+
+// Exit if IPFS is not installed
+if (!shell.which('ipfs')) {
+  shell.echo('IPFS is not installed or not in the PATH');
+  shell.exit(1);
+}
+
+const ipfsPath = argv.path;
+shell.echo('IPFS Path:');
+shell.echo(ipfsPath);
+
+// Initialize the IPFS node
+initializeNode(ipfsPath);
+
+// Setup the swarm key file
+setupSwarmKey(ipfsPath, swarmKeyContent);
+
+shell.echo('Done');
+shell.exit(0);
+
+/**
+ * Initialize the IPFS node with private network settings
+ */
+function initializeNode(ipfsPath) {
+  // Check if the ipfs folder exists and if it is writable.
+  try {
+    fs.accessSync(ipfsPath, fs.constants.F_OK | fs.constants.W_OK);
+    // If --force argument is set, the config will be overwritten
+    if (argv.force) {
+      shell.echo('IPFS config already exists. Force argument set, overriding it.');
+    } else {
+      shell.echo('IPFS config already exists (use --force if you want to override it)');
+      shell.exit(0);
+    }
+  } catch (err) {
+    if (err.code !== 'ENOENT') {
+      shell.echo(`No read access to ipfs config folder: ${ipfsPath}`);
+      shell.exit(1);
+    }
+
+    // Initializing ipfs repo
+    shell.echo('No IPFS repo found in $IPFS_PATH. Initializing...');
+    shell.exec('ipfs init');
+  }
+
+  // Reinitialize bootstrap nodes
+  shell.echo('Removing all bootstrap nodes...');
+  shell.echo(
+    '(see https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md#private-networks)',
+  );
+  shell.exec('ipfs bootstrap rm --all');
+
+  shell.echo('Adding private swarm bootstrap nodes...');
+  shell.exec(
+    `ipfs bootstrap add /dns4/ipfs-bootstrap.request.network/tcp/4001/ipfs/QmPBPgTDVjveRu6KjGVMYixkCSgGtVyV8aUe6wGQeLZFVd /dns4/ipfs-bootstrap-2.request.network/tcp/4001/ipfs/QmYdcSoVNU1axgSnkRAyHtwsKiSvFHXeVvRonGCAV9LVEj /dns4/ipfs-2.request.network/tcp/4001/ipfs/QmPBPgTDVjveRu6KjGVMYixkCSgGtVyV8aUe6wGQeLZFVd /dns4/ipfs-survival.request.network/tcp/4001/ipfs/Qmb6a5DH45k8JwLdLVZUhRhv1rnANpsbXjtsH41esGhNCh`,
+  );
+}
+
+/**
+ * Setup the IPFS private swarm key
+ */
+function setupSwarmKey(ipfsPath, swarmKeyContent) {
+  const swarmKeyPath = path.join(ipfsPath, 'swarm.key');
+  // Check if the swarm key file exists
+  try {
+    fs.accessSync(swarmKeyPath, fs.constants.F_OK | fs.constants.W_OK);
+    return;
+  } catch (err) {
+    shell.echo('No swarm.key found, creating a new key.');
+  }
+
+  // Create a new swarm key file
+  try {
+    fs.writeFileSync(swarmKeyPath, swarmKeyContent, {
+      mode: 0o600,
+    });
+  } catch (err) {
+    throw new Error(`Error creating swarm key file: ${err.message}`);
+    return;
+  }
+
+  shell.echo('Swarm key file created.');
+}

packages/request-node/README.md

@@ -169,6 +169,20 @@ npm install
 npm run build
 ```
 
+### Setup
+
+#### IPFS private network
+
+The Request Node uses IPFS to store and share transactions in a private network.
+We use a private network to allow all nodes to connect to each other directly,
+instead of having to navigate through the global IPFS network.
+
+To setup your IPFS node to the private network, you can run the following utility script:
+
+```bash
+yarn init-ipfs
+```
+
 ### Launch
 
 #### Command line
@@ -315,23 +329,30 @@ yarn build
 #### 3. On a new terminal, launch a local [IPFS node](https://docs.ipfs.io/introduction/install/)
 
 ```bash
-ipfs daemon --offline
+ipfs daemon
+```
+
+#### 4. On a new terminal, configure your IPFS node to connect to the private Request IPFS network
+
+```bash
+cd packages/request-node
+yarn init-ipfs
 ```
 
-#### 4. On a new terminal, launch [ganache](https://github.com/trufflesuite/ganache-cli#installation) with the default Request Node mnemonic
+#### 5. Launch [ganache](https://github.com/trufflesuite/ganache-cli#installation) with the default Request Node mnemonic
 
 ```bash
 ganache-cli -l 90000000 -p 8545 -m \"candy maple cake sugar pudding cream honey rich smooth crumble sweet treat\"
 ```
 
-#### 5. Deploy the smart contracts on ganache
+#### 6. Deploy the smart contracts on ganache
 
 ```bash
 cd packages/ethereum-storage
 yarn deploy
 ```
 
-#### 6. Run the Request Node
+#### 7. Run the Request Node
 
 ```bash
 cd ../packages/request-node

packages/request-node/init-ipfs.js

@@ -0,0 +1 @@
+../ethereum-storage/scripts/init-ipfs.js

packages/request-node/package.json

@@ -37,7 +37,8 @@
     "start:watch": "ts-node-dev src/server.ts",
     "clean": "shx rm -rf dist",
     "lint-staged": "lint-staged",
-    "lint": "tslint --project ."
+    "lint": "tslint --project .",
+    "init-ipfs": "node init-ipfs.js"
   },
   "dependencies": {
     "@requestnetwork/data-access": "0.2.0",
@@ -50,6 +51,7 @@
     "express": "4.17.1",
     "http-status-codes": "1.3.0",
     "keyv-file": "0.1.13",
+    "shelljs": "0.8.3",
     "truffle-hdwallet-provider": "1.0.3",
     "yargs": "12.0.5"
   },

yarn.lock

@@ -9821,7 +9821,7 @@ shell-quote@^1.6.1:
     array-reduce "~0.0.0"
     jsonify "~0.0.0"
 
-shelljs@^0.8.1:
+shelljs@^0.8.1, shelljs@^0.8.3:
   version "0.8.3"
   resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.8.3.tgz#a7f3319520ebf09ee81275b2368adb286659b097"
   integrity sha512-fc0BKlAWiLpwZljmOvAOTE/gXawtCoNrP5oaY7KIaQbbyHeQVg01pSEuEGvGh3HEdBU4baCD7wQBwADmM/7f7A==