Skip to content

Commit 0be19e7

Browse files
committed
docs: updated old urls dx-2014
1 parent 0dab4d7 commit 0be19e7

File tree

6 files changed

+18
-20
lines changed

6 files changed

+18
-20
lines changed

examples/js/trx/consolidate-account-balances.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Tron wallet can't send funds from their receive addresses.
33
* Account balance consolidation is used to sweep funds from the
44
* receive addresses into the wallet's base address for sending.
5-
* @see {@link https://app.bitgo.com/docs/#operation/v2.wallet.consolidateaccount.build}
5+
* @see {@link https://developers.bitgo.com/reference/v2walletconsolidateaccountbuild#/}
66
*/
77
const BitGoJS = require('bitgo');
88

examples/js/xtz/consolidate-account-balances.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Tezos wallet can't send funds from their receive addresses.
33
* Account balance consolidation is used to sweep funds from the
44
* receive addresses into the wallet's base address for sending.
5-
* @see {@link https://app.bitgo.com/docs/#operation/v2.wallet.consolidateaccount.build}
5+
* @see {@link https://developers.bitgo.com/reference/v2walletconsolidateaccountbuild#/}
66
*/
77
const BitGoJS = require('bitgo');
88
const Promise = require('bluebird');

examples/ts/trx/consolidate-hot-account-balances.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Tron wallets can't send funds from their receive addresses.
33
* Account balance consolidation is used to sweep funds from the
44
* receive addresses into the wallet's base address for sending.
5-
* @see {@link https://app.bitgo.com/docs/#operation/v2.wallet.consolidateaccount.build}
5+
* @see {@link https://developers.bitgo.com/reference/v2walletconsolidateaccountbuild#/}
66
*/
77
import { BitGo, WalletCoinSpecific } from 'bitgo';
88

examples/ts/xtz/consolidate-account-balances.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Tezos wallet can't send funds from their receive addresses.
33
* Account balance consolidation is used to sweep funds from the
44
* receive addresses into the wallet's base address for sending.
5-
* @see {@link https://app.bitgo.com/docs/#operation/v2.wallet.consolidateaccount.build}
5+
* @see {@link https://developers.bitgo.com/reference/v2walletconsolidateaccountbuild#/}
66
*/
77
import { BitGo, WalletCoinSpecific } from 'bitgo';
88

modules/express/README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# BitGo Express local signing server (REST API)
22

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.
44

55
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.
66

77
# Documentation
88

9-
View the comprehensive documentation on the BitGo [Developer Portal](https://developers.bitgo.com/docs/get-started-express-install/).
9+
View comprehensive documentation on the BitGo [Developer Portal](https://developers.bitgo.com/docs/get-started-express-install/).
1010

1111
# Running BitGo Express
1212

1313
## Docker
1414

15-
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.
1616

1717
> Deprecation Warning: bitgosdk/express will no longer receive updates. Please use the official bitgo/express images.
1818
@@ -72,13 +72,13 @@ $ openssl req -newkey rsa:2048 -nodes -keyout cert.key -x509 -days 3650 -out cer
7272

7373
This will output a key file `cert.key` and certificate file `cert.crt`
7474

75-
Finally you can run your docker container like this (note, replace `/path/to` with the full path to your `certs` folder):
75+
Finally you can run your Docker container like this (note, replace `/path/to` with the full path to your `certs` folder):
7676

7777
```bash
7878
$ docker run -it --volume /path/to/certs:/private -p 4000:4000 bitgo/express:latest -p 4000 -k /private/cert.key -c /private/cert.crt -e prod
7979
```
8080

81-
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.
8282

8383
```bash
8484
$ export BITGO_SSL_KEY=$(cat /private/cert.key)
@@ -97,9 +97,9 @@ Environment: prod
9797
Base URI: https://0.0.0.0:4000
9898
```
9999

100-
### Building the docker container
100+
### Building the Docker container
101101

102-
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.
103103

104104
```bash
105105
$ git clone https://github.com/bitgo/bitgojs
@@ -108,7 +108,7 @@ $ docker build -t bitgo-express:latest .
108108
$ docker run -it bitgo-express:latest
109109
```
110110

111-
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`:
112112

113113
```bash
114114
$ git clone https://github.com/bitgo/bitgojs
@@ -119,17 +119,15 @@ $ docker run -it bitgo-express:latest
119119

120120
## From source
121121

122-
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.
123123

124124
### Prerequisites
125125

126-
Please make sure you are running at least Node version 16.
127-
We recommend using `nvm`, the [Node Version Manager](https://github.com/creationix/nvm/blob/master/README.markdown#installation), for setting your Node version.
128-
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.
129127

130128
### Cloning the repository and installing dependencies
131129

132-
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.
133131

134132
```bash
135133
$ git clone https://github.com/bitgo/bitgojs
@@ -139,7 +137,7 @@ $ yarn install --frozen-lockfile && yarn install --production --frozen-lockfile
139137

140138
### Running BitGo Express
141139

142-
From the express module folder (`modules/express`), run this command:
140+
From the Express module folder (`modules/express`), run this command:
143141

144142
```bash
145143
$ yarn run start
@@ -234,7 +232,7 @@ BitGo Express is able to take configuration options from either command line arg
234232
| N/A | --disableproxy | `BITGO_DISABLE_PROXY` <sup>0</sup> | N/A | Disable proxying of routes not explicitly handled by bitgo-express |
235233
| 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. |
236234
| -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. |
237-
| 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#/). |
238236
| N/A | --externalSignerUrl | `BITGO_EXTERNAL_SIGNER_URL` | N/A | URL specifying the external API to call for remote signing. |
239237
| N/A | --signerMode | `BITGO_SIGNER_MODE ` | N/A | If set, run Express as a remote signer. |
240238
| 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. |

modules/sdk-coin-iota/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ const iota = sdk.coin('iota');
3636

3737
## Documentation
3838

39-
For detailed API documentation, see the [BitGo API reference](https://app.bitgo.com/docs/).
39+
For detailed API documentation, view the BitGo [Developer Portal](https://developers.bitgo.com/reference/overview#/).

0 commit comments

Comments
 (0)