Skip to content

Commit ef525d2

Browse files
committed
Initialize lnc-core
1 parent d5f1d35 commit ef525d2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+30419
-2
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.DS_Store
2+
node_modules/
3+
dist/

.prettierignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.github/**
2+
dist/**
3+
lib/types/**
4+
package-lock.json
5+
package.json
6+
README.md
7+
tsconfig.json
8+
tslint.json

.prettierrc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"singleQuote": true,
3+
"tabWidth": 4,
4+
"semi": true,
5+
"trailingComma": "none",
6+
"bracketSpacing": true
7+
}

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
1-
# lnc-core
2-
Type definitions and utilities for Lightning Node Connect, leveraged by lnc-web and lnc-rn
1+
# @lightninglabs/lnc-core
2+
3+
## Type definitions and utilities for Lightning Node Connect, leveraged by lnc-web and lnc-rn
4+
5+
## Install
6+
7+
`npm i @lightninglabs/lnc-core`
8+
9+
## Updating protos
10+
11+
First, update the service version under the `config` block in `package.json`.
12+
13+
eg.
14+
15+
```
16+
"config": {
17+
"lnd_release_tag": "v0.14.2-beta",
18+
"loop_release_tag": "v0.17.0-beta",
19+
"pool_release_tag": "v0.5.5-alpha",
20+
"faraday_release_tag": "v0.2.5-alpha",
21+
"protoc_version": "3.15.8"
22+
},
23+
```
24+
25+
Then run the following commands:
26+
27+
```
28+
# download schemas
29+
npm run update-protos
30+
# format schemas
31+
npm run generate
32+
```

lib/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
export * from './types/proto';
2+
export { camelKeysToSnake, isObject, snakeKeysToCamel } from './util/objects';

lib/types/proto/autopilotrpc.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export * from './lnd/autopilotrpc/autopilot';

lib/types/proto/chainrpc.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export * from './lnd/chainrpc/chainnotifier';

0 commit comments

Comments
 (0)