You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/bitgo/README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,39 +1,39 @@
1
1
# BitGo JavaScript SDK
2
2
3
-
The BitGo Platform and SDK makes it easy to build multi-signature crypto-currency applications today with support for Bitcoin, Ethereum and many other coins.
4
-
The SDK is fully integrated with the BitGo co-signing service for managing all of your BitGo wallets.
3
+
The BitGo Platform enables you to build multisignature and MPC cryptocurrency applications for over a thousand digital assets. You can view all BitGo supported assets on the [Developer Portal](https://assets.bitgo.com/coins). The SDK is fully integrated with the BitGo co-signing service for managing all of your BitGo wallets.
5
4
6
-
Included in the SDK are examples for how to use the API to manage your multi-signature wallets.
5
+
The SDK includes examples for how to use the API to manage your wallets.
7
6
8
-
Please email us at [email protected] if you have questions or comments about this API.
7
+
If you have questions or comments about this API, email [email protected].
Please make sure you are running at least Node version 20 (the latest LTS release is recommended) and NPM version 10.
16
-
We recommend using `nvm`, the [Node Version Manager](https://github.com/creationix/nvm/blob/master/README.markdown#installation), for setting your Node version.
14
+
Ensure you're running Node version 20 or higher (preferably the latest LTS release) and NPM version 10.
15
+
For setting your Node version, we recommend using `nvm` - the [Node Version Manager](https://github.com/creationix/nvm/blob/master/README.markdown#installation).
17
16
18
17
`npm install --save bitgo`
19
18
20
19
# Full Documentation
21
20
22
-
For more general information about the BitGo API and various integration guides, please see our[Developer Portal](https://developers.bitgo.com/).
21
+
For more comprehensive information about the BitGo API, including integration guides, see the BitGo[Developer Portal](https://developers.bitgo.com/).
23
22
24
23
# Release Notes
25
24
26
-
You can find the complete release notes (since version 4.44.0) [here](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/CHANGELOG.md).
-[SDK changelog](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/CHANGELOG.md) (since version 4.44.0)
27
27
28
28
# Example Usage
29
29
30
-
Examples and integration guides for BitGoJS or BitGo Express can be found in the [Developer Portal](https://developers.bitgo.com/guides/get-started/intro) or the [examples directory](https://github.com/BitGo/BitGoJS/tree/master/examples).
30
+
You can view examples in the [examples directory](https://github.com/BitGo/BitGoJS/tree/master/examples). You can view integration guides in the [Developer Portal](https://developers.bitgo.com/guides/get-started/intro).
31
31
32
32
# Enabling additional debugging output
33
33
34
34
`bitgo` uses the `debug` package to emit extra information, which can be useful when debugging issues with BitGoJS or BitGo Express.
35
35
36
-
When using the `bitgo` npm package, the easiest way to enable debug output is by setting the `DEBUG` environment variable to one or more of the debug namespaces in the table below. Multiple debug namespaces can be enabled by giving a comma-separated list or by using `*` as a wildcard. See the [debug package documentation](https://github.com/visionmedia/debug#readme) for more details.
36
+
When using the `bitgo` npm package, the easiest way to enable debug output is to set the `DEBUG` environment variable to one or more of the debug namespaces in the table below. You can enable multiple debug namespaces by using a comma-separated list or by using `*` as a wildcard. See the [debug package documentation](https://github.com/visionmedia/debug#readme) for more details.
37
37
38
38
## Available Debug Namespaces
39
39
@@ -47,32 +47,32 @@ When using the `bitgo` npm package, the easiest way to enable debug output is by
47
47
|`bitgo:v2:eth`| Ethereum specific output. Currently only failures to require the optional Ethereum libraries are reported |
48
48
|`bitgo:v2:util`| SDK utilities specific output. Currently only failures to require the optional Ethereum libraries are reported |
49
49
50
-
Another debug namespace which is not provided by BitGoJS but is helpful nonetheless is the `superagent` namespace, which will output all HTTP requests and responses (only the URL, not bodies).
50
+
Another debug namespace that BitGoJS doesn't provide but is helpful nonetheless is the `superagent` namespace. This outputs all HTTP requests and responses (only the URL, not bodies).
51
51
52
52
## Example
53
53
54
-
To run an SDK script with debug output enabled, export the DEBUG environment variable before running.
54
+
To run an SDK script with debug output enabled, export the `DEBUG` environment variable before running.
55
55
56
56
```shell script
57
57
export DEBUG='bitgo:*'# enable all bitgo debug namespaces
58
58
node myScript.js
59
59
```
60
60
61
-
To set debug namespaces in the browser, you should set `localStorage.debug` property instead of the `DEBUG` environment variable using your browser's development tools console.
61
+
To set debug namespaces in a browser, set the`localStorage.debug` property instead of the `DEBUG` environment variable using your browser's development tools console.
62
62
63
63
```js
64
64
localStorage.debug='bitgo:*'; // enable all bitgo debug namespaces
65
65
```
66
66
67
67
# Using with TypeScript
68
68
69
-
`bitgo` is not yet compatible with the `noImplicitAny` compiler option. If you want to use this option in your project (and we recommend that you do), you must set the `skipLibCheck` option to supress errors about missing type definitions for dependencies of `bitgo`.
69
+
`bitgo` is not yet compatible with the `noImplicitAny` compiler option. To use this option in your project (and we recommend that you do), you must set the `skipLibCheck` option to suppress errors about missing type definitions for dependencies of `bitgo`.
70
70
71
-
# Usage in Browser
71
+
# Usage in browser
72
72
73
-
Since version 6, `bitgo` includes a minified, browser-compatible bundle by default at `dist/browser/BitGoJS.min.js`. It can be copied from there directly into your project.
73
+
Since version 6, `bitgo` includes a minified, browser-compatible bundle by default at `dist/browser/BitGoJS.min.js`. You can copy the bundle from there and paste it directly into your project.
74
74
75
-
BitGoJS can also be bundled with any module bundler. There is a Webpack configuration file already included, which can be triggered with package scripts.
75
+
You can also bundle BitGoJS with any module bundler. There's a Webpack configuration file already included, which you can use to trigger with package scripts.
Copy file name to clipboardExpand all lines: modules/express/README.md
+15-18Lines changed: 15 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,18 @@
1
-
# BitGo Express Local Signing Server (REST API)
1
+
# BitGo Express local signing server (REST API)
2
2
3
-
Suitable for developers working in a language without an official BitGo SDK.
3
+
BitGo Express is suitable for developers working in a language without an official BitGo SDK.
4
4
5
-
BitGo Express runs as a service in your own datacenter, and handles the client-side operations involving your own keys, such as partially signing transactions before submitting to BitGo.
6
-
This ensures your keys never leave your network, and are not seen by BitGo. BitGo Express can also proxy the standard BitGo REST APIs, providing a unified interface to BitGo through a single REST API.
5
+
BitGo Express runs as a service in your own datacenter, and handles the client-side operations involving your own keys, such as partially signing transactions before submitting to BitGo. This ensures your keys never leave your network, and are not seen by BitGo. BitGo Express can also proxy the standard BitGo REST APIs, providing a unified interface to BitGo through a single REST API.
7
6
8
7
# Documentation
9
8
10
-
Comprehensive documentation on the APIs provided by BitGo Express can be found at our [Platform API Reference](https://app.bitgo.com/docs/#tag/Express).
9
+
View comprehensive documentation on the BitGo [Developer Portal](https://developers.bitgo.com/docs/get-started-express-install/).
11
10
12
11
# Running BitGo Express
13
12
14
13
## Docker
15
14
16
-
For most users, we recommend running BitGo Express as a docker container, since this is the most secure way to run BitGo Express.
15
+
For most users, we recommend running BitGo Express as a Docker container, since this's the most secure way to run BitGo Express.
17
16
18
17
> Deprecation Warning: bitgosdk/express will no longer receive updates. Please use the official bitgo/express images.
An alternative way to provide the ssl certification is to export them as environment variables.
81
+
An alternative way to provide the SSL certification is to export them as environment variables.
83
82
84
83
```bash
85
84
$ export BITGO_SSL_KEY=$(cat /private/cert.key)
@@ -98,9 +97,9 @@ Environment: prod
98
97
Base URI: https://0.0.0.0:4000
99
98
```
100
99
101
-
### Building the docker container
100
+
### Building the Docker container
102
101
103
-
If you'd like to build the BitGo Express docker container yourself from the source code, first check out the latest **master** branch, then run `docker build` from the project root. Here's the commands:
102
+
To build the BitGo Express Docker container yourself from the source code, check out the latest **master** branch and run `docker build` from the project root.
Another way to build the BitGo Express docker container if you have `yarn` installed:
111
+
You can also build the BitGo Express Docker container using `yarn`:
113
112
114
113
```bash
115
114
$ git clone https://github.com/bitgo/bitgojs
@@ -120,17 +119,15 @@ $ docker run -it bitgo-express:latest
120
119
121
120
## From source
122
121
123
-
For users who are unable to run BitGo Express as a docker container, we recommend building and running from the source code.
122
+
For users who are unable to run BitGo Express as a Docker container, we recommend building and running from the source code.
124
123
125
124
### Prerequisites
126
125
127
-
Please make sure you are running at least Node version 16.
128
-
We recommend using `nvm`, the [Node Version Manager](https://github.com/creationix/nvm/blob/master/README.markdown#installation), for setting your Node version.
129
-
BitGo Express has become a first class citizen of the monorepo so we recommend using `yarn` for local setup.
126
+
Ensure you're running at least Node version 16. We recommend using `nvm`, the [Node Version Manager](https://github.com/creationix/nvm/blob/master/README.markdown#installation), for setting your Node version. BitGo Express has become a first class citizen of the monorepo so we recommend using `yarn` for local setup.
130
127
131
128
### Cloning the repository and installing dependencies
132
129
133
-
First, clone the latest **master** branch, then run `yarn install` in the project root directory.
130
+
Clone the latest **master** branch and run `yarn install` in the project root directory.
From the express module folder (`modules/express`), run this command:
140
+
From the Express module folder (`modules/express`), run this command:
144
141
145
142
```bash
146
143
$ yarn run start
@@ -235,7 +232,7 @@ BitGo Express is able to take configuration options from either command line arg
235
232
| N/A | --disableproxy |`BITGO_DISABLE_PROXY` <sup>0</sup> | N/A | Disable proxying of routes not explicitly handled by bitgo-express |
236
233
| N/A | --disableenvcheck |`BITGO_DISABLE_ENV_CHECK` <sup>0</sup> | N/A | Disable checking for correct `NODE_ENV` environment variable when running against BitGo production environment. |
237
234
| -i | --ipc |`BITGO_IPC`| N/A | If set, bind to the given IPC (unix domain) socket. Binding to an IPC socket can be useful if the caller of bitgo-express resides on the same host as the bitgo-express instance itself, since the socket can be secured using normal file permissions and ownership semantics. Note: This is not supported on Windows platforms. |
238
-
| N/A | --authversion |`BITGO_AUTH_VERSION`| 2 | BitGo Authentication scheme version which should be used form making requests to the BitGo server. Please see the [BitGo API documentation](https://app.bitgo.com/docs) for more info on authentication scheme versions. |
235
+
| N/A | --authversion |`BITGO_AUTH_VERSION`| 2 | BitGo Authentication scheme version which should be used form making requests to the BitGo server. For more info on authentication scheme versions, view the API reference on the BitGo [Developer Portal](https://developers.bitgo.com/reference/overview#/). |
239
236
| N/A | --externalSignerUrl |`BITGO_EXTERNAL_SIGNER_URL`| N/A | URL specifying the external API to call for remote signing. |
240
237
| N/A | --signerMode |`BITGO_SIGNER_MODE `| N/A | If set, run Express as a remote signer. |
241
238
| N/A | --signerFileSystemPath |`BITGO_SIGNER_FILE_SYSTEM_PATH `| N/A | Local path specifying where an Express signer machine keeps the encrypted user private keys. Required when signerMode is set. |
0 commit comments