[Layout] Add IPFS interfaces and github workflow

.github/workflows/pr.yml

@@ -0,0 +1,16 @@
+name: PR
+on: [pull_request]
+
+jobs:
+  pr:
+    strategy:
+      matrix:
+        step: ['lint', 'build']
+    name: ${{ matrix.step }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: ${{ matrix.step }}
+      run: |
+        yarn
+        yarn ${{ matrix.step }}

package.json

@@ -19,11 +19,13 @@
     "posttest": "yarn run lint"
   },
   "dependencies": {
-    "@polkadot/api": "^2.2.1",
+    "@polkadot/api": "^2.5.1",
+    "bignumber.js": "^9.0.1",
     "ipfs-http-client": "^48.0.0",
     "lodash": "^4.17.20"
   },
   "devDependencies": {
+    "@types/bignumber.js": "^5.0.0",
     "@types/lodash": "^4.14.164",
     "@types/node": "^14.14.6",
     "gts": "^3.0.2",

src/ipfs/index.ts

@@ -1,3 +1,74 @@
+import {BigNumber} from 'bignumber.js';
 const IpfsHttpClient = require('ipfs-http-client');
+const {CID} = require('ipfs-http-client');
 
-export class IPFS {}
+export default class Ipfs {
+  private ipfs: any;
+
+  constructor(ipfsAddr: string, mto: number) {
+    this.ipfs = IpfsHttpClient({
+      address: ipfsAddr,
+      timeout: mto,
+    });
+  }
+
+  /// WRITE methods
+  /**
+   * Pin add file by a given cid asyncly
+   * @param c ipfs cid value
+   * @throws illegal cid | timeout
+   */
+  async pin(c: string): Promise<boolean> {
+    const cid = new CID(c);
+    const pin = await this.ipfs.pin.add(new CID(cid));
+    return cid.equals(pin);
+  }
+
+  /**
+   * Pin remove file by a given cid
+   * @param c ipfs cid value
+   * @throws illegal cid | unpinned `c` | timeout
+   */
+  async unpin(c: string): Promise<boolean> {
+    const cid = new CID(c);
+    const pin = await this.ipfs.pin.rm(cid);
+    return cid.equals(pin);
+  }
+
+  /// READONLY methods
+  /**
+   * Get file size by a given cid
+   * @param cid ipfs cid value
+   * @returns file size (bytes)
+   * @throws illegal cid | timeout
+   */
+  async size(cid: string): Promise<number> {
+    const objInfo = await this.ipfs.object.stat(new CID(cid));
+    return objInfo.CumulativeSize;
+  }
+
+  /**
+   * Query if a given cid(recursive type) exist
+   * @param c ipfs cid value
+   * @throws illegal cid | timeout
+   */
+  async exist(c: string): Promise<boolean> {
+    const cid = new CID(c);
+    for await (const pin of this.ipfs.pin.ls({
+      paths: cid,
+      type: 'recursive',
+    })) {
+      if (cid.equals(pin.cid)) return true;
+    }
+    return false;
+  }
+
+  /**
+   * @returns ipfs remaining storage
+   * @throws timeout
+   */
+  async free(): Promise<BigNumber> {
+    const repoStat = await this.ipfs.repo.stat();
+    return repoStat.storageMax.minus(repoStat.repoSize);
+  }
+}

src/queue/index.ts

@@ -3,6 +3,8 @@ import * as _ from 'lodash';
 export interface Task {
   // The ipfs cid value
   cid: string;
+  // Object size
+  size: number;
   // Current block number
   bn: number;
 }

tsconfig.json

@@ -1,8 +1,12 @@
 {
   "extends": "./node_modules/gts/tsconfig-google.json",
   "compilerOptions": {
-    "rootDir": ".",
-    "outDir": "build"
+    "target": "es6",
+    "module": "commonjs",
+    "rootDir": "./",
+    "outDir": "build",
+    "skipLibCheck": true,
+    "strict": true
   },
   "include": [
     "src/**/*.ts",