Documentation cleanup with new naming convention for the application version

ShahanaFarooqui · ShahanaFarooqui · commit 77fdfb416153 · 2025-07-09T21:12:54.000-07:00
diff --git a/.github/docs/Contributing.md b/.github/docs/Contributing.md
@@ -1,28 +1,129 @@
-Development
------------
-* Clone the project: git clone https://github.com/ElementsProject/cln-application.git
-* Change directory: cd cln-application
-* Install dependencies: Assuming that nodejs (v14 & above) and npm are already installed, run `npm install`.
-* Setup environment variables: Assuming that bitcoind and core-lightning are already running, adjust environment variables listed in `./env.sh` file and execute the script with `'. env.sh'` to setup required environment variables to connect to the node.
-* Setup Commando auth: Update `LIGHTNING_PUBKEY` and `LIGHTNING_RUNE` variables in `.commando` for successful backend authentication and connection via commando. Or run `entrypoint.sh` with correct lightningd path to do the same.
-* Run backend server: Get backend server up by running `npm run backend:serve`.
-* Watch backend server: Watch backend server for realtime changes with `npm run backend:watch`.
-* React frontend server: React development server is set to serve on port 4300. Run `npm run frontend:dev` script to get it working.
-
-
-Releasing and packaging on Github
-----------------------------------
-* Merge the `Release-<x.y.z>` branch into `main` branch.
-* Set VERSION env `VERSION=v<x.y.z>`.
-* Tag the commit with `git tag -a -s ${VERSION} -m ${VERSION} && git push --tags`.
-* Go to repo's `Releases` page and draft a new release from above tag.
-* Prepare release notes with the help of milestone, issues and PRs. Add them on the release page.
-* Signing the release:
-	** `mkdir -p ./release & git archive --format zip --output ./release/cln-application-${VERSION}.zip main`
-	** `cd release`
-	** `sha256sum cln* > SHA256SUMS`
-	** `gpg -sb --armor -o SHA256SUMS.asc SHA256SUMS`
-* Verify the release with `gpg --verify SHA256SUMS.asc`.
-* Upload `cln-application-${VERSION}.zip`, `SHA256SUMS` and `SHA256SUMS.asc` files on release assets.
-* Go to repo's `Actions` tab and confirm that actions have been triggered for `Artifact` and `Build and publish Github image`.
-* Confirm that both actions finished successfully and the latest package is available at `https://github.com/orgs/ElementsProject/packages?repo_name=cln-application`.
+Development Setup
+------------------
+### Prerequisites
+- Node.js (v14 or higher)
+- npm
+- Running instances of bitcoind and core-lightning
+
+### Installation
+#### Clone the repository:
+
+```sh
+git clone https://github.com/ElementsProject/cln-application.git
+cd cln-application
+```
+
+#### Install dependencies:
+
+```sh
+npm install
+```
+
+#### Configure environment:
+
+```sh
+cp env.sh env-local.sh
+# Edit env-local.sh with your configuration
+source env-local.sh
+```
+
+#### Set up Commando authentication:
+- Manually update `LIGHTNING_PUBKEY` and `LIGHTNING_RUNE` in your `LIGHTNING_VARS_FILE`
+- OR Run the setup script:
+
+```sh
+source entrypoint.sh
+```
+
+Running the Application
+------------------------
+### Backend server:
+
+```sh
+npm run backend:watch
+npm run backend:serve
+```
+
+### Frontend development server (port 4300):
+```sh
+npm run frontend:dev
+```
+
+Creating a Pull Request
+------------------------
+- Fork the repository on GitHub
+- Create a feature branch:
+
+```sh
+git checkout -b feat/your-feature-name
+```
+- Commit your changes:
+
+```sh
+git commit -m "feat: description of your changes"
+```
+- Push to your fork:
+
+```sh
+git push fork feat/your-feature-name
+```
+- Open a PR against the next-release branch
+	- Include clear description
+	- Add relevant labels
+	- Request reviews from maintainers
+
+- Code Standards
+	- Include tests for new features
+	- Update documentation when adding/changing functionality
+	- Keep commits atomic and well-described
+
+- Basic Git Workflow:
+<p align="center">
+	<img src="./.github/images/basic-git-flow.jpg" alt="Basic Github Workflow">
+</p>
+
+Release Process
+----------------
+
+- Merge the release branch into main:
+
+```sh
+git checkout main
+git merge Release-yy.mm.n
+```
+- Create versioned tag:
+
+```sh
+export VERSION=vyy.mm.n
+git tag -a -s $VERSION -m "$VERSION"
+git push --tags
+```
+
+- Creating the Release On GitHub:
+	- Go to Repository → Releases → Draft new release
+	- Select the tag you created
+	- Add release notes summarizing changes
+
+- Package and sign the release:
+
+```sh
+mkdir -p ./release
+git archive --format zip --output ./release/cln-application-${VERSION}.zip main
+cd release
+sha256sum cln* > SHA256SUMS
+gpg -sb --armor -o SHA256SUMS.asc SHA256SUMS
+```
+
+- Verify the signature:
+
+```sh
+gpg --verify SHA256SUMS.asc
+```
+
+- Upload to GitHub:
+	- Add cln-application-${VERSION}.zip
+	- Add SHA256SUMS and SHA256SUMS.asc
+
+- Post-Release Checks
+	- Verify CI/CD pipelines complete successfully
+	- Confirm package availability at: https://github.com/orgs/ElementsProject/packages?repo_name=cln-application
diff --git a/.github/images/basic-git-flow.jpg b/.github/images/basic-git-flow.jpg
diff --git a/README.md b/README.md
@@ -52,30 +52,33 @@
       This application accepts & depends upon these variables to be passed through environment:
 
       ```
-      - BITCOIN_HOST: Hostname/IP address of bitcoin node container (configurable to run lightningd with `--bitcoin-rpcconnect`, default: `localhost`)
-      - BITCOIN_NETWORK: Bitcoin network type (for entrypoint.sh and lightningd with `--network`; valid values: bitcoin/signet/testnet/regtest; default: `bitcoin`)
+      # Required by entrypoint.sh script
+      - LIGHTNING_DATA_DIR: Path for core lightning (used by entrypoint.sh, default: ``)
+      - BITCOIN_NETWORK: Bitcoin network type (for entrypoint.sh; valid values: bitcoin/signet/testnet/regtest; default: `bitcoin`)
 
+      # cln-application Values
       - APP_SINGLE_SIGN_ON: Flag to bypass application level authentication (valid values: true/false, default: false)
       - APP_PROTOCOL: Protocol on which the application will be served (valid values: http/https, default: `http`)
       - APP_HOST: Hostname/IP address of cln-application's container (default: `localhost`)
       - APP_PORT: Port on which this application should be served (default: `2103`)
-
       - APP_CONFIG_FILE: Path for cln-application's configuration file (default: `./config.json`)
       - APP_LOG_FILE: Path for cln-application's log file (default: `./application-cln.log`)
       - APP_MODE: Mode for logging and other settings (valid values: production/development/testing, default: `production`)
       - APP_CONNECT: Choose how to connect to CLN (valid values: COMMANDO/REST/GRPC, default: `COMMANDO`)
 
-      - LIGHTNING_DATA_DIR: Path for core lightning (used by entrypoint.sh, default: ``)
+      # Core lightning Values
       - LIGHTNING_HOST: IP address of Core lightning node container (used for `COMMANDO` APP_CONNECT, default: `localhost`)
       - LIGHTNING_TOR_HOST: REST hidden service url (default: ``)
-      
       - LIGHTNING_VARS_FILE: Full Path including the file name for connection auth with LIGHTNING_PUBKEY & LIGHTNING_RUNE (defult: `./.commando-env`)
+
+      # CLN Commando (WS) Values
       - LIGHTNING_WS_PROTOCOL: Core lightning's web socket is serving on ws or serving via WSSProxy (valid values: ws/wss, default: `ws`)
       - LIGHTNING_WS_PORT: Core lightning's websocket port (used by `COMMANDO` APP_CONNECT; with `bind-addr=ws:`/`wss-bind-addr` in CLN config; default: `5001`)
       - LIGHTNING_WS_CLIENT_KEY_FILE: Client key file path including file name for websocket TLS authentication (used by `COMMANDO` APP_CONNECT and `wss` LIGHTNING_WS_PROTOCOL; default: `./client-key.pem`)
       - LIGHTNING_WS_CLIENT_CERT_FILE: Client certificate file path including file name for websocket TLS authentication (used by `COMMANDO` APP_CONNECT and `wss` LIGHTNING_WS_PROTOCOL; default: `./client.pem`)
       - LIGHTNING_WS_CA_CERT_FILE: CA certificate file path including file name for websocket TLS authentication (default: `./ca.pem`)
 
+      # CLN REST Values
       - LIGHTNING_REST_PROTOCOL: Protocol on which REST is served (valid values: http/https, default: `https`)
       - LIGHTNING_REST_HOST: IP address/hostname of Core Lightning REST interface (used if APP_CONNECT is `REST`, default: `localhost`)
       - LIGHTNING_REST_TOR_HOST: Tor hidden service URL for Core Lightning REST interface (default: ``)
@@ -84,6 +87,7 @@
       - LIGHTNING_REST_CLIENT_CERT_FILE: Client certificate file path including file name for REST TLS authentication (default: `./client.pem`)
       - LIGHTNING_REST_CA_CERT_FILE: CA certificate file path including file name for REST TLS authentication (used by `REST` APP_CONNECT and `https` LIGHTNING_REST_PROTOCOL; default: `./ca.pem`)
 
+      # CLN gRPC Values
       - LIGHTNING_GRPC_HOST: IP address/hostname of Core Lightning GRPC interface (used if APP_CONNECT is `GRPC`, default: `localhost`)
       - LIGHTNING_GRPC_TOR_HOST: Tor hidden service URL for Core Lightning GRPC interface (default: ``)
       - LIGHTNING_GRPC_PORT: Core lightning's GRPC port (used if APP_CONNECT is `GRPC`; default: `9736`)
diff --git a/apps/backend/source/shared/consts.ts b/apps/backend/source/shared/consts.ts
@@ -35,7 +35,6 @@ export const SECRET_KEY = crypto.randomBytes(64).toString('hex');
 
 export const DEFAULT_ENV_VALUES = {
   APP_SINGLE_SIGN_ON: 'false',
-  BITCOIN_HOST: 'localhost',
   BITCOIN_NETWORK: 'bitcoin',
   APP_PROTOCOL: 'http',
   APP_HOST: 'localhost',
@@ -72,7 +71,6 @@ export const DEFAULT_ENV_VALUES = {
 
 export const APP_CONSTANTS = {
   APP_SINGLE_SIGN_ON: process.env.APP_SINGLE_SIGN_ON || DEFAULT_ENV_VALUES.APP_SINGLE_SIGN_ON,
-  BITCOIN_HOST: process.env.BITCOIN_HOST || DEFAULT_ENV_VALUES.BITCOIN_HOST,
   BITCOIN_NETWORK: process.env.BITCOIN_NETWORK || DEFAULT_ENV_VALUES.BITCOIN_NETWORK,
   APP_PROTOCOL: process.env.APP_PROTOCOL || DEFAULT_ENV_VALUES.APP_PROTOCOL,
   APP_HOST: process.env.APP_HOST || DEFAULT_ENV_VALUES.APP_HOST,
diff --git a/apps/frontend/src/types/root.type.ts b/apps/frontend/src/types/root.type.ts
@@ -54,7 +54,6 @@ export type NodeInfo = {
 export type WalletConnect = {
   isLoading: boolean;
   APP_SINGLE_SIGN_ON?: boolean;
-  BITCOIN_HOST?: string;
   BITCOIN_NETWORK?: string;
   APP_PROTOCOL?: string;
   APP_HOST?: string;
diff --git a/apps/frontend/src/utilities/test-utilities/mockData.tsx b/apps/frontend/src/utilities/test-utilities/mockData.tsx
@@ -226,7 +226,6 @@ export const mockShowToast = {
 export const mockConnectWallet = {
   isLoading: false,
   APP_SINGLE_SIGN_ON: false,
-  BITCOIN_HOST: "localhost",
   BITCOIN_NETWORK: "regtest",
   APP_PROTOCOL: "http",
   APP_HOST: "localhost",
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -20,13 +20,13 @@ services:
     image: lncm/clightning:v22.11.1@sha256:e9939341ca6736566e0499db5a339b25140d6e77fb16ab202c217112f0df9b77
     command:
       - --bitcoin-rpcconnect=${BITCOIN_HOST}
-      - --bitcoin-rpcuser=${APP_BITCOIN_RPC_USER}
-      - --bitcoin-rpcpassword=${APP_BITCOIN_RPC_PASS}
-      - --bind-addr=${LIGHTNING_IP}:9735
+      - --bitcoin-rpcuser=${BITCOIN_RPC_USER}
+      - --bitcoin-rpcpassword=${BITCOIN_RPC_PASSWORD}
+      - --bind-addr=${LIGHTNING_HOST}:9735
       - --network=${BITCOIN_NETWORK}
       - --database-upgrade=true
       - --grpc-port=${LIGHTNING_GRPC_PORT}
-      - --experimental-websocket-port=${LIGHTNING_WS_PORT}
+      - --bind-addr=ws:127.0.0.1:${LIGHTNING_WS_PORT}
       - --experimental-offers
     restart: on-failure
     volumes:
@@ -35,23 +35,23 @@ services:
       - ${LIGHTNING_WS_PORT}:${LIGHTNING_WS_PORT}
     networks:
       networkcln:
-        ipv4_address: ${LIGHTNING_IP}
+        ipv4_address: ${LIGHTNING_HOST}
 
   lightningd-2:
     image: lncm/clightning:v22.11.1@sha256:e9939341ca6736566e0499db5a339b25140d6e77fb16ab202c217112f0df9b77
     command:
       - --bitcoin-rpcconnect=${BITCOIN_HOST}
-      - --bitcoin-rpcuser=${APP_BITCOIN_RPC_USER}
-      - --bitcoin-rpcpassword=${APP_BITCOIN_RPC_PASS}
+      - --bitcoin-rpcuser=${BITCOIN_RPC_USER}
+      - --bitcoin-rpcpassword=${BITCOIN_RPC_PASSWORD}
       - --bind-addr=170.21.22.13:9736
       - --network=${BITCOIN_NETWORK}
       - --database-upgrade=true
-      # - --grpc-port=${LIGHTNING_GRPC_PORT}
-      - --experimental-websocket-port=2116
+      - --grpc-port=9737
+      - --bind-addr=ws:127.0.0.1:2116
       - --experimental-offers
     restart: on-failure
     volumes:
-      - ${PWD}/data/lightningd-2:${LIGHTNING_DATA_DIR}
+      - ${PWD}/data/lightningd-2:/data/.lightning-2
     ports:
       - 2116:2116
     networks:
@@ -67,44 +67,31 @@ services:
       - bitcoind
       - lightningd
     environment:
-      APP_SINGLE_SIGN_ON: ${APP_SINGLE_SIGN_ON}
-      BITCOIN_HOST: ${BITCOIN_HOST}
-      BITCOIN_NETWORK: ${BITCOIN_NETWORK}
-      APP_CONFIG_FILE: ${APP_CONFIG_FILE}
-      APP_LOG_FILE: ${APP_LOG_FILE}
-      APP_MODE: ${APP_MODE}
-      APP_CONNECT: ${APP_CONNECT}
-      APP_PROTOCOL: ${APP_PROTOCOL}
-      APP_HOST: ${APP_HOST}
       APP_PORT: ${APP_PORT}
-      LIGHTNING_DATA_DIR: ${LIGHTNING_DATA_DIR}
       LIGHTNING_HOST: ${LIGHTNING_HOST}
+      BITCOIN_NETWORK: ${BITCOIN_NETWORK}
+      APP_HOST: ${APP_HOST}
+      LIGHTNING_GRPC_PORT: ${LIGHTNING_GRPC_PORT}
+      LIGHTNING_REST_PORT: ${LIGHTNING_REST_PORT}
+      LIGHTNING_WS_PORT: ${LIGHTNING_WS_PORT}
       LIGHTNING_TOR_HOST: ${LIGHTNING_TOR_HOST}
+      LIGHTNING_DATA_DIR: ${LIGHTNING_DATA_DIR}
       LIGHTNING_VARS_FILE: ${LIGHTNING_VARS_FILE}
-      LIGHTNING_WS_PROTOCOL: ${LIGHTNING_WS_PROTOCOL}
-      LIGHTNING_WS_PORT: ${LIGHTNING_WS_PORT},
-      LIGHTNING_WS_CLIENT_KEY_FILE: ${LIGHTNING_WS_CLIENT_KEY_FILE}
-      LIGHTNING_WS_CLIENT_CERT_FILE: ${LIGHTNING_WS_CLIENT_CERT_FILE}
-      LIGHTNING_WS_CA_CERT_FILE: ${LIGHTNING_WS_CA_CERT_FILE}
-      LIGHTNING_REST_PROTOCOL: ${LIGHTNING_REST_PROTOCOL}
-      LIGHTNING_REST_HOST: ${LIGHTNING_REST_HOST}
-      LIGHTNING_REST_TOR_HOST: ${LIGHTNING_REST_TOR_HOST}
-      LIGHTNING_REST_PORT: ${LIGHTNING_REST_PORT},
-      LIGHTNING_REST_CLIENT_KEY_FILE: ${LIGHTNING_REST_CLIENT_KEY_FILE}
-      LIGHTNING_REST_CLIENT_CERT_FILE: ${LIGHTNING_REST_CLIENT_CERT_FILE}
-      LIGHTNING_REST_CA_CERT_FILE: ${LIGHTNING_REST_CA_CERT_FILE}
-      LIGHTNING_GRPC_HOST: ${LIGHTNING_GRPC_HOST}
-      LIGHTNING_GRPC_TOR_HOST: ${LIGHTNING_GRPC_TOR_HOST}
-      LIGHTNING_GRPC_PORT: ${LIGHTNING_GRPC_PORT}
-      LIGHTNING_GRPC_PROTO_PATH: ${LIGHTNING_GRPC_PROTO_PATH}
-      LIGHTNING_GRPC_CLIENT_KEY_FILE: ${LIGHTNING_GRPC_CLIENT_KEY_FILE}
-      LIGHTNING_GRPC_CLIENT_CERT_FILE: ${LIGHTNING_GRPC_CLIENT_CERT_FILE}
-      LIGHTNING_GRPC_CA_CERT_FILE: ${LIGHTNING_GRPC_CA_CERT_FILE}
+      APP_CONFIG_FILE: ${APP_CONFIG_FILE}
+      APP_MODE: "production"
+      LIGHTNING_WS_CA_CERT_FILE: ${LIGHTNING_DATA_DIR}/bitcoin/ca.pem
+      LIGHTNING_WS_CLIENT_KEY_FILE: ${LIGHTNING_DATA_DIR}/bitcoin/client-key.pem
+      LIGHTNING_WS_CLIENT_CERT_FILE: ${LIGHTNING_DATA_DIR}/bitcoin/client.pem
+      LIGHTNING_REST_CA_CERT_FILE: ${LIGHTNING_DATA_DIR}/bitcoin/ca.pem
+      LIGHTNING_REST_CLIENT_KEY_FILE: ${LIGHTNING_DATA_DIR}/bitcoin/client-key.pem
+      LIGHTNING_REST_CLIENT_CERT_FILE: ${LIGHTNING_DATA_DIR}/bitcoin/client.pem
+      LIGHTNING_GRPC_CA_CERT_FILE: ${LIGHTNING_DATA_DIR}/bitcoin/ca.pem
+      LIGHTNING_GRPC_CLIENT_KEY_FILE: ${LIGHTNING_DATA_DIR}/bitcoin/client-key.pem
+      LIGHTNING_GRPC_CLIENT_CERT_FILE: ${LIGHTNING_DATA_DIR}/bitcoin/client.pem
     command: npm run start
     restart: on-failure
     volumes:
       - ${PWD}/data/lightningd:${LIGHTNING_DATA_DIR}
-      - ${PWD}/data/c-lightning-rest/certs:/c-lightning-rest/certs
       - ${PWD}/data/app:/data/app
     ports:
       - "${APP_PORT}:${APP_PORT}"
@@ -121,27 +108,32 @@ services:
       - bitcoind
       - lightningd
     environment:
-      BITCOIN_NETWORK: ${BITCOIN_NETWORK}
+      APP_PORT: 2113
       LIGHTNING_HOST: 170.21.22.13
-      APP_MODE: "production"
+      BITCOIN_NETWORK: ${BITCOIN_NETWORK}
       APP_HOST: 170.21.22.15
-      APP_PORT: 2113
-      LIGHTNING_TOR_HOST: ${LIGHTNING_TOR_HOST}
-      LIGHTNING_VARS_FILE: ${LIGHTNING_VARS_FILE}
+      LIGHTNING_GRPC_PORT: 2115
+      LIGHTNING_REST_PORT: 2114
       LIGHTNING_WS_PORT: 2116
-      LIGHTNING_REST_PORT: ${LIGHTNING_REST_PORT}
-      LIGHTNING_GRPC_PORT: ${LIGHTNING_GRPC_PORT}
-      LIGHTNING_GRPC_PROTO_PATH: ${LIGHTNING_GRPC_PROTO_PATH}
-      LIGHTNING_DATA_DIR: ${LIGHTNING_DATA_DIR}
-      LIGHTNING_REST_CLIENT_KEY_FILE: ${LIGHTNING_DATA_DIR}/bitcoin/client-key.pem
-      LIGHTNING_REST_CLIENT_CERT_FILE: ${LIGHTNING_DATA_DIR}/bitcoin/client.pem
-      LIGHTNING_REST_CA_CERT_FILE: ${LIGHTNING_DATA_DIR}/bitcoin/ca.pem
+      LIGHTNING_TOR_HOST: tor2.onion
+      LIGHTNING_DATA_DIR: /data/.lightning-2
+      LIGHTNING_VARS_FILE: /data/.lightning-2/.commando-env
+      APP_CONFIG_FILE: /data/app-2/config.json
+      APP_MODE: "production"
+      LIGHTNING_WS_CA_CERT_FILE: /data/.lightning-2/bitcoin/ca.pem
+      LIGHTNING_WS_CLIENT_KEY_FILE: /data/.lightning-2/bitcoin/client-key.pem
+      LIGHTNING_WS_CLIENT_CERT_FILE: /data/.lightning-2/bitcoin/client.pem
+      LIGHTNING_REST_CA_CERT_FILE: /data/.lightning-2/bitcoin/ca.pem
+      LIGHTNING_REST_CLIENT_KEY_FILE: /data/.lightning-2/bitcoin/client-key.pem
+      LIGHTNING_REST_CLIENT_CERT_FILE: /data/.lightning-2/bitcoin/client.pem
+      LIGHTNING_GRPC_CA_CERT_FILE: /data/.lightning-2/bitcoin/ca.pem
+      LIGHTNING_GRPC_CLIENT_KEY_FILE: /data/.lightning-2/bitcoin/client-key.pem
+      LIGHTNING_GRPC_CLIENT_CERT_FILE: /data/.lightning-2/bitcoin/client.pem
     command: npm run start
     restart: on-failure
     volumes:
-      - ${PWD}/data/lightningd-2:${LIGHTNING_DATA_DIR}
-      - ${PWD}/data/c-lightning-rest/certs:/c-lightning-rest/certs
-      - ${PWD}/data/app-2:/data/app
+      - ${PWD}/data/lightningd-2:data/.lightning-2
+      - ${PWD}/data/app-2:/data/app-2
     ports:
       - 2113:2113
     networks:
diff --git a/env.sh b/env.sh
