The implementation of the Open Assets Protocol for Ruby.
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

openassets-ruby Build Status Gem Version MIT License

The implementation of the Open Assets Protocol for Ruby.

Install

gem install openassets-ruby

Configuration

Initialize the connection information to the Bitcoin Core server.

  • use mainnet

    require 'openassets'
    
    api = OpenAssets::Api.new({
        network:           'mainnet',
        provider:         'bitcoind',
        cache:            'cache.db',
        dust_limit:              600,
        default_fees:          10000,
        min_confirmation:          1,
        max_confirmation:    9999999,
        rpc: {
          user:                'xxx',
          password:            'xxx',
          schema:             'http',
          port:                 8332,
          host:          'localhost',
          timeout:                60,
          open_timeout:           60 }
      })
  • use testnet

    Change network and port depending on your server setting.

    require 'openassets'
    
    api = OpenAssets::Api.new({
        network:             'testnet',
        provider:           'bitcoind',
        cache:            'testnet.db',
        dust_limit:                600,
        default_fees:            10000,
        min_confirmation:            1,
        max_confirmation:      9999999,
        rpc: {
          user:                  'xxx',
          password:              'xxx',
          schema:               'http',
          port:                  18332,
          host:            'localhost',
          timeout:                  60,
          open_timeout:             60 }
      })
  • with multi-wallet support

    From Bitcoin Core version 0.15 onwards, change wallet depending on wallet settings.

    require 'openassets'
    
    api = OpenAssets::Api.new({
        network:             'testnet',
        provider:           'bitcoind',
        cache:            'testnet.db',
        dust_limit:                600,
        default_fees:            10000,
        min_confirmation:            1,
        max_confirmation:      9999999,
        rpc: {
          user:                  'xxx',
          password:              'xxx',
          schema:               'http',
          port:                  18332,
          host:            'localhost',
          wallet:         'wallet.dat',
          timeout:                  60,
          open_timeout:             60 }
      })

The configuration options are as follows:

option description default
network The using network. "mainnet" or "testnet" or "regtest" or "litecoin" or "litecoin_testnet" mainnet
provider The RPC server. "bitcoind" is the only option for now. bitcoind
cache The path to the database file. Specify ':memory:' to use in-memory database. cache.db
dust_limit The amount of Bitcoin, which is set to the each output of the Open Assets Protocol (issue or transfer). 600 (satoshi)
default_fees The default transaction fee in satoshi. Specify :auto to use auto fee settings. (used by issue_asset and send_asset, send_bitcoin ) 10000 (satoshi)
min_confirmation The minimum number of confirmations the transaction containing an output that used to get UTXO. 1
max_confirmation The maximum number of confirmations the transaction containing an output that used to get UTXO. 9999999
rpc The access information to the RPC server of Bitcoin Core. N/A

Using the API with multi-wallet support

To use the Bitcoin Core multi-wallet support (version 0.15 onwards), you should use multiple instances of API, for example:

@apis = Hash.new
@apis[1] = OpenAssets::Api.new({
            network:             'testnet',
            provider:           'bitcoind',
            cache:            'testnet.db',
            dust_limit:                600,
            default_fees:            10000,
            min_confirmation:            1,
            max_confirmation:      9999999,
            rpc: {
              user:                  'xxx',
              password:              'xxx',
              schema:               'http',
              port:                  18332,
              host:            'localhost',
              wallet:      'wallet001.dat',
              timeout:                  60,
              open_timeout:             60 }
          })
@apis[2] = OpenAssets::Api.new({
            network:             'testnet',
            provider:           'bitcoind',
            cache:            'testnet.db',
            dust_limit:                600,
            default_fees:            10000,
            min_confirmation:            1,
            max_confirmation:      9999999,
            rpc: {
              user:                  'xxx',
              password:              'xxx',
              schema:               'http',
              port:                  18332,
              host:            'localhost',
              wallet:      'wallet002.dat',
              timeout:                  60,
              open_timeout:             60 }
          })
