package protocol

Get desktop application:
View/edit binary Protocol Buffers messages

• string address = 1

• int64 nonce = 2

  Last transaction seq

• optional AccountPrivilege priv = 3

• bytes metadatas_hash = 4

  metadatas_hash = merklehash(metadatas);

• bytes assets_hash = 5

  assets_hash = merkelhash(assets)

• optional Contract contract = 6

• int64 balance = 7

• optional ControlledArea controlled_area = 8

• string public_key = 9

Used in: Account, OperationCreateAccount

• int64 master_weight = 1

• repeated Signer signers = 2

• optional AccountThreshold thresholds = 3

Used in: AccountPrivilege

• int64 tx_threshold = 1

  required, [-1,MAX(INT64)] -1: indicates no setting

• repeated OperationTypeThreshold type_thresholds = 2

• string sender = 1

• string data = 2

• int64 timestamp = 3

Register notification events

• repeated ChainMessageType api_list = 1

  By default, enable all apis

• int64 timestamp = 2

message interfaces for java

Used in: ChainHello

• CHAIN_TYPE_NONE = 0

• CHAIN_HELLO = 10

  response with CHAIN_STATUS = 2;

• CHAIN_TX_STATUS = 11

• CHAIN_PEER_ONLINE = 12

• CHAIN_PEER_OFFLINE = 13

• CHAIN_PEER_MESSAGE = 14

• CHAIN_SUBMITTRANSACTION = 15

• CHAIN_LEDGER_HEADER = 16

  bifchain notifies the client ledger(protocol::LedgerHeader) when closed

• CHAIN_CONTRACT_LOG = 17

  smart contract log

• CHAIN_LEDGER_TXS = 18

• CHAIN_SUBSCRIBE_TX = 19

  response with CHAIN_RESPONSE

• CHAIN_TX_ENV_STORE = 20

• string src_peer_addr = 1

• repeated string des_peer_addrs = 2

• bytes data = 3

• int32 error_code = 1

• string error_desc = 2

1.ChainHello response 2.async notification from local

• string self_addr = 1

• int64 ledger_version = 2

• int64 monitor_version = 3

• string chain_version = 4

• int64 timestamp = 5

• int64 network_id = 6

• string chain_code = 7

• string address_prefix = 8

• repeated string address = 1

• ChainTxStatus.TxStatus status = 1

• string tx_hash = 2

• string source_address = 3

• int64 source_account_seq = 4

• int64 ledger_seq = 5

  on which block this tx records

• int64 new_account_seq = 6

  new account sequence if COMPLETE

• ERRORCODE error_code = 7

  use it if FAIL

• string error_desc = 8

  error desc

• int64 timestamp = 9

Used in: ChainTxStatus

• UNDEFINED = 0

• CONFIRMED = 1

  web server will check tx parameters, signatures etc fist, noitfy CONFIRMED if pass

• PENDING = 2

  master will check futher before put it into pending queue

• COMPLETE = 3

  notify if Tx write ledger successfully

• FAILURE = 4

  notify once failed before broadcast and set error_code

• APPLY_FAILURE = 5

  notify once failed after apply and set error_code

Used in: Ledgers

• optional TransactionEnvSet txset = 1

• int64 close_time = 2

• bytes previous_proof = 3

• int64 ledger_seq = 4

• bytes previous_ledger_hash = 5

• optional LedgerUpgrade ledger_upgrade = 6

• optional ConsensusValueValidation validation = 7

• bytes txs = 8

• bytes txhash = 9

Used in: ConsensusValue

• repeated int32 expire_tx_ids = 1

  Contract execution expired

• repeated int32 error_tx_ids = 2

• int32 succ_tx_count = 3

  May contain other checks

Used in: Account, OperationCreateAccount, OperationCreatePrivateContract, PrivateContractAccount

• Contract.ContractType type = 1

• string payload = 2

• int64 version = 3

Used in: Contract

• JAVASCRIPT = 0

• EVM = 1

• SYSTEM = 2

