@fireblocks/fireblocks-json-rpc 0.0.4 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -4
- package/dist/package.json +4 -4
- package/dist/src/command.js +1 -1
- package/dist/src/command.js.map +1 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,10 +1,6 @@
|
|
|
1
1
|
[](https://badge.fury.io/js/@fireblocks%2Ffireblocks-json-rpc)
|
|
2
2
|
|
|
3
3
|
# Fireblocks Local JSON-RPC
|
|
4
|
-
> **Warning**
|
|
5
|
-
> This package is in a beta stage and should be used at your own risk.
|
|
6
|
-
> The provided interfaces might go through backwards-incompatibale changes.
|
|
7
|
-
> For a more stable library (with a different paradigm) you can use [Fireblocks Web3 Provider](https://github.com/fireblocks/fireblocks-web3-provider)
|
|
8
4
|
|
|
9
5
|
`fireblocks-json-rpc` is a command-line [JSON-RPC](https://ethereum.org/en/developers/docs/apis/json-rpc/) server powered by the Fireblocks API.
|
|
10
6
|
Its goal is to make it easy for Fireblocks users to interact with EVM chains.
|
|
@@ -17,6 +13,13 @@ Additional SDKs:
|
|
|
17
13
|
```bash
|
|
18
14
|
npm install -g @fireblocks/fireblocks-json-rpc
|
|
19
15
|
```
|
|
16
|
+
#### Running in Docker
|
|
17
|
+
As an alternative option, you can also run the Local JSON-RPC server as a Docker container using the official Docker image.
|
|
18
|
+
|
|
19
|
+
**Please note the image is currently in beta.**
|
|
20
|
+
|
|
21
|
+
For more information, please see the official [DockerHub repository](https://hub.docker.com/r/fireblocksofficial/json-rpc).
|
|
22
|
+
|
|
20
23
|
|
|
21
24
|
## Usage
|
|
22
25
|
```sh
|
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fireblocks/fireblocks-json-rpc",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"repository": "github:fireblocks/fireblocks-json-rpc",
|
|
6
6
|
"author": "Fireblocks",
|
|
@@ -24,8 +24,8 @@
|
|
|
24
24
|
},
|
|
25
25
|
"scripts": {
|
|
26
26
|
"build": "tsc",
|
|
27
|
-
"start": "
|
|
28
|
-
"test": "npm
|
|
27
|
+
"start": "node dist/src/cli.js",
|
|
28
|
+
"test": "npm install -g . && mocha --exit --recursive 'test/**/*.test.ts'",
|
|
29
29
|
"prepare": "npm run build"
|
|
30
30
|
},
|
|
31
31
|
"bin": {
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"README.md"
|
|
38
38
|
],
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@fireblocks/fireblocks-web3-provider": "^1.
|
|
40
|
+
"@fireblocks/fireblocks-web3-provider": "^1.3.3",
|
|
41
41
|
"commander": "^9.4.1",
|
|
42
42
|
"debug": "^4.3.4",
|
|
43
43
|
"dotenv": "^16.0.3",
|
package/dist/src/command.js
CHANGED
|
@@ -39,7 +39,7 @@ function createFireblocksJsonRpcCommand() {
|
|
|
39
39
|
.addOption(new commander_1.Option("--http", "Run an HTTP server instead of using IPC").env("FIREBLOCKS_HTTP"))
|
|
40
40
|
.addOption(new commander_1.Option("--port [port]", "HTTP server port").default(constants_1.DEFAULT_PORT).env("FIREBLOCKS_PORT"))
|
|
41
41
|
.addOption(new commander_1.Option("--host [host]", "HTTP server host").default(constants_1.DEFAULT_HOST).env("FIREBLOCKS_HOST"))
|
|
42
|
-
.addOption(new commander_1.Option("--suppressHostWarning", "
|
|
42
|
+
.addOption(new commander_1.Option("--suppressHostWarning", "Suppress the warning printed when setting --host not to localhost").env("FIREBLOCKS_HOST"))
|
|
43
43
|
.addOption(new commander_1.Option("--httpPath [path]", "HTTP JSON-RPC endpoint path").default(undefined, '/${--apiKey}').env("FIREBLOCKS_HTTP_PATH"))
|
|
44
44
|
.addOption(new commander_1.Option("--ipcPath [path]", `IPC path to listen on, defaults to '${constants_1.LINUX_DEFAULT_IPC_PATH}' on linux and macos, and '${constants_1.WINDOWS_DEFAULT_IPC_PATH}' on windows`).default(constants_1.DEFAULT_IPC_PATH).env("FIREBLOCKS_IPC_PATH"))
|
|
45
45
|
.addOption(new commander_1.Option("--env [env_var_name]", "Sets the listening address as an environment variable").default(constants_1.DEFAULT_ENV_VAR).env("FIREBLOCKS_JSON_RPC_ENV_VAR"))
|
package/dist/src/command.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/command.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgC;AAChC,MAAM,CAAC,MAAM,EAAE,CAAA;AAEf,yCAA2C;AAC3C,kDAAyC;AACzC,2CAWoB;AAEpB,SAAgB,8BAA8B;IAC1C,OAAO,IAAI,mBAAO,EAAE,CAAC,KAAK,CAAC,oCAAoC,CAAC;SAC3D,WAAW,CAAC,0EAA0E,CAAC;SAEvF,SAAS,CAAC,IAAI,kBAAM,CAAC,gBAAgB,EAAE,oBAAoB,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,mBAAmB,EAAE,CAAC;SAC7G,SAAS,CAAC,IAAI,kBAAM,CAAC,iCAAiC,EAAE,4BAA4B,CAAC,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC,mBAAmB,EAAE,CAAC;SACnJ,SAAS,CAAC,IAAI,kBAAM,CAAC,qBAAqB,EAAE,2CAA2C,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;SACpH,SAAS,CAAC,IAAI,kBAAM,CAAC,mBAAmB,EAAE,2CAA2C,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;SAEjH,SAAS,CAAC,IAAI,kBAAM,CAAC,QAAQ,EAAE,yCAAyC,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;SACjG,SAAS,CAAC,IAAI,kBAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC,OAAO,CAAC,wBAAY,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;SACvG,SAAS,CAAC,IAAI,kBAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC,OAAO,CAAC,wBAAY,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;SACvG,SAAS,CAAC,IAAI,kBAAM,CAAC,uBAAuB,EAAE,
|
|
1
|
+
{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/command.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgC;AAChC,MAAM,CAAC,MAAM,EAAE,CAAA;AAEf,yCAA2C;AAC3C,kDAAyC;AACzC,2CAWoB;AAEpB,SAAgB,8BAA8B;IAC1C,OAAO,IAAI,mBAAO,EAAE,CAAC,KAAK,CAAC,oCAAoC,CAAC;SAC3D,WAAW,CAAC,0EAA0E,CAAC;SAEvF,SAAS,CAAC,IAAI,kBAAM,CAAC,gBAAgB,EAAE,oBAAoB,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,mBAAmB,EAAE,CAAC;SAC7G,SAAS,CAAC,IAAI,kBAAM,CAAC,iCAAiC,EAAE,4BAA4B,CAAC,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC,mBAAmB,EAAE,CAAC;SACnJ,SAAS,CAAC,IAAI,kBAAM,CAAC,qBAAqB,EAAE,2CAA2C,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;SACpH,SAAS,CAAC,IAAI,kBAAM,CAAC,mBAAmB,EAAE,2CAA2C,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;SAEjH,SAAS,CAAC,IAAI,kBAAM,CAAC,QAAQ,EAAE,yCAAyC,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;SACjG,SAAS,CAAC,IAAI,kBAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC,OAAO,CAAC,wBAAY,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;SACvG,SAAS,CAAC,IAAI,kBAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC,OAAO,CAAC,wBAAY,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;SACvG,SAAS,CAAC,IAAI,kBAAM,CAAC,uBAAuB,EAAE,mEAAmE,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;SAC1I,SAAS,CAAC,IAAI,kBAAM,CAAC,mBAAmB,EAAE,6BAA6B,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;SACxI,SAAS,CAAC,IAAI,kBAAM,CAAC,kBAAkB,EAAE,uCAAuC,kCAAsB,8BAA8B,oCAAwB,cAAc,CAAC,CAAC,OAAO,CAAC,4BAAgB,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;SACjO,SAAS,CAAC,IAAI,kBAAM,CAAC,sBAAsB,EAAE,uDAAuD,CAAC,CAAC,OAAO,CAAC,2BAAe,CAAC,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;SAElK,SAAS,CAAC,IAAI,kBAAM,CAAC,qCAAqC,EAAE,gDAAoC,CAAC,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;SACtI,SAAS,CAAC,IAAI,kBAAM,CAAC,2BAA2B,EAAE,gDAAoC,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;SACvH,SAAS,CAAC,IAAI,kBAAM,CAAC,uCAAuC,EAAE,gDAAoC,CAAC,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;SACzI,SAAS,CAAC,IAAI,kBAAM,CAAC,eAAe,EAAE,gDAAoC,CAAC,CAAC,OAAO,CAAC,2BAAe,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;SAC5H,SAAS,CAAC,IAAI,kBAAM,CAAC,qCAAqC,EAAE,gDAAoC,CAAC,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;SACrI,SAAS,CAAC,IAAI,kBAAM,CAAC,qDAAqD,EAAE,gDAAoC,CAAC,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;SAC/J,SAAS,CAAC,IAAI,kBAAM,CAAC,+BAA+B,EAAE,gDAAoC,CAAC,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;SAC7H,SAAS,CAAC,IAAI,kBAAM,CAAC,yBAAyB,EAAE,gDAAoC,CAAC,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;SACnH,SAAS,CAAC,IAAI,kBAAM,CAAC,6DAA6D,EAAE,gDAAoC,CAAC,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;SAElK,SAAS,CAAC,IAAI,kBAAM,CAAC,aAAa,EAAE,sBAAsB,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;SACpF,SAAS,CAAC,IAAI,kBAAM,CAAC,eAAe,EAAE,qEAAqE,2BAAe,EAAE,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;SACxJ,SAAS,CAAC,IAAI,kBAAM,CAAC,WAAW,EAAE,mCAAmC,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;SAEjG,OAAO,CAAC,sBAAO,EAAE,WAAW,EAAE,2BAA2B,CAAC;SAE1D,oBAAoB,EAAE;SACtB,kBAAkB,EAAE;SACpB,WAAW,CAAC,QAAQ,EAAE,sBAAU,CAAC;SAEjC,WAAW,CAAC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;CAsB7B,CAAC,CAAA;AACF,CAAC;AA5DD,wEA4DC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fireblocks/fireblocks-json-rpc",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"repository": "github:fireblocks/fireblocks-json-rpc",
|
|
6
6
|
"author": "Fireblocks",
|
|
@@ -24,8 +24,8 @@
|
|
|
24
24
|
},
|
|
25
25
|
"scripts": {
|
|
26
26
|
"build": "tsc",
|
|
27
|
-
"start": "
|
|
28
|
-
"test": "npm
|
|
27
|
+
"start": "node dist/src/cli.js",
|
|
28
|
+
"test": "npm install -g . && mocha --exit --recursive 'test/**/*.test.ts'",
|
|
29
29
|
"prepare": "npm run build"
|
|
30
30
|
},
|
|
31
31
|
"bin": {
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"README.md"
|
|
38
38
|
],
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@fireblocks/fireblocks-web3-provider": "^1.
|
|
40
|
+
"@fireblocks/fireblocks-web3-provider": "^1.3.3",
|
|
41
41
|
"commander": "^9.4.1",
|
|
42
42
|
"debug": "^4.3.4",
|
|
43
43
|
"dotenv": "^16.0.3",
|