# More wallets perhaps...
# Then call API selectively
@apis[1].provider.list_unspent
@apis[2].provider.list_unspent

API

Currently openassets-ruby support the following API.

  • list_unspent Returns an array of unspent transaction outputs, argument with the asset ID and quantity of each output.

    # get all unspent outputs in the wallet.
    api.list_unspent
    
    # specify th open asset address.
    api.list_unspent(['akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6'])
    
    > [
        {
          "txid": "1610a1f62597a3ea36e09e78354be22d2a958c1a38ed9e5d3f1c2811ee82dc37",
          "vout": 1,
          "address": "1HhJs3JgbiyxC8ktfi6nU4wTqVmrMtCVkG",
          "oa_address": "akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6",
          "script": "76a914b7218fe503cd18555255e5b13d4f07f3fd00d0c988ac",
          "amount": "0.00000600",
          "confirmations": 8338,
          "asset_id": "AWo3R89p5REmoSyMWB8AeUmud8456bRxZL",
          "account": "openassets-ruby",
          "asset_quantity": "67",
          "asset_amount": "6.7",
          "asset_definition_url": "http://goo.gl/fS4mEj",
          "proof_of_authenticity": false
        },
        ...

    Output items are as follows.

    Item description
    txid The TXID of the transaction containing the output.
    address A P2PKH or P2SH address.
    oa_address The Open Asset address.
    script The output script.
    amount The Bitcoin amount.
    confirmations A score indicating the number of blocks on the best block chain that would need to be modified to remove or modify a particular transaction.
    asset_id The asset ID is a 160 bits hash, used to uniquely identify the asset stored on the output.
    account The name of an account.
    asset_quantity The asset quantity is an unsigned integer representing how many units of that asset are stored on the output.
    asset_amount The asset amount is the value obtained by converting the asset quantity to the unit of divisibility that are defined in the Asset definition file.
    asset_definition_url The url of asset definition file.
    proof_of_authenticity The result of Proof of Authenticity that is checked consistent with the subject in the SSL certificate. If the result is true, issuer is verified. If the result is false, issuer is not verified. This verification is performed only if link_to_website that is defined in Asset Definition File is true.
  • get_balance Returns the balance in both bitcoin and colored coin assets for all of the addresses available in your Bitcoin Core wallet.

    # get all balance in the wallet.
    api.get_balance
    
    # specify the open asset address.
    api.get_balance('akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6')
    > [
        {
          "address": "1HhJs3JgbiyxC8ktfi6nU4wTqVmrMtCVkG",
          "oa_address": "akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6",
          "value": "0.00018200",
          "assets": [
            {
              "asset_id": "AWo3R89p5REmoSyMWB8AeUmud8456bRxZL",
              "quantity": "81",
              "amount": "20.7",
              "asset_definition_url": "http://goo.gl/fS4mEj",
              "proof_of_authenticity": false
            },
            {
              "asset_id": "AJk2Gx5V67S2wNuwTK5hef3TpHunfbjcmX",
              "quantity": "67",
              "amount": "6.7",
              "asset_definition_url": "",
              "proof_of_authenticity": false
            }
          ],
          "account": "openassets-ruby"
        },

    Output items are as follows.

    Item description
    address A P2PKH or P2SH address.
    oa_address The Open Asset address.
    value The Bitcoin amount.
    assets The array of the assets.
    asset_id The asset ID is a 160 bits hash, used to uniquely identify the asset stored on the output.
    asset_quantity The asset quantity is an unsigned integer representing how many units of that asset are stored on the output.
    asset_amount The asset amount is the value obtained by converting the asset quantity to the unit of divisibility that are defined in the Asset definition file.
    asset_definition_url The url of asset definition file.
    proof_of_authenticity The result of Proof of Authenticity that is checked consistent with the subject in the SSL certificate. If the result is true, issuer is verified. If the result is false, issuer is not verified. This verification is performed only if link_to_website that is defined in Asset Definition File is true.
    account The name of an account.
  • issue_asset Creates a transaction for issuing an asset.

    # issue asset
    # api.issue_asset(<issuer open asset address>,
    #                 <issuing asset quantity>,
    #                 <metadata>,
    #                 <to open asset address>,
    #                 <fees (The fess in satoshis for the transaction. use 10000 satoshi if specified nil)>,
    #                 <mode=('broadcast', 'signed', 'unsigned')>,
    #                 <output_qty default value is 1.>)
    
    # example
    address = 'akEJwzkzEFau4t2wjbXoMs7MwtZkB8xixmH'
    api.issue_asset(address, 150, 'u=https://goo.gl/bmVEuw', address, nil, 'broadcast')

If specified output_qty, the issue output is divided by the number of output_qty. For example, amount = 125 and output_qty = 2, the marker output asset quantity is [62, 63] and issue TxOut is two.

  • send_asset Creates a transaction for sending an asset from the open asset address to another.
    # send asset
    # api.send_asset(<from open asset address>,
    #                <asset ID>,
    #                <asset quantity>,
    #                <to open asset address>,
    #                <fees (The fess in satoshis for the transaction. use 10000 satoshi if specified nil)>,
    #                <mode=('broadcast', 'signed', 'unsigned')>,
    #                <output_qty default value is 1.>)
    
    # example
    from = 'akXDPMMHHBrUrd1fM756M1GSB8viVAwMyBk'
    to = 'akTfC7D825Cse4NvFiLCy7vr3B6x2Mpq8t6'
    api.send_asset(from, 'AWo3R89p5REmoSyMWB8AeUmud8456bRxZL', 100, to, 10000, 'broadcast')

If specified output_qty, the send output is divided by the number of output_qty. Ex, asset holding amount = 200, and send amount = 125 and output_qty = 2, the marker output asset quantity is [62, 63, 75] and send TxOut is three. The last of the asset quantity is change asset output.

  • send_bitcoin Creates a transaction for sending bitcoins from an address to another. This transaction inputs use only uncolored outputs.
    # send bitcoin
    # api.send_bitcoin(<from btc address>,
    #                  <amount (satoshi)>,
    #                  <to btc address>,
    #                  <fees (The fess in satoshis for the transaction. use 10000 satoshi if specified nil)>,
    #                  <mode=('broadcast', 'signed', 'unsigned')>,
    #                  <output_qty default value is 1.>)
    
    # example
    from = '14M4kbAtn71P1nnNYuhBDFTNYxa19t1XP6'
    to = '1MFW7BTwiNbAkmVz4SzAMQXboKYKGSzkq2'
    api.send_bitcoin(from, 60000, to)

If specified output_qty, the send output is divided by the number of output_qty. Ex, amount = 60000 and output_qty = 2, send TxOut is two (each value is 30000, 30000) and change TxOut one.

  • get_outputs_from_txid Get tx outputs. (use for debug)

    # api.get_outputs_from_txid(<txid>, <use_cache default value is false.>)
    
    # example
    api.get_outputs_from_txid('3fba8bfb157ae29c293d5bd65c178fec169a87f880e2e62537fcce26612a6aa3')
    > [{
        "address": "14M4kbAtn71P1nnNYuhBDFTNYxa19t1XP6",
        "oa_address": "akEJwzkzEFau4t2wjbXoMs7MwtZkB8xixmH",
        "script": "76a91424b3d405bc60bd9628691fe28bb00f6800e1480688ac",
        "amount": "0.00000600",
        "asset_id": "AWo3R89p5REmoSyMWB8AeUmud8456bRxZL",
        "asset_quantity": "1",
        "asset_amount": "1",
        "account": null,
        "asset_definition_url": "",
        "txid": "3fba8bfb157ae29c293d5bd65c178fec169a87f880e2e62537fcce26612a6aa3",
        "vout": 1
      },..
  • send_assets Creates a transaction for sending multiple asset from the open asset address(es) to another. <from open asset address> is used to send bitcoins if needed, and receive bitcoin change if any.

    # send assets
    # api.send_assets(<from open asset address>,
    #                 <The array of send Asset information(see OpenAssets::SendAssetParam).>,
    #                 <fees (The fess in satoshis for the transaction. use 10000 satoshi if specified nil)>,
    #                 <mode=('broadcast', 'signed', 'unsigned')>,
    #                 <output_qty default value is 1.>)
    
    # example
    from = api.address_to_oa_address('mrxpeizRrF8ymNx5FrvcGGZVecZjtUFVP3')
    to = api.address_to_oa_address('n4MEsSUN8GktDFZzU3V55mP3jWGMN7e4wE')
    params = []
    params << OpenAssets::SendAssetParam.new('oGu4VXx2TU97d9LmPP8PMCkHckkcPqC5RY', 50, to)
    params << OpenAssets::SendAssetParam.new('oUygwarZqNGrjDvcZUpZdvEc7es6dcs1vs', 4, to)
    tx = api.send_assets(from, params)
    
    # send assets from multiple addresses.
    change_address = 'mwxeANpckdbdgZCpUMTceQhbbhLPJiqpfD'
    from = [
      api.address_to_oa_address("mrxpeizRrF8ymNx5FrvcGGZVecZjtUFVP3"),
      api.address_to_oa_address("mvYbB238p3rFYFjM56cHhNNHeQb5ypQJ3T")
    ]
    to = api.address_to_oa_address('n4MEsSUN8GktDFZzU3V55mP3jWGMN7e4wE')
    params = []
    params << OpenAssets::SendAssetParam.new('oGu4VXx2TU97d9LmPP8PMCkHckkcPqC5RY', 100, to, from[0])
    params << OpenAssets::SendAssetParam.new('oUygwarZqNGrjDvcZUpZdvEc7es6dcs1vs', 100, to, from[1])
    tx = api.send_assets(change_address, params)
  • send_bitcoins Creates a transaction for sending multiple bitcoins from an address to others. This transaction inputs use only uncolored outputs.

    # send bitcoins
    # api.send_bitcoins(<from btc address>,
    #                   <The array of send bitcoin information(see OpenAssets::SendBitcoinParam).>,
    #                   <fees (The fess in satoshis for the transaction. use 10000 satoshi if specified nil)>,
    #                   <mode=('broadcast', 'signed', 'unsigned')>,
    #                   <output_qty default value is 1.>)
    
    # example
    from = 'mrxpeizRrF8ymNx5FrvcGGZVecZjtUFVP3'
    to1 = 'n4MEsSUN8GktDFZzU3V55mP3jWGMN7e4wE'
    to2 = 'mvYbB238p3rFYFjM56cHhNNHeQb5ypQJ3T'
    params = []
    params << OpenAssets::SendBitcoinParam.new(50000, to1)
    params << OpenAssets::SendBitcoinParam.new(3000, to2)
    tx = api.send_bitcoins(from, params)
  • burn_asset Creates a transaction for burn asset. This API is to burn the asset by spending the all UTXO of specified asset as Bitcoin.

    # burn_asset
    # api.burn_asset(<from open asset address>,
    #                <asset ID>,
    #                <fees (The fess in satoshis for the transaction. use 10000 satoshi if specified nil)>,
    #                <mode=('broadcast', 'signed', 'unsigned')>
    
    # example
    oa_address = 'bX2vhttomKj2fdd7SJV2nv8U4zDjusE5Y4B'
    asset_id = 'oGu4VXx2TU97d9LmPP8PMCkHckkcPqC5RY'
    tx = api.burn_asset(oa_address, asset_id)

    Note: Burnt asset will be lost forever.

Command line interface

Openassets-ruby comes with a openassets command line interface that allows easy interaction with OpenAssets.

Usage

openassets [options] [command]

Options:
-c path to config JSON which is passed to OpenAssets::Api.new - see Configuration for details
-e load config from ENV variables (look at the exe/openassets file for details)

commands:
* console runs an IRB console and gives you an initialized API instance to interact with OpenAssets
* any method on the API instance, helpful for get_balance, list_unspent

License

openassets-ruby is licensed under the MIT License.