Used in: Account

• ControlledArea.TRUST_FLAG trusted = 1

• ControlledArea.STATUS_FALG status = 2

• repeated KeyPair attributes = 3

Used in: ControlledArea, OperationSetControlledArea

• ENABLED = 0

• DISABLED = 1

Used in: ControlledArea, OperationSetControlledArea

• UNCERT = 0

• TRUSTED = 1

• UNTRUSTED = 2

for dont have

• int64 type = 1

• bytes hash = 2

Used in: ChainTxStatus, HelloResponse, TransactionEnvResult

• ERRCODE_SUCCESS = 0

• ERRCODE_INTERNAL_ERROR = 1

• ERRCODE_INVALID_PARAMETER = 2

• ERRCODE_ALREADY_EXIST = 3

• ERRCODE_NOT_EXIST = 4

• ERRCODE_TX_TIMEOUT = 5

• ERRCODE_ACCESS_DENIED = 6

• ERRCODE_MATH_OVERFLOW = 7

• ERRCODE_EXPR_CONDITION_RESULT_FALSE = 20

• ERRCODE_EXPR_CONDITION_SYNTAX_ERROR = 21

• ERRCODE_INVALID_PUBKEY = 90

  UNUSED

• ERRCODE_INVALID_PRIKEY = 91

• ERRCODE_ASSET_INVALID = 92

• ERRCODE_INVALID_SIGNATURE = 93

• ERRCODE_INVALID_ADDRESS = 94

• ERRCODE_MISSING_OPERATIONS = 97

• ERRCODE_TOO_MANY_OPERATIONS = 98

• ERRCODE_BAD_SEQUENCE = 99

• ERRCODE_ACCOUNT_LOW_RESERVE = 100

  BUCHAIN LOW RESERVE

• ERRCODE_ACCOUNT_SOURCEDEST_EQUAL = 101

• ERRCODE_ACCOUNT_DEST_EXIST = 102

• ERRCODE_ACCOUNT_NOT_EXIST = 103

• ERRCODE_ACCOUNT_ASSET_LOW_RESERVE = 104

  IOU LOW RESERVE

• ERRCODE_ACCOUNT_ASSET_AMOUNT_TOO_LARGE = 105

• ERRCODE_ACCOUNT_INIT_LOW_RESERVE = 106

• ERRCODE_FEE_NOT_ENOUGH = 111

• ERRCODE_FEE_INVALID = 112

• ERRCODE_OUT_OF_TXCACHE = 114

• ERRCODE_WEIGHT_NOT_VALID = 120

• ERRCODE_THRESHOLD_NOT_VALID = 121

• ERRCODE_INVALID_DATAVERSION = 144

  metadata version error

• ERRCODE_TX_SIZE_TOO_BIG = 146

• ERRCODE_CONTRACT_EXECUTE_FAIL = 151

• ERRCODE_CONTRACT_SYNTAX_ERROR = 152

• ERRCODE_CONTRACT_TOO_MANY_RECURSION = 153

• ERRCODE_CONTRACT_TOO_MANY_TRANSACTIONS = 154

• ERRCODE_CONTRACT_EXECUTE_EXPIRED = 155

• ERRCODE_INVALID_CONTRACT = 156

• ERRCODE_INVALID_CONTRACTVERSION = 157

  contract version error

• ERRCODE_TX_INSERT_QUEUE_FAIL = 160

for key value db storage

• repeated bytes entry = 1

for getledgers

• int64 begin = 1

• int64 end = 2

• int64 timestamp = 3

• int64 chain_id = 4

• int64 network_id = 1

• int64 ledger_version = 2

• int64 overlay_version = 3

• string chain_version = 4

• int64 listening_port = 5

• string node_address = 6

• string node_rand = 7

• string license = 8

• ERRORCODE error_code = 1

• string error_desc = 2

Used in: ControlledArea, OperationCreateAccount, OperationSetControlledArea

• string key = 1

• string value = 2

• int64 version = 3

