BitGo Express Parameters

This article presumes you have a functioning Bitgo Express node server.

• If you do not have a server setup, or are uncertain, please see: BitGo Express via Docker

BitGo Express is designed, created, and supported by BitGo for their BitGo website wallet.

• This 2024 article is intended to help you find the necessary CAS parameters from your Bitgo account and their Bitgo Express software.

Open

1) Assemble your BitGo Express parameters for CAS.

Parameters required: host : port : token : wallet_id : wallet_passphrase

• Other parameters may be offered, but are not absolutely required. We suggest you get your Crypto Setting working properly, before adjusting those optional parameters.

a) host:port

The host:port parameters identify the location (on the Internet) of your Bitgo Express server. You must operate a Bitgo Express server to use a Bitgo-based Crypto Setting.

“host”:

The host is where CAS will steer RPC communications: the target Bitgo Express server. The server will vary upon your implementation, and the IP address will always be different from the provided example.

• host is the target BitGo Express server IP when using the GB Wallet Tunnel,

  • e.g. “http://123.456.789.012”

  • The GB Wallet Tunnel will attempt to connect to your BitGo Express server at that IP.

• Use http://localhost when:

  • a) using an (unsupported) SSH tunnel, or

  • b) Bitgo Express is running on the same server as CAS (not recommended).

“port”:

3080 is the default port, and is used in most every case & all examples below.

b) token

API tokens are generated by you (the Bitgo user) on demand, here’s how:

I) Login to your Bitgo account.

II) Navigate to your Enterprise settings.

Open

III) Click +Create Access Token.

IV) Configure the new access token’s settings and permissions.

1. Enter a descriptive name for the API token.

2. Set a reasonable expiration date. The default is 1 week - which is far too short for production use. Increase the expiration to a year (or more), and always delete unused tokens.

3. Enable all permissions for testing. Upon success, you can then play with increased restrictions.

4. Enter the IP address of your Bitgo Express node.

5. Read the agreements, and check “I agree” when it is honest.

6. Enter your 2FA code (after everything else has been entered).

7. And finally: create the token.

Note: Spending Limits” can be zero, but you should put in some limit to comply with “best practices”.

• See: Best Practices: Security

• The next screen reveals your developer API token. Save it!

• It cannot be displayed again!

The token generated is the “token” parameter required in your Crypto Settings.

c) wallet_id

The wallet_id parameter is located in the relevant wallet settings. Start at “Assets”.

Click on the asset/wallet whose ID you seek to identify.

Drill down further into the coin/asset/wallet that you wish to use.

Locate that Wallet ID in Settings.

Save it.

d) wallet_passphrase

Normally this is your account password (by default) -unless- you created a new wallet and chose a separate password (which is recommended). In that case, the wallet_passphrase is set on the same page as the Wallet ID.

• If you haven’t set a specific wallet password, use your account password.

2) Enter the assembled parameters into CAS.

Initially, set only the required parameters (shown). After a successful test, you should insert any additional/optional parameters that you feel are useful.

a) Select BitGo Wallet

b) Parameters:    

host : port : token : wallet_id : wallet_passphrase : num_blocks : fee_rate : max_fee_rate

• host is explained towards the top of this article: BitGo Express Parameters | “host”:

• port normally 3080, but see: BitGo Express Parameters | “port”:

• token is from: BitGo Express Parameters | b) token

• wallet_id is from: BitGo Express Parameters | c) wallet_id

• wallet_passphrase is from: BitGo Express Parameters | d) wallet_passphrase

• num_blocks (optional, default=2) (BTC only): the targeted number of blocks for confirmation. The lower the number, the higher the mining fees (but confirmation is faster).

  • See: this Bitgo article.

• fee_rate (optional): the MINIMUM amount in the basic units of the given cryptocurrency.

  • e.g. Bitcoin: “satoshis per kvByte” (minimum: 1000), must be less than max_fee_rate.

• max_fee_rate (optional): the MAXIMUM amount in the basic units of the given cryptocurrency.

  • e.g. Bitcoin: “satoshis per kvByte” (minimum: 1000).

In this example, using required parameters only, our "Parameters" looks like this (all one line, no spaces):

• When entering a parameter string, the string must be completely entered every time.

  • i.e. you cannot just replace the “host” or “token” values without entering the other values as well.

3) Enable the GB Wallet Tunnel and enter the tunnel password:

• The BE (Bitgo Express) node should always be on a dedicated & separate server.

• The GB Wallet Tunnel offers a open source, secure SSH tunnel connection to the BE node.

• Leave this disabled if you use, understand, and manage your own alternate form of SSH tunnel.

4) Save the Crypto Setting!

5) Reload the Crypto Setting, and test what you just saved.

Troubleshooting Tips:

The Hot Wallet BUY test validates your Hot Wallet parameters (only).

• The other Crypto Setting tests (Exchange, Rate Source, etc) are irrelevant in this scope.

• The master log will contain more specific and relevant data regarding any failures.

Have you set “Spending Limits” for your authorization token?

Spending Limits may be set when creating the access token at Bitgo.

• A “best practice” is to set a reasonable limit. See: https://generalbytes.atlassian.net/l/cp/Xv9ihqgM

• You must create a new access token at Bitgo (and re-enter the parameters) if you experience this issue.

Is your tunnel working?

The wallet tunnel is critical for success. Here are some troubleshooting steps:

GB Wallet Tunnel Server | Troubleshooting

Alternative (unsupported): SSH Tunneling

Have you whitelisted your BitGo Express node in your BitGo API keys?

See the instructions above: BitGo Express Parameters | 2. Prepare your developer API token at BitGo.

• BitGo must permit your BitGo Express node to connect to it’s network, and that is partly controlled by the IP whitelist set by your account when creating the API token.

A standard (free) Bitgo account permits these coins (as of Nov 2022):

Currently, these are the additional coins that a Bitgo institutional account allows: