Skip to content

Latest commit

 

History

History
190 lines (146 loc) · 6.12 KB

object_ids.md

File metadata and controls

190 lines (146 loc) · 6.12 KB

Objects and IDs

Table of Contents:

In contrast to most cryptocurrency wallets, the BitShares-Core uses a different model to represent the blockchain, transactions, and accounts. On the BitShares blockchains, there are no addresses. So, the objects are identified by a unique id, a type and space.

BitShares Objects Format

space.type.id

List of Commonly used Objects

ID Object Type
1.1.x base object
1.2.x account object
1.3.x asset object
1.4.x force settlement object
1.5.x committee member object
1.6.x witness object
1.7.x limit order object
1.8.x call order object
1.9.x custom object
1.10.x proposal object
1.11.x operation history object
1.12.x withdraw permission object
1.13.x vesting balance object
1.14.x worker object
1.15.x balance object
2.---
2.0.x global_property_object
2.1.x dynamic_global_property_object
2.3.x asset_dynamic_data
2.4.x asset_bitasset_data
2.5.x account_balance_object
2.6.x account_statistics_object
2.7.x transaction_object
2.8.x block_summary_object
2.9.x account_transaction_history_object
2.10.x blinded_balance_object
2.11.x chain_property_object
2.12.x witness_schedule_object
2.13.x budget_record_object
2.14.x special_authority_object

Examples

Object ID Translates to
1.2.0 committee-account details
1.3.0 asset BTS, core asset details
1.3.1 asset USD
2.0.0 global blockchain parameters
2.1.0 current blockchain data
Object ID Translates to
1.11.<id> operation with id
1.14.7 # protocol space / worker / id: 7
1.2.15 # protocol space / account / id: 15
1.6.<id> block signer
1.6.105 # protocol space / witness / id: 105
2.1.0 # implementation space / dynamic global properties
2.3.8 # implementation space / asset . id: 8

Examples - Accounts

The BitShares blockchain users are requires to register each account with a unique username and a public key on the blockchain. The blockchain assigns an incremental user id and offers to resolve the name-to-id pair.

Object ID Translates to
2.6.80 # implementation space / account-balance / id: 80
2.7.80 # implementation space / account-statistics / id: 80
2.10.80 # implementation space / account-transactions / id: 80
2.8.80 # implementation space / transactions / id: 80
2.9.80 # implementation space / block-summary / id: 80

A programmatic description of all fields can be found in the sources.

Example Call and a result: account object (id: 1.2.x)

	unlocked >>> get_account_id "user123"
	
	get_account_id "user123"
	"1.2.539269"
	unlocked >>>

Example Call and a result: asset object (id: 1.3.x)

	unlocked >>> list_assets "BTS" "2"
	
	list_assets "BTS" "2"
	[{
			"id": "1.3.0",
			"symbol": "BTS",
			"precision": 5,
			"issuer": "1.2.3",

		....
			"dynamic_asset_data_id": "2.3.368"
		}
	]

Definitions

For advanced users that want to deal with the C++ code of graphene, we here list the definition of object_type and impl_object_type:

Protocol Space (1.x.x)

List all object types from all namespaces here so they can be easily reflected and displayed in debug output. If a 3rd party wants to extend the core code then they will have to change the packed_object::type field from enum_type to uint16 to avoid warnings when converting packed_objects to/from json.

enum graphene::chain::object_type
---Values---
null_object_type
base_object_type
account_object_type
asset_object_type
force_settlement_object_type
committee_member_object_type
witness_object_type
limit_order_object_type
call_order_object_type
custom_object_type
proposal_object_type
operation_history_object_type
withdraw_permission_object_type
vesting_balance_object_type
worker_object_type
balance_object_type
OBJECT_TYPE_COUNT

Sentry value which contains the number of different object types.

Implementattion Space (2.x.x)

enum graphene::chain::impl_object_type
---Values---
impl_global_property_object_type
impl_dynamic_global_property_object_type
impl_reserved0_object_type
impl_asset_dynamic_data_type
impl_asset_bitasset_data_type
impl_account_balance_object_type
impl_account_statistics_object_type
impl_transaction_object_type
impl_block_summary_object_type
impl_account_transaction_history_object_type
impl_blinded_balance_object_type
impl_chain_property_object_type
impl_witness_schedule_object_type
impl_budget_record_object_type
impl_special_authority_object_type
impl_buyback_object_type
impl_fba_accumulator_object_type

(ref)