Skip to content

Commit

Permalink
ALL-9118 - Upgrade Node, NPM and other libraries
Browse files Browse the repository at this point in the history
  • Loading branch information
isra67 committed Oct 16, 2024
1 parent eaa30ca commit e60a5df
Show file tree
Hide file tree
Showing 7 changed files with 4,839 additions and 4,331 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM node:18-alpine3.16 AS builder
FROM node:20.18.0-alpine3.20 AS builder

# Create app directory

Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,9 @@ TATUM_KMS_DEBUG_MODE=true/false/1/0
yarn global add @tatumio/tatum-kms
```
1. Use ```.env``` file to configure Tatum KMS
1. via ```--env-file=/path/to/.env```
1. via ```--envFile=/path/to/.env```
```
tatum-kms --env-file=/path/to/.env getaddress 11111111-1111-1111-1111-111111111111 0
tatum-kms --envFile=/path/to/.env getaddress 11111111-1111-1111-1111-111111111111 0
```
1. via environment variables directly
```
Expand All @@ -164,7 +164,7 @@ TATUM_KMS_DEBUG_MODE=true/false/1/0
tatum-kms --help
```

>**IMPORTANT!** NodeJS >=14 and npm@6 are required. KMS does **not** work on npm@7.
>**IMPORTANT!** NodeJS >=20.0 are required. KMS does **not** work on older versions.
### Install KMS via Docker
1. Pull the `tatum-kms` image:
Expand All @@ -175,7 +175,7 @@ TATUM_KMS_DEBUG_MODE=true/false/1/0
```
cd $HOME
```
1. Use pre-created ```.env``` file to configure Tatum KMS via ```--env-file .env```:
1. Use pre-created ```.env``` file to configure Tatum KMS via ```--envFile .env```:
1. Map the Docker volume to the local storage (your home folder).

For more details, refer to the [Docker user documentation](https://docs.docker.com/storage/volumes/).
Expand All @@ -184,9 +184,9 @@ TATUM_KMS_DEBUG_MODE=true/false/1/0

To interactively communicate with KMS and run various [KMS commands](#kms-commands), use the `docker run` command:
```
docker run -it --env-file .env -v $HOME:/root/.tatumrc tatumio/tatum-kms --help
docker run -it --env-file .env -v $HOME:/root/.tatumrc tatumio/tatum-kms generatemanagedwallet BTC
docker run -it --env-file .env -v $HOME:/root/.tatumrc tatumio/tatum-kms storemanagedprivatekey BTC
docker run -it --envFile .env -v $HOME:/root/.tatumrc tatumio/tatum-kms --help
docker run -it --envFile .env -v $HOME:/root/.tatumrc tatumio/tatum-kms generatemanagedwallet BTC
docker run -it --envFile .env -v $HOME:/root/.tatumrc tatumio/tatum-kms storemanagedprivatekey BTC
```

>**NOTE:** You can shorten the command syntax and use it as follows:
Expand Down Expand Up @@ -223,7 +223,7 @@ tatum-kms daemon
```
or
```
docker run -d --env-file .env -v $HOME:/root/.tatumrc tatumio/tatum-kms daemon
docker run -d --envFile .env -v $HOME:/root/.tatumrc tatumio/tatum-kms daemon
```
When KMS runs as a daemon, it periodically checks for any new pending transactions to sign.

Expand Down
42 changes: 22 additions & 20 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
"description": "Tatum KMS - Key Management System for Tatum-powered apps.",
"main": "dist/index.js",
"types": "./dist/index.d.ts",
"type": "module",
"engines": {
"node": ">=18.x"
"node": ">=20.x"
},
"scripts": {
"build": "tsc",
"lint": "eslint . --ext .ts",
"run-daemon-testnet": "node dist/index.js daemon --testnet --api-key=YOUR_API_KEY --chain=ADA",
"run-daemon-testnet": "node dist/index.js daemon --testnet --apiKey=YOUR_API_KEY --chain=ADA",
"start": "yarn build && node dist/index.js"
},
"files": [
Expand Down Expand Up @@ -39,32 +40,33 @@
},
"homepage": "https://github.com/tatumio/tatum-kms#readme",
"dependencies": {
"@aws-sdk/client-secrets-manager": "^3.445.0",
"@tatumio/cardano": "^2.2.72",
"@tatumio/celo": "^2.2.72",
"@tatumio/solana": "^2.2.72",
"@aws-sdk/client-secrets-manager": "^3.669.0",
"@tatumio/cardano": "^2.2.86",
"@tatumio/celo": "^2.2.86",
"@tatumio/solana": "^2.2.86",
"@tatumio/tatum": "^1.37.50",
"@tatumio/tatum-kcs": "^2.0.0-alpha.113",
"@tatumio/tron": "^2.2.72",
"@tatumio/xlm": "^2.2.72",
"@tatumio/xrp": "^2.2.72",
"@tatumio/tron": "^2.2.86",
"@tatumio/xlm": "^2.2.86",
"@tatumio/xrp": "^2.2.86",
"agentkeepalive": "^4.5.0",
"axios": "^1.7.7",
"crypto-js": "^4.2.0",
"dotenv": "^16.3.1",
"dotenv": "^16.4.5",
"lodash": "^4.17.21",
"meow": "^7.0.1",
"meow": "^13.2.0",
"readline-sync": "^1.4.10",
"reflect-metadata": "^0.1.13",
"semver": "^7.5.4",
"uuid": "^9.0.1"
"semver": "^7.6.3",
"uuid": "^10.0.0"
},
"devDependencies": {
"@types/jest": "^29.5.13",
"@types/node": "^22.7.5",
"@types/readline-sync": "^1.4.7",
"@types/semver": "^7.5.5",
"@typescript-eslint/eslint-plugin": "^6.10.0",
"@typescript-eslint/parser": "^6.10.0",
"eslint": "^8.53.0",
"rimraf": "^5.0.5",
"typescript": "^5.2.2"
"@types/semver": "^7.5.8",
"@typescript-eslint/eslint-plugin": "^8.8.1",
"@typescript-eslint/parser": "^8.8.1",
"eslint": "^9.12.0",
"typescript": "^5.6.3"
}
}
Loading

0 comments on commit e60a5df

Please sign in to comment.