Merge pull request #1 from lightninglabs/init-project

Initialize lnc-core

Author: kaloudis

.gitignore

@@ -0,0 +1,3 @@
+*.DS_Store
+node_modules/
+dist/

.prettierignore

@@ -0,0 +1,8 @@
+.github/**
+dist/**
+lib/types/**
+package-lock.json
+package.json
+README.md
+tsconfig.json
+tslint.json

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "tabWidth": 4,
+  "semi": true,
+  "trailingComma": "none",
+  "bracketSpacing": true
+}

README.md

@@ -1,2 +1,32 @@
-# lnc-core
-Type definitions and utilities for Lightning Node Connect, leveraged by lnc-web and lnc-rn
+# @lightninglabs/lnc-core
+
+## Type definitions and utilities for Lightning Node Connect, leveraged by lnc-web and lnc-rn
+
+## Install
+
+`npm i @lightninglabs/lnc-core`
+
+## Updating protos
+
+First, update the service version under the `config` block in `package.json`.
+
+eg.
+
+```
+"config": {
+    "lnd_release_tag": "v0.14.2-beta",
+    "loop_release_tag": "v0.17.0-beta",
+    "pool_release_tag": "v0.5.5-alpha",
+    "faraday_release_tag": "v0.2.5-alpha",
+    "protoc_version": "3.15.8"
+},
+```
+
+Then run the following commands:
+
+```
+# download schemas
+npm run update-protos
+# format schemas
+npm run generate
+```

lib/api/faraday.ts

@@ -0,0 +1,15 @@
+import { FaradayServer } from '../types/proto/faraday/faraday';
+import { serviceNames as sn } from '../types/proto/schema';
+
+/**
+ * An API wrapper to communicate with the Faraday node via GRPC
+ */
+class FaradayApi {
+    faradayServer: FaradayServer;
+
+    constructor(createRpc: Function, lnc: any) {
+        this.faradayServer = createRpc(sn.frdrpc.FaradayServer, lnc);
+    }
+}
+
+export default FaradayApi;

lib/api/index.ts

@@ -0,0 +1,4 @@
+export { default as LndApi } from './lnd';
+export { default as LoopApi } from './loop';
+export { default as PoolApi } from './pool';
+export { default as FaradayApi } from './faraday';

lib/api/lnd.ts

@@ -0,0 +1,42 @@
+import { Autopilot } from '../types/proto/lnd/autopilotrpc/autopilot';
+import { ChainNotifier } from '../types/proto/lnd/chainrpc/chainnotifier';
+import { Invoices } from '../types/proto/lnd/invoicesrpc/invoices';
+import { Lightning } from '../types/proto/lnd/lightning';
+import { Router } from '../types/proto/lnd/routerrpc/router';
+import { Signer } from '../types/proto/lnd/signrpc/signer';
+import { WalletKit } from '../types/proto/lnd/walletrpc/walletkit';
+import { WalletUnlocker } from '../types/proto/lnd/walletunlocker';
+import { Watchtower } from '../types/proto/lnd/watchtowerrpc/watchtower';
+import { WatchtowerClient } from '../types/proto/lnd/wtclientrpc/wtclient';
+import { serviceNames as sn } from '../types/proto/schema';
+
+/**
+ * An API wrapper to communicate with the LND node via GRPC
+ */
+class LndApi {
+    autopilot: Autopilot;
+    chainNotifier: ChainNotifier;
+    invoices: Invoices;
+    lightning: Lightning;
+    router: Router;
+    signer: Signer;
+    walletKit: WalletKit;
+    walletUnlocker: WalletUnlocker;
+    watchtower: Watchtower;
+    watchtowerClient: WatchtowerClient;
+
+    constructor(createRpc: Function, lnc: any) {
+        this.autopilot = createRpc(sn.autopilotrpc.Autopilot, lnc);
+        this.chainNotifier = createRpc(sn.chainrpc.ChainNotifier, lnc);
+        this.invoices = createRpc(sn.invoicesrpc.Invoices, lnc);
+        this.lightning = createRpc(sn.lnrpc.Lightning, lnc);
+        this.router = createRpc(sn.routerrpc.Router, lnc);
+        this.signer = createRpc(sn.signrpc.Signer, lnc);
+        this.walletKit = createRpc(sn.walletrpc.WalletKit, lnc);
+        this.walletUnlocker = createRpc(sn.lnrpc.WalletUnlocker, lnc);
+        this.watchtower = createRpc(sn.watchtowerrpc.Watchtower, lnc);
+        this.watchtowerClient = createRpc(sn.wtclientrpc.WatchtowerClient, lnc);
+    }
+}
+
+export default LndApi;

lib/api/loop.ts

@@ -0,0 +1,18 @@
+import { SwapClient } from '../types/proto/loop/client';
+import { Debug } from '../types/proto/loop/debug';
+import { serviceNames as sn } from '../types/proto/schema';
+
+/**
+ * An API wrapper to communicate with the Loop node via GRPC
+ */
+class LoopApi {
+    swapClient: SwapClient;
+    debug: Debug;
+
+    constructor(createRpc: Function, lnc: any) {
+        this.swapClient = createRpc(sn.looprpc.SwapClient, lnc);
+        this.debug = createRpc(sn.looprpc.Debug, lnc);
+    }
+}
+
+export default LoopApi;

lib/api/pool.ts

@@ -0,0 +1,21 @@
+import { ChannelAuctioneer } from '../types/proto/pool/auctioneerrpc/auctioneer';
+import { HashMail } from '../types/proto/pool/auctioneerrpc/hashmail';
+import { Trader } from '../types/proto/pool/trader';
+import { serviceNames as sn } from '../types/proto/schema';
+
+/**
+ * An API wrapper to communicate with the Pool node via GRPC
+ */
+class PoolApi {
+    trader: Trader;
+    channelAuctioneer: ChannelAuctioneer;
+    hashmail: HashMail;
+
+    constructor(createRpc: Function, lnc: any) {
+        this.trader = createRpc(sn.poolrpc.Trader, lnc);
+        this.channelAuctioneer = createRpc(sn.poolrpc.ChannelAuctioneer, lnc);
+        this.hashmail = createRpc(sn.poolrpc.HashMail, lnc);
+    }
+}
+
+export default PoolApi;

lib/index.ts

@@ -0,0 +1,4 @@
+export * from './types/proto';
+export { camelKeysToSnake, isObject, snakeKeysToCamel } from './util/objects';
+export { LndApi, LoopApi, PoolApi, FaradayApi } from './api';
+export { subscriptionMethods } from './types/proto/schema';