• optional LedgerHeader header = 1

• repeated TransactionEnv transaction_envs = 2

Used in: Ledger, LedgerTxs

• int64 seq = 1

• bytes hash = 2

• bytes previous_hash = 3

• bytes account_tree_hash = 4

• int64 close_time = 5

• bytes consensus_value_hash = 6

• int64 version = 7

• int64 tx_count = 8

• bytes validators_hash = 9

  hash

• string reserve = 10

• bytes fees_hash = 11

• int64 chain_id = 12

• optional LedgerHeader header = 1

• repeated TransactionEnvResult txs = 2

• int64 ledger_length = 3

Used in: ConsensusValue, LedgerUpgradeNotify

• int64 new_ledger_version = 1

  will be processed as required at verion 2.1.0.0

• repeated string new_validator_list = 2

  for hardfork

• string chain_code = 3

for ledger upgrade

• int64 nonce = 1

  for broadcast

• optional LedgerUpgrade upgrade = 2

• optional Signature signature = 3

  consensus sig

for ledgers

• repeated ConsensusValue values = 1

• Ledgers.SyncCode sync_code = 2

• int64 max_seq = 3

• bytes proof = 4

• int64 chain_id = 5

Used in: Ledgers

• OK = 0

  Success

• OUT_OF_SYNC = 1

  The node itself is not in sync status

• OUT_OF_LEDGERS = 2

  Too many requested ledgers

• BUSY = 3

  This node is occupied

• REFUSE = 4

  The node itself is not allow sync

• INTERNAL = 5

  Inner error

• UNKNOWN = 0

• SIGNATURE = 100

• OVERLAY_MSGTYPE_NONE = 0

• OVERLAY_MSGTYPE_PING = 1

• OVERLAY_MSGTYPE_HELLO = 2

• OVERLAY_MSGTYPE_PEERS = 3

• OVERLAY_MSGTYPE_TRANSACTION = 4

• OVERLAY_MSGTYPE_LEDGERS = 5

• OVERLAY_MSGTYPE_PBFT = 6

• OVERLAY_MSGTYPE_LEDGER_UPGRADE_NOTIFY = 7

  Broadcast the ledger upgrade status

Used in: Transaction

• Operation.Type type = 1

• string source_address = 2

• bytes metadata = 3

• optional OperationCreateAccount create_account = 4

• optional OperationSetMetadata set_metadata = 7

• optional OperationSetSignerWeight set_signer_weight = 8

• optional OperationSetThreshold set_threshold = 9

• optional OperationPayCoin pay_coin = 10

• optional OperationLog log = 11

• optional OperationSetPrivilege set_privilege = 12

• optional OperationUpgradeContract upgrade_contract = 13

• optional OperationSetControlledArea set_controlled_area = 14

• optional OperationCreatePrivateContract create_private_contract = 15

• optional OperationCallPrivateContract call_private_contract = 16

• bytes raw_source_address = 20

Used in: Operation, OperationTypeThreshold

• UNKNOWN = 0

• CREATE_ACCOUNT = 1

• SET_METADATA = 4

• SET_SIGNER_WEIGHT = 5

• SET_THRESHOLD = 6

• PAY_COIN = 7

• LOG = 8

• SET_PRIVILEGE = 9

• UPGRADE_CONTRACT = 10

• SET_CONTROLLED_AREA = 11

• CREATE_PRIVATE_CONTRACT = 12

• CALL_PRIVATE_CONTRACT = 13

Used in: Operation

• string dest_address = 1

• string input = 2

Used in: Operation

• string dest_address = 1

• optional Contract contract = 2

• optional AccountPrivilege priv = 3

• repeated KeyPair metadatas = 4

• int64 init_balance = 5

• string init_input = 6

• string dest_public_key = 7

• bytes raw_dest_address = 8

Used in: Operation

• optional Contract contract = 1

• string init_input = 2

Used in: Operation

• string topic = 1

• repeated string datas = 2

Used in: Operation

• string dest_address = 1

