bititio/bitgo-ruby

Bitgo Ruby Gem

Lightweight wrapper for Bitgo and Bitgo Express REST API.

Note: This wrapper is work in progress and does not cover every API yet.

BitGo Documentation: https://www.bitgo.com/api/

Installation

gem install bitgo

Usage

# Setup an api instance
api = Bitgo::V1::Api.new(Bitgo::V1::Api::TEST )
api.session_token = "your session token"

# Available pre-defined API end points
# Bitgo::V1::Api::TEST : https://test.bitgo.com/api/v1
# Bitgo::V1::Api::LIVE : https://bitgo.com/api/v1
# Bitgo::V1::Api::EXPRESS : http://127.0.0.1:3080/api/v1

Custom Endpoint

# If you have a custom bitgo express end point, you may use it
api = Bitgo::V1::Api.new('https://my-bitgo-express-endpoint.com')

User API

api.session_info
api.login(email: 'xx', password: 'xx', otp: 'xx')
api.logout
api.send_otp(send_sms: false)
api.session_information
api.lock
api.unlock(otp: 'xx', duration_seconds: 600)

Keychains API

api.list_keychains
api.create_keychains(seed)
api.add_keychain(xpub: 'xx', encrypted_xprv: 'xx')
api.create_bitgo_keychain

Address Labels API

api.list_labels
api.list_labels_for_wallet(wallet_id: 'xx')
api.set_label(wallet_id: 'xx', address: 'xx', label: 'xx')
api.delete_label(wallet_id: 'xx', address: 'xx')

Wallets API

api.list_wallets
api.simple_create_wallet(passphrase: 'xx', label: 'xx') # Bitgo express
api.add_wallet(label: 'xx', m: 2, n: 3, keychains: 'xxx', enterprise: 'xx')
api.get_wallet(wallet_id: 'xx')
api.list_wallet_addresses(walet_id: 'xx')
api.create_address(wallet_id: 'xx', chain: 'xx')
api.send_coins_to_address(wallet_id: 'xx', address: 'address', amount: 'xx', wallet_passphrase: 'xx')

Webhooks API

api.add_webhook(wallet_id: 'xx', type: 'xx', url: 'xx', confirmations: 'xx')
api.remove_webhook(wallet_id: 'xx', type: 'xx', url: 'xx')
api.list_webhooks(wallet_id: 'xx')

Utilities API (Via Bitgo Express)

api.encrypt(input: 'string to encrypt, usually xprv', password: 'password to encrypt')
api.decrypt(input: 'string to decrypt, output of encrypt()', password: 'password to decrypt')
api.verify_address(address: 'xx')

Contributors

• Gerry Eng
• Pramodh Rai

Todo

• Cover all APIs
• Unit Tests