Skip to content

Commit 9951417

Browse files
Merge pull request #7151 from BitGo/WP-5291/deprecate-node-18
docs: update dev doc references
2 parents 3507dc8 + 83d2624 commit 9951417

File tree

1 file changed

+3
-53
lines changed

1 file changed

+3
-53
lines changed

modules/bitgo/README.md

Lines changed: 3 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -12,72 +12,22 @@ Please email us at [email protected] if you have questions or comments about thi
1212

1313
# Installation
1414

15-
Please make sure you are running at least Node version 8 (the latest LTS release is recommended) and NPM version 6.
15+
Please make sure you are running at least Node version 20 (the latest LTS release is recommended) and NPM version 10.
1616
We recommend using `nvm`, the [Node Version Manager](https://github.com/creationix/nvm/blob/master/README.markdown#installation), for setting your Node version.
1717

1818
`npm install --save bitgo`
1919

2020
# Full Documentation
2121

22-
Please see our [SDK Documentation](https://bitgo-sdk-docs.s3.amazonaws.com/core/11.3.0/index.html) for detailed information about the TypeScript SDK and functionality.
23-
24-
For more general information about the BitGo API, please see our [REST API Documentation](https://www.bitgo.com/api/v2).
22+
For more general information about the BitGo API and various integration guides, please see our [Developer Portal](https://developers.bitgo.com/).
2523

2624
# Release Notes
2725

2826
You can find the complete release notes (since version 4.44.0) [here](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/CHANGELOG.md).
2927

3028
# Example Usage
3129

32-
## Initialize SDK
33-
34-
Create an access token by logging into your bitgo account, going to the API access tab [in the settings area](https://www.bitgo.com/settings) and making a developer token.
35-
36-
```js
37-
const BitGo = require('bitgo');
38-
const bitgo = new BitGo.BitGo({ accessToken: ACCESS_TOKEN }); // defaults to testnet. add env: 'prod' if you want to go against mainnet
39-
const result = await bitgo.session();
40-
console.dir(result);
41-
```
42-
43-
## Create Wallet
44-
45-
```js
46-
const params = {
47-
passphrase: 'replaceme',
48-
label: 'firstwallet',
49-
};
50-
const { wallet } = await bitgo.coin('tbtc').wallets().generateWallet(params);
51-
console.dir(wallet);
52-
```
53-
54-
## Create new address
55-
56-
```js
57-
const address = await wallet.createAddress();
58-
console.dir(address);
59-
```
60-
61-
## View wallet transfers
62-
63-
```js
64-
const transfers = await wallet.transfers();
65-
```
66-
67-
## Send coins
68-
69-
```js
70-
const result = await wallet.sendCoins({
71-
address: '2NEe9QhKPB2gnQLB3hffMuDcoFKZFjHYJYx',
72-
amount: 0.01 * 1e8,
73-
walletPassphrase: 'replaceme',
74-
});
75-
console.dir(result);
76-
```
77-
78-
## More examples
79-
80-
Further demos and examples in both JavaScript and TypeScript can be found in the [examples](https://github.com/BitGo/BitGoJS/tree/master/examples) directory.
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).
8131

8232
# Enabling additional debugging output
8333

0 commit comments

Comments
 (0)