• int64 amount = 2

• string input = 3

• bytes raw_dest_address = 4

Used in: Operation

• string dest_address = 1

• bool s_trusted = 2

• bool s_status = 3

• ControlledArea.TRUST_FLAG trusted = 4

• ControlledArea.STATUS_FALG status = 5

• repeated KeyPair attributes = 6

Used in: Operation

• string key = 1

• string value = 2

• int64 version = 3

  Optional. The version number of metadata. If set, it must be the same as the existing metadata_version of the account.

• bool delete_flag = 4

Used in: Operation

• string master_weight = 1

• repeated Signer signers = 2

• string tx_threshold = 3

• repeated OperationTypeThreshold type_thresholds = 4

Used in: Operation

• int64 master_weight = 1

  required, [-1,MAX(UINT32)] -1: indicates no setting

• repeated Signer signers = 2

  address:weight, if weight is 0, it indicates deleting this signer

Used in: Operation

• int64 tx_threshold = 1

• repeated OperationTypeThreshold type_thresholds = 4

  type:threshold, threshold:0 indicates deleting this type

Used in: AccountThreshold, OperationSetPrivilege, OperationSetThreshold

• Operation.Type type = 1

• int64 threshold = 2

Used in: Operation

• string dest_address = 1

• string payload = 2

• int64 type = 3

for peers message

Used in: Peers

• string ip = 1

• int64 port = 2

• int64 num_failures = 3

• int64 next_attempt_time = 4

• int64 active_time = 5

• int64 connection_id = 6

• repeated Peer peers = 1

for ping messsage

• int64 nonce = 1

for pong message

• int64 nonce = 1

• string address = 1

• bytes metadatas_hash = 2

  metadatas_hash = merklehash(metadatas);

• optional Contract contract = 3

Used in: LedgerUpgradeNotify, TransactionEnv

• string public_key = 1

• bytes sign_data = 2

Used in: AccountPrivilege, OperationSetPrivilege, OperationSetSignerWeight

• string address = 1

• int64 weight = 2

• SIGNER_NONE = 0

• SIGNER = 100

Used in: TransactionEnv

• string source_address = 1

• int64 nonce = 2

• string expr_condition = 3

• repeated Operation operations = 4

• bytes metadata = 5

• int64 fee_limit = 6

• int64 gas_price = 7

• int64 ceil_ledger_seq = 8

• int64 chain_id = 9

• string address_prefix = 10

  it represent the address is raw

• bytes raw_source_address = 11

• UNKNOWN = 0

• OPERATIONS = 1000

Used in: Ledger, TransactionEnvResult, TransactionEnvSet, TransactionEnvStore

• optional Transaction transaction = 1

• repeated Signature signatures = 2

• optional Trigger trigger = 3

Used in: LedgerTxs

• optional TransactionEnv tran_env = 1

• string tx_hash = 2

• ERRORCODE error_code = 3

• string error_desc = 4

• int64 ledger_seq = 5

• int64 close_time = 6

• int64 actual_fee = 7

• repeated bytes contract_tx_hashes = 8

Used in: ConsensusValue

• repeated TransactionEnv txs = 2

• optional TransactionEnv transaction_env = 1

• int32 error_code = 2

• string error_desc = 3

• int64 ledger_seq = 4

• int64 close_time = 5

• bytes hash = 6

  for notify

• int64 actual_fee = 7

• repeated bytes contract_tx_hashes = 8

Used in: TransactionEnv

• Trigger.TransactionType transaction_type = 1

• int64 ledger_seq = 2

  If it is triggered by a specific block (temporarily not provided)

• optional Trigger.OperationTrigger transaction = 3

  If it's a transaction triggered

Used in: Trigger

• bytes hash = 1

• int64 index = 2

Used in: Trigger

• NORMAL_TRANSACTION = 0

• CONTRACT_TRANSACTION = 1

• int64 type = 1

  1: ping

• bool request = 2

  true :request , false:reponse

• int64 sequence = 3

• bytes data = 4