package hive.protocol.buffers

Get desktop application:
View/edit binary Protocol Buffers messages

A new account may be created only by an existing account. The account that creates a new account pays a fee. The fee amount is set by the witnesses. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/09_account_create.md?ref_type=heads&plain=0&blame=1#2-parameters

Used in: operation

• required asset fee = 1

  @param {asset} fee - Paid by creator. The witnesses decide the amount of the fee. Now, it is 3 HIVE.

• required string creator = 2

  @param {string} creator - An account that creates a new account.

• required string new_account_name = 3

  @param {string} new_account_name - Valid account name may consist of many parts separated by a dot, total may have up to 16 characters, parts have to start from a letter, may be followed by numbers, or '-'.

• required authority owner = 4

  @param {authority} owner

• required authority active = 5

  @param {authority} active

• required authority posting = 6

  @param {authority} posting

• required string memo_key = 7

  @param {string} memo_key - Not authority, public memo key.

• required string json_metadata = 8

  @param {string} json_metadata

Deprecated. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/41_account_create_with_delegation.md?ref_type=heads

Used in: operation

• required asset fee = 1

• required asset delegation = 2

• required string creator = 3

• required string new_account_name = 4

• required authority owner = 5

• required authority active = 6

• required authority posting = 7

• required string memo_key = 8

• required string json_metadata = 9

• repeated future_extensions extensions = 10

Related to all acts of account creation, that is, creation of genesis accounts as well as operations: account_create_operation, account_create_with_delegation_operation, pow_operation, pow2_operation and create_claimed_account_operation. Generated every time one of above operations results in creation of new account (account is always created except for pow/pow2). Note: vops for genesis accounts are generated at the start of block #1.

Used in: operation

• required string new_account_name = 1

  @param {string} new_account_name - newly created account (receiver of initial_vesting_shares)

• required string creator = 2

  @param {string} creator - account that initiated new account creation (genesis and mined accounts are their own creators)

• required asset initial_vesting_shares = 3

  @param {asset} initial_vesting_shares - (VESTS) amount of initial vesting on new account (converted from creation fee prior to HF20)

• required asset initial_delegation = 4

  @param {asset} initial_delegation - (VESTS) amount of extra voting power on new account due to delegation

Operations account_update_operation and account_update2_operation share a limit of allowed updates of the owner authority: two executions per 60 minutes (HIVE_OWNER_UPDATE_LIMIT) (meaning each of them can be executed twice or both can be executed once during that time period). After 30 days (HIVE_OWNER_AUTH_RECOVERY_PERIOD) using the account recovery process to change the owner authority is no longer possible. The operation account_update_operation allows changing authorities, it doesn’t allow changing the posting_json_metadata. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/10_account_update.md?ref_type=heads

Used in: operation

• required string account = 1

  @param {string} account - Account name, it cannot be updated.

• optional authority owner = 2

  @param {authority} owner - In order to update the {owner}, the owner authority is required. It may be changed 2 times per hour. If a user provides a new authority, the old one will be deleted, but the deleted authority may be used up to 30 days in the process of the recovery account.

• optional authority active = 3

  @param {authority} active - In order to update the {active}, the active authority is required. If a user provides a new authority, the old one will be deleted.

• optional authority posting = 4

  @param {authority} posting - In order to update the {posting}, the active authority is required. If a user provides a new authority, the old one will be deleted.

• required string memo_key = 5

  @param {string} memo_key - In order to update the {memo_key}, active authority is required. If a user provides a new key, the old one will be deleted.

• required string json_metadata = 6

  @param {string} json_metadata - json_string; in order to update the {json_metadata}, the active authority is required.

There are two operations that allow updating an account data: account_update_operation and account_update2_operation. Operations account_update_operation and account_update2_operation share a limit of allowed updates of the owner authority - two executions per 60 minutes (HIVE_OWNER_UPDATE_LIMIT) - meaning each of them can be executed twice or both can be executed once during that time period. After 30 days (HIVE_OWNER_AUTH_RECOVERY_PERIOD) using the account recovery process to change the owner authority is no longer possible. The operation allows to update authority, json_metadata and the posting_json_metadata. Depending on what the user wants to change, a different authority has to be used. Each authority (owner, active, posting, memo_key) consists of: - weight_threshold - key or account name with its weight The authority may have more than one key and more than one assigned account name. @example Example 1: The posting authority: weight_threshold = 1 'first_key', weight = 1 'second_key', weight = 1 'account_name_1', weight = 1 The above settings mean that a user with 'first_key', a user with 'second_key' or a user 'account_name_1' may post on behalf of this account. @example Example 2: The posting authority: weight_threshold = 2 'first_key', weight = 1 'second_key', weight = 1 'account_name_1', weight = 1 The above settings mean that at least two signatures are needed to post on behalf of this account. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/43_account_update2.md?ref_type=heads

Used in: operation

• required string account = 1

  @param {string} account - Account name, it cannot be updated.

• optional authority owner = 2

  @param {authority} owner - Optional. In order to update the {owner}, the owner authority is required. It may be changed 2 times per hour. If a user provides a new authority, the old one will be deleted.

• optional authority active = 3

  @param {authority} active - Optional. In order to update the {active}, the active authority is required. If a user provides a new authority, the old one will be deleted.

• optional authority posting = 4

  @param {authority} posting - Optional. In order to update the {posting}, the active authority is required. If a user provides a new authority, the old one will be deleted.

• optional string memo_key = 5

  @param {string} memo_key - Optional. In order to update the {memo_key}, the active authority is required. If a user provides a new key, the old one will be deleted.

• required string json_metadata = 6

  @param {string} json_metadata - json_string; In order to update the {json_metadata}, the active authority is required.

• required string posting_json_metadata = 7

  @param {string} posting_json_metadata - json_string; In order to update the { posting_json_metadata }, the posting authority is required.

• repeated future_extensions extensions = 8

  @param {future_extensions} extensions

A user may vote for a witness or proposal directly (using an operation: account_witness_vote_operation or update_proposal_votes_operation) or indirectly (using the proxy - operation: account_witness_proxy_operation). If a user sets a proxy, the witness votes are removed and the proposal votes are deactivated. If a user removes a proxy, there are no witness votes and the proposal votes are activated. Settings proxy means that a user wants to cede a decision on which witnesses to vote for to an account indicated as {proxy}. {proxy} will also vote for proposals in the name of {account}. If the operation account_witness_vote_operation or account_witness_proxy_operation or update_proposal_votes_operation is not executed in HIVE_GOVERNANCE_VOTE_EXPIRATION_PERIOD, the votes are removed and the virtual operation: expired_account_notification_operation is generated. If the proxy was set and now it is removed, the additionally the virtual operation: proxy_cleared_operation is generated. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/13_account_witness_proxy.md?ref_type=heads

Used in: operation

• required string account = 1

  @param {string} account

• required string proxy = 2

  @param {string} proxy - Account name. To remove the proxy, the parameter should be set empty. Only one proxy may be set for an account.

A user may vote for a witness directly using an operation: account_witness_vote_operation or indirectly using the proxy - operation: account_witness_proxy_operation. All accounts with a Hive Power (also called Vesting Fund Shares or VESTS) can vote for up to 30 witnesses, but you cannot vote twice for the same witnesses. If a proxy is specified then all existing votes are removed. Your vote power depends on your HP. If the operation account_witness_vote_operation or account_witness_proxy_operation or update_proposal_votes_operation is not executed in a HIVE_GOVERNANCE_VOTE_EXPIRATION_PERIOD, the votes are removed and the virtual operation: expired_account_notification_operation is generated. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/12_account_witness_vote.md?ref_type=heads

Used in: operation

• required string account = 1

  @param {string} account

• required string witness = 2

  @param {string} witness - Witness account.

• required bool approve = 3

  @param {bool} approve - To vote for the witness, the approve = true. To remove the vote, the approve = false.

Used in: account_create, account_create_with_delegation, account_created, author_reward, claim_account, claim_reward_balance, clear_null_account_balance, collateralized_convert, collateralized_convert_immediate_conversion, comment_benefactor_reward, comment_options, comment_reward, consolidate_treasury_balance, convert, create_proposal, curation_reward, delegate_vesting_shares, dhf_conversion, dhf_funding, effective_comment_vote, escrow_approved, escrow_rejected, escrow_release, escrow_transfer, failed_recurrent_transfer, fill_collateralized_convert_request, fill_convert_request, fill_order, fill_recurrent_transfer, fill_transfer_from_savings, fill_vesting_withdraw, hardfork_hive, hardfork_hive_restore, interest, legacy_chain_properties, limit_order_cancelled, limit_order_create, limit_order_create2, liquidity_reward, pow_reward, price, producer_reward, proposal_fee, proposal_pay, recurrent_transfer, return_vesting_delegation, transfer, transfer_from_savings, transfer_to_savings, transfer_to_vesting, transfer_to_vesting_completed, update_proposal, vesting_shares_split, withdraw_vesting, witness_update

• required string amount = 1

• required uint32 precision = 2

• required string nai = 3

Related to comment_operation. Generated during block processing after cashout time passes and comment is eligible for rewards (nonzero reward). Note: the reward is the author portion of comment reward lowered by the rewards distributed towards beneficiaries (therefore it can be zero). @see comment_benefactor_reward_operation

Used in: operation

• required string author = 1

  @param {string} author - author of the comment (receiver of hbd_payout, hive_payout, vesting_payout)

• required string permlink = 2

  @param {string} permlink - permlink of the comment

• required asset hbd_payout = 3

  @param {asset} hbd_payout - (HBD) part of reward

• required asset hive_payout = 4

  @param {asset} hive_payout - (HIVE) part of reward

• required asset vesting_payout = 5

  @param {asset} vesting_payout - (VESTS) part of reward

• required asset curators_vesting_payout = 6

  @param {asset} curators_vesting_payout - (VESTS) curators' portion of comment reward (@see curation_reward_operation)

• required bool payout_must_be_claimed = 7

  @param {bool} payout_must_be_claimed - true if payouts require use of claim_reward_balance_operation

Used in: account_create, account_create_with_delegation, account_update, account_update2, create_claimed_account, recover_account, request_account_recovery

• required uint32 weight_threshold = 1

• map<string, uint32> account_auths = 2

• map<string, uint32> key_auths = 3

Used in: comment_payout_beneficiaries

• required string account = 1

• required uint32 weight = 2

• required string previous = 1

• required string timestamp = 2

• required string witness = 3

• required string transaction_merkle_root = 4

• repeated block_header_extensions extensions = 5

• required string witness_signature = 6

• repeated transaction transactions = 7

• required string block_id = 8

• required string signing_key = 9

• repeated string transaction_ids = 10

Used in: block

• oneof extension

  • void_t void_t = 1

  • string version = 2

  • hardfork_version_vote hardfork_version_vote = 3

Funds withdrawals from the savings can be canceled at any time before it is executed. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/34_cancel_transfer_from_savings.md?ref_type=heads

Used in: operation

• required string from_account = 1

  @param {string} from_account

• required uint32 request_id = 2

  @param {number} request_id

The operation change_recovery_account_operation allows a user to update their recovery account. It is important to keep it actual, because only a recovery account may create a request account recovery in case of compromised the owner authority. By default the recovery account is set to the account creator or it is empty if it was created by temp account or mined. In order to cancel the change_recovery_account_operation, the operation change_recovery_account_operation, the operation should be created with {new_recovery_account} set to the old one. The operation is done with a 30 days (HIVE_OWNER_AUTH_RECOVERY_PERIOD) delay. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/26_change_recovery_account.md?ref_type=heads

Used in: operation

• required string account_to_recover = 1

  @param {string} account_to_recover

• required string new_recovery_account = 2

  @param {string} new_recovery_account

• repeated future_extensions extensions = 3

  @param {future_extensions} extensions

Related to change_recovery_account_operation. Generated during block processing after wait period for the recovery account change has passed and the change became active.

Used in: operation

• required string account = 1

  @param {string} account - used that requested recovery accout change

• required string old_recovery_account = 2

  @param {string} old_recovery_account - previous recovery account

• required string new_recovery_account = 3

  @param {string} new_recovery_account - new recovery account

A user may create a new account using a pair of operations: claim_account_operation and create_claimed_account_operation. After the operation claim_account_operation a user receives a token: pending claimed accounts and later (using operation create_claimed_account_operation) a user may create a new account. After executing the operation claim_account_operation, a new account is not created. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/22_claim_account.md?ref_type=heads

Used in: operation

• required string creator = 1

  @param {string} creator - Account name.

• required asset fee = 2

  @param {asset} fee - The amount of fee for creating a new account is decided by the witnesses. It may be paid in HIVE or in the Recourse Credit (RC). If a user wants to pay a fee in RC, it should be set {fee= 0}.

• repeated future_extensions extensions = 3

  @param {future_extensions} extensions - Not currently used.

An operation claim_reward_balance_operation is used to transfer previously collected author and/or curation rewards from sub balance for the reward to regular balances. Rewards expressed in Hive and HBD are transferred to liquid balances, rewards in HP increase vesting balance. When claimed, HP rewards are immediately active towards governance voting power (compare with transfer_to_vesting_operation). Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/39_claim_reward_balance.md?ref_type=heads

Used in: operation

• required string account = 1

  @param {string} account - Account name.

• required asset reward_hive = 2

  @param {asset} reward_hive - The amount of Hive reward to be transferred to liquid balance.

• required asset reward_hbd = 3

  @param {asset} reward_hbd - The amount of HBD reward to be transferred to liquid balance

• required asset reward_vests = 4

  @param {asset} reward_vests - The amount of HP reward to be transferred to vesting balance.

Related to block processing. Generated during block processing potentially every block, but only if nonzero assets were burned. Triggered by removal of all assets from 'null' account balances.

Used in: operation

• repeated asset total_cleared = 1

  @param {asset} total_cleared - (HIVE, VESTS or HBD) nonzero assets burned on 'null' account

Similar to convert_operation, this operation instructs the blockchain to convert HIVE to HBD. The operation is performed after 3.5 days, but the owner gets HBD immediately. The price risk is cushioned by extra HIVE (HIVE_COLLATERAL_RATIO = 200 % ). After actual conversion takes place the excess HIVE is returned to the owner. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/48_collateralized_convert.md?ref_type=heads

Used in: operation

• required string owner = 1

  @param {string} owner - Account name.

• required uint32 requestid = 2

  @param {number} requestid - The number is given by a user. Should be unique for a user.

• required asset amount = 3

  @param {asset} amount - Amount > 0, have to be in Hive.

Related to collateralized_convert_operation. Generated every time above operation is executed. Contains amount of HBD received right when the transfer actually happens. @see fill_collateralized_convert_request

Used in: operation

• required string owner = 1

  @param {string} owner - user that requested conversion (receiver of hbd_out)

• required uint32 requestid = 2

  @param {number} requested - id of the conversion request

• required asset hbd_out = 3

  @param {asset} hbd_out - (HBD) funds after conversion

Using comment operation a user may create a post or a comment. From the blockchain point of view, it is the same operation – always comment. If a comment has no parent, it is a post. The parent of the comment may be a post or a comment. Users may comment their own comments. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/01_comment.md?ref_type=heads

Used in: operation

• required string parent_author = 1

  @param {string} parent_author - Account name, the author of the commented post or comment. If the operation creates a post, it is empty. It cannot be modified.

• required string parent_permlink = 2

  @param {string} parent_permlink - The identifier of the commented post or comment. When a user creates a post, it may contain the identifier of the community (e.g. hive-174695) or main tag (e.g. travel). It cannot be modified.

• required string author = 3

  @param {string} author - Account name, the author of the post or the comment. It cannot be modified.

• required string permlink = 4

  @param {string} permlink - Unique to the author, the identifier of the post or comment. It cannot be modified.

• required string title = 5

  @param {string} title - The title of the submitted post, in case of the comment, is often empty. It may be modified.

• required string body = 6

  @param {string} body - The content of the post or the comment. It may be modified.

• required string json_metadata = 7

  @param {string} json_metadata - There is no blockchain validation on json_metadata, but the structure has been established by the community. From the blockchain point of view it is a json file. For the second layer, the following keys may be used: - app, e.g. peakd/2023.2.3 - format, e.g. markdown - tags, e.g. photography - users - images

Related to comment_operation and comment_options_operation. Generated during block processing after cashout time passes and comment is eligible for rewards (nonzero reward). Note: the reward is a fragment of the author portion of comment reward depending on share assigned to benefactor in comment options (can be zero due to rounding). @see author_reward

Used in: operation

• required string benefactor = 1

  @param {string} benefactor - user assigned to receive share of author reward (receiver of payouts)

• required string author = 2

  @param {string} author - author of the comment

• required string permlink = 3

  @param {string} permlink - permlink of the comment

• required asset hbd_payout = 4

  @param {asset} hbd_payout - (HBD) part of reward

• required asset hive_payout = 5

  @param {asset} hive_payout - (HIVE) part of reward

• required asset vesting_payout = 6

  @param {asset} vesting_payout - (VESTS) part of reward

• required bool payout_must_be_claimed = 7

  @param {bool} payout_must_be_claimed - true if payouts require use of claim_reward_balance_operation

The operation comment_options_operation allows to set properties regarding payouts, rewards or beneficiaries (using {extensions}) for comments. If the operation: comment_options_operation is done by one of the frontends, it is usually in the same transaction with the operation: comment_operation. If a comment has received any votes, only the parameter {percent_hbd} may be changed. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/19_comment_options.md?ref_type=heads

Used in: operation

• required string author = 1

  @param {string} author - Account name, the author of the comment.

• required string permlink = 2

• required asset max_accepted_payout = 3

  @param {asset} max_accepted_payout - The maximum value of payout in HBD. Default value: max_accepted_payout = asset( 1000000000, HBD_SYMBOL ). The allowed value should be less than the default value. If max_accepted_payout = 0, then voters and authors will not receive the payout.

• required uint32 percent_hbd = 4

  @param {number} percent_hbd - By default the author reward is paid 50% HP and 50 % HBD. In some rare situations, instead of HBD, the Hive may be paid. percent_hbd = HIVE_100_PERCENT means that 100 % of HBD part is paid in HBD. A user may decide how many percent of HBD (from 50 %) they wants to receive in the HBD, the rest will be paid out in HP. Default value: percent_hbd = HIVE_100_PERCENT. The allowed value should be less than the default value. This is the only parameter that can be modified after the comment receives any vote.

• required bool allow_votes = 5

  @param {bool} allow_votes - The flag that allows to decide whether the comment may receive a vote. Default value: allow_votes = true.

• required bool allow_curation_rewards = 6

  @param {bool} allow_curation_rewards - The flag that allows to decide whether the voters for the comment should receive the curation rewards. Rewards return to the reward fund. Default value: allow_curation_rewards = true.

• repeated comment_options_extension extensions = 7

  @param {comment_options_extension} extensions - It may contain the list of the beneficiaries, the accounts that should receive the author reward. The list consists of the account name and the weight of the shares in the author reward. If the sum of the weights is less than 100%, the rest of the reward is received by the author. It should be defined less than 128 accounts. The allowed range of the weight is from 0 to 10000 (0 – 100%). The beneficiaries should be listed in alphabetical order, no duplicates.

Used in: comment_options

• oneof extension

  • comment_payout_beneficiaries comment_payout_beneficiaries = 1

Used in: comment_options_extension

• repeated beneficiary_route_type beneficiaries = 1

Related to comment_operation. Generated during block processing after cashout time passes even if there are no rewards. Note: prior to HF17 comment could have multiple cashout windows.

Used in: operation

• required string author = 1

  @param {string} author - author of comment

• required string permlink = 2

  @param {string} permlink - permlink of comment

Related to comment_operation. Generated during block processing after cashout time passes and comment is eligible for rewards (nonzero reward). Note: for informational purposes only, shows summary of comment reward, does not indicate any transfers. @see curation_reward_operation @see comment_benefactor_reward_operation @see author_reward_operation

Used in: operation

• required string author = 1

  @param {string} author - author of the comment

• required string permlink = 2

  @param {string} permlink - permlink of the comment

• required asset payout = 3

  @param {asset} payout - (HBD) total value of comment reward recalculated to HBD

• required int64 author_rewards = 4

  @param {number} author_rewards - (HIVE satoshi) raw author reward (@see author_reward_operation) [is it needed?]

• required asset total_payout_value = 5

  @param {asset} total_payout_value - (HBD) overall author reward (from multiple cashouts prior to HF17) recalculated to HBD [is it needed?]

• required asset curator_payout_value = 6

  @param {asset} curator_payout_value - (HBD) overall curation reward (from multiple cashouts prior to HF17) recalculated to HBD [is it needed?]

• required asset beneficiary_payout_value = 7

  @param {asset} beneficiary_payout_value - (HBD) overall beneficiary reward (from multiple cashouts prior to HF17) recalculated to HBD [is it needed?]

Related to block processing. Generated during block processing potentially every block, but only if there is nonzero transfer. Transfer occurs if there are assets on OBSOLETE_TREASURY_ACCOUNT ('steem.dao'). They are consolidated from all balances (per asset type) and moved to NEW_HIVE_TREASURY_ACCOUNT ('hive.fund').

Used in: operation

• repeated asset total_moved = 1

  @param {asset} total_moved - (HIVE, VESTS or HBD) funds moved from old to new treasury

This operation instructs the blockchain to start a conversion of HBD to Hive. The funds are deposited after 3.5 days. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/08_convert.md?ref_type=heads

Used in: operation

• required string owner = 1

  @param {string} owner - Account name.

• required uint32 requestid = 2

  @param {number} requestid - The number is given by a user. Should be unique for a user.

• required asset amount = 3

  @param {asset} amount - Amount > 0, have to be in HBD.

The operation create_claimed_account_operation may be used by the user who has the token. Pending claimed accounts (see claim_account_operation). After executing the operation create_claimed_account_operation, a new account is created. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/23_create_claimed_account.md?ref_type=heads

Used in: operation

• required string creator = 1

  @param {string} creator - An account who create a new account.

• required string new_account_name = 2

  @param {string} new_account_name - Account name. Valid account name may consist of many parts separated by a dot, total may have up to 16 characters, parts have to start from a letter, may be followed by numbers, or “-“.

• required authority owner = 3

  @param {authority} owner

• required authority active = 4

  @param {authority} active

• required authority posting = 5

  @param {authority} posting

• required string memo_key = 6

  @param {string} memo_key

• required string json_metadata = 7

  @param {string} json_metadata - Json string.

• repeated future_extensions extensions = 8

  @param {future_extensions} extensions - Not currently used.

There is a Decentralized Hive Fund (DHF) on the Hive. Users may submit proposals for funding and if the proposal receives enough votes, it will be funded. In order to create a proposal user should create a post first and then marked it as a proposal with the operation create_proposal_operation. User defines when the proposal starts and ends and how many funds need to realize it. The creating proposal costs 10 HBD and additionally 1 HBD for each day over 60 days. The fee goes back to DHF. Every hour all active proposals are processed and taking into consideration a current number of votes payments are done. Accounts can create/remove votes anytime. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/44_create_proposal.md?ref_type=heads

Used in: operation

• required string creator = 1

  @param {string} creator

• required string receiver = 2

  @param {string} receiver

• required string start_date = 3

  @param {string} start_date

• required string end_date = 4

  @param {asset} end_date

• required asset daily_pay = 5

  @param {asset} daily_pay

• required string subject = 6

  @param {string} subject

• required string permlink = 7

  @param {string} permlink

• repeated future_extensions extensions = 8

  @param {future_extensions} extensions

Related to comment_operation and comment_vote_operation. Generated during block processing after cashout time passes and comment is eligible for rewards (nonzero reward). Note: the reward is a fragment of curators' portion of comment reward depending on share of particular curator in overall curation power for the comment. Only generated when nonzero.

Used in: operation

• required string curator = 1

  @param {string} curator - user that curated the comment (receiver of reward)

• required asset reward = 2

  @param {asset} reward - (VESTS) curation reward

• required string author = 3

  @param {string} author - author of curated comment

• required string permlink = 4

  @param {string} permlink - permlink of curated comment

• required bool payout_must_be_claimed = 5

  @param {bool} payout_must_be_claimed - true if payouts require use of claim_reward_balance_operation

There are the following custom operations: custom_operation, custom_json_operation and custom_binary (currently is disabled). The operation: custom_operation provides a generic way to add higher level protocols on top of witness consensus operations. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/15_custom.md?ref_type=heads

Used in: operation

• repeated string required_auths = 1

  @param {string} required_auths

• required uint32 id = 2

  @param {number} id

• required string data = 3

  @param {string} data

The operation custom_json_operation works similar as custom_operation, but it is designed to be human readable/developer friendly. The custom_json_operation is larger than custom_operation or custom_binary, that is why it costs more RC. It should be signed as required in { required_auths } or { required_posting_auths }. The examples of custom_json_operation: - reblog - muted - pinned - follow Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/18_custom_json.md?ref_type=heads

Used in: operation

• repeated string required_auths = 1

  @param {string} required_auths

• repeated string required_posting_auths = 2

  @param {string} required_posting_auths

• required string id = 3

  @param {string} id - Must be less than 32 characters long.

• required string json = 4

  @param {string} json - Must be a proper utf8 JSON string.

Using the operation decline_voting_rights_operation, a user may decide to decline their voting rights – for content, witnesses and proposals. Additionally, a user cannot set a proxy (operation account_witness_proxy_operation). The operation is done with a HIVE_OWNER_AUTH_RECOVERY_PERIOD day delay. After HIVE_OWNER_AUTH_RECOVERY_PERIOD days it is irreversible. During HIVE_OWNER_AUTH_RECOVERY_PERIOD days after creation, the operation may be canceled using the operation declive_voting_rights_operation with {decline = false}. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/36_decline_voting_rights.md?ref_type=heads

Used in: operation

• required string account = 1

  @param {string} account - Account name.

• required bool decline = 2

  @param {bool} decline

It's related to `decline_voting_rights_operation` and generated after `HIVE_OWNER_AUTH_RECOVERY_PERIOD` interval. Then some actions are done and after that `declined_voting_rights_operation` is created.

Used in: operation

• required string account = 1

  @param {string} account - user who decided to decline his voting rights

Related to transfer_to_vesting_operation. Generated during block processing every time part of fairly fresh VESTS becomes active part of governance vote for the account. Note: after account receives new VESTS there is a grace period before those VESTS are accounted for when it comes to governance vote power. This vop is generated at the end of that period.

Used in: operation

• required string voter = 1

  @param {string} voter - account with fairly fresh VESTS

• required uint64 votes = 2

  @param {number} votes - (VESTS satoshi) new governance vote power that just activated for voter

The operation delegate_vesting_shares_operation allows to delegate an amount of { vesting_shares } to an { delegatee } account. The { vesting_shares } are still owned by { delegator }, but the voting rights and resource credit are transferred. A user may not delegate: - the vesting shares that are already delegated - the delegated vesting shares to him (a user does not own them) - the vesting shares in the Power down process - the already used voting shares for voting or downvoting In order to remove the vesting shares delegation, the operation delegate_vesting_shares_operation should be created with {vesting_shares = 0}. When a delegation is removed, the delegated vesting shares are frozen for five days (HIVE_DELEGATION_RETURN_PERIOD_HF20) to prevent voting twice. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/40_delegate_vesting_shares.md?ref_type=heads

Used in: operation

• required string delegator = 1

  @param {string} delegator - The account delegating vesting shares.

• required string delegatee = 2

  @param {string} delegatee - The account receiving vesting shares.

• required asset vesting_shares = 3

  @param {asset} vesting_shares - The amount of vesting shares to be delegated. Minimal amount = 1/3 of the fee for creating a new account.

The post or comment may be deleted by the author. If the post or comment is deleted, the {permlink} may be reused. The delete doesn’t mean that the comment is removed from the blockchain. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/17_delete_comment.md?ref_type=heads

Used in: operation

• required string author = 1

  @param {string} author - Account name, the author of the post or the comment.

• required string permlink = 2

  @param {string} permlink - The identifier of the post or the comment.

Related to specific case of transfer_operation and to block processing. When user transferred HIVE to treasury the amount is immediately converted to HBD and this vops is generated. Also generated during block processing every day during daily proposal maintenance. Note: portion of HIVE on treasury balance is converted to HBD and thus increases funds available for proposals.

Used in: operation

• required string treasury = 1

  @param {string} treasury - treasury (source of hive_amount_in and receiver of hbd_amount_out)

• required asset hive_amount_in = 2

  @param {asset} hive_amount_in - (HIVE) source of conversion

• required asset hbd_amount_out = 3

  @param {asset} hbd_amount_out - (HBD) effect of conversion

Related to block processing. Generated during block processing every proposal maintenance period. Note: while the fund receives part of inflation every block, the amount is recorded aside and only when there are proposal payouts (when new funds matter), there is generation of this vop.

Used in: operation

• required string treasury = 1

  @param {string} treasury - treasury account (receiver of additional_funds)

• required asset additional_funds = 2

  @param {asset} additional_funds - (HBD) portion inflation accumulated since previous maintenance period

Related to vote_operation. Generated every time vote is cast for the first time or edited, but only as long as it is effective, that is, the target comment was not yet cashed out.

Used in: operation

• required string voter = 1

  @param {string} voter - account that casts a vote

• required string author = 2

  @param {string} author - author of comment voted on

• required string permlink = 3

  @param {string} permlink - permlink of comment voted on

• required uint64 weight = 4

  @param {number} weight - weight of vote depending on when vote was cast and with what power

• required int64 rshares = 5

  @param {number} rshares - power of the vote

• required uint64 total_vote_weight = 6

  @param {number} total_vote_weight - sum of all vote weights on the target comment in the moment of casting current vote

• required asset pending_payout = 7

  @param {asset} pending_payout - (HBD) estimated reward on target comment; supplemented by AH RocksDB plugin

Used in: pow2_work

• required pow2_input input = 1

• required equihash_proof proof = 2

• required string prev_block = 3

• required uint32 pow_summary = 4

Used in: equihash_pow

• required uint32 n = 1

• required uint32 k = 2

• required string seed = 3

• repeated uint32 inputs = 4

The operation escrow_approve_operation is used to approve the escrow. The approval should be done by { to } and by the { agent }. The escrow approval is irreversible. If { agent } or { to } haven’t approved the escrow before the { ratification_deadline} or either of them explicitly rejected the escrow, the escrow is rejected. If {agent} and {to} have approved the escrow, the {fee} is transferred from temporary balance to {agent} account. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/31_escrow_approve.md?ref_type=heads

Used in: operation

• required string from_account = 1

  @param {string} from_account - Account name.

• required string to_account = 2

  @param {string} to_account - Account name.

• required string agent = 3

  @param {string} agent - Account name.

• required string who = 4

  @param {string} who - Account name. Either {to} or {agent}.

• required uint32 escrow_id = 5

  @param {number} escrow_id - Escrow identifier.

• required bool approve = 6

  @param {bool} approve - approve = true; (approve = false explicitly rejects the escrow)

Related to escrow_approve_operation. Generated when both agent and to accounts approved pending escrow transfer (agent receives fee). @see escrow_rejected

Used in: operation

• required string from_account = 1

  @param {string} from_account - user that initiated escrow transfer

• required string to_account = 2

  @param {string} to_account - user that is target of pending escrow transfer

• required string agent = 3

  @param {string} agent - user that is an agent of pending escrow transfer (receiver of fee)

• required uint32 escrow_id = 4

  @param {number} escrow_id - id of escrow transfer

• required asset fee = 5

  @param {asset} fee - (HIVE of HBD) fee paid to agent

The operation escrow_dispute_operation is used to raise the dispute. It may be used by { from } or { to } accounts. If there is a dispute, only {agent} may release the funds. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/28_escrow_dispute.md?ref_type=heads

Used in: operation

• required string from_account = 1

  @param {string} from_account - Account name.

• required string to_account = 2

  @param {string} to_account - Account name.

• required string agent = 3

  @param {string} agent - Account name.

• required string who = 4

  @param {string} who - Account name. Either {to} or {agent}.

• required uint32 escrow_id = 5

  @param {number} escrow_id - Escrow identifier.

Related to escrow_approve_operation and escrow_transfer_operation. Generated when pending escrow transfer is cancelled and user that initiated it receives all the funds back. It can happen with explicit rejection with use of first operation. Can also happen during block processing when either agent or to account failed to approve before ratification deadline. @see escrow_approved

Used in: operation

• required string from_account = 1

  @param {string} from_account - user that initiated escrow transfer (receiver of all the funds)

• required string to_account = 2

  @param {string} to_account - user that was target of cancelled escrow transfer

• required string agent = 3

  @param {string} agent - user that was designated as agent of cancelled escrow transfer

• required uint32 escrow_id = 4

  @param {number} escrow_id - id of cancelled escrow transfer

• required asset hbd_amount = 5

  @param {asset} hbd_amount - (HBD) funds from cancelled escrow transfer (same amount as in escrow_transfer_operation)

• required asset hive_amount = 6

  @param {asset} hive_amount - (HIVE) funds from cancelled escrow transfer (same amount as in escrow_transfer_operation)

• required asset fee = 7

  @param {asset} fee - (HIVE of HBD) fee from cancelled escrow transfer (same amount as in escrow_transfer_operation)

The operation is used to release the funds of the escrow. The escrow may be released by { from }, { to } or { agent } – depending on the following conditions: If there is no dispute and escrow has not expired, either party can release funds to the other. If escrow expires and there is no dispute, either party can release funds to either party. If there is a dispute regardless of expiration, the agent can release funds to either party following whichever agreement was in place between the parties. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/29_escrow_release.md?ref_type=heads

Used in: operation

• required string from_account = 1

  @param {string} from_account - Account name.

• required string to_account = 2

  @param {string} to_account - Account name.

• required string agent = 3

  @param {string} agent - Account name.

• required string who = 4

  @param {string} who - The account that is attempting to release the funds.

• required string receiver = 5

  @param {string} receiver - The account that should receive funds (might be {from}, might be {to}).

• required uint32 escrow_id = 6

  @param {number} escrow_id - Escrow indicator.

• required asset hbd_amount = 7

  @param {asset} hbd_amount - The amount of HBD to release.

• required asset hive_amount = 8

  @param {asset} hive_amount - The amount of HIVE to release.

The escrow allows the account { from_account } to send money to an account { to_account } only if the agreed terms will be fulfilled. In case of dispute { agent } may divide the funds between { from } and { to }. The escrow lasts up to { escrow_expiration }. When the escrow is created, the funds are transferred {from} to a temporary account. The funds are on the temporary balance, till the operation escrow_release_operation is created. To create an valid escrow: 1. Sender { from } creates the escrow using the operation: escrow_transfer_operation indicated { to } and { agent }. 2. The { agent } and { to } have up to { ratification_deadline } for approving the escrow using operation: escrow_approve_operation. If there is a dispute, the operation: escrow_dispute_operation should be used. In case of the escrow releases, the operation: escrow_release_operation should be used. Descritpion https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/27_escrow_transfer.md?ref_type=heads

Used in: operation

• required string from_account = 1

  @param {string} from_account - Account name.

• required string to_account = 2

  @param {string} to_account - Account name.

• required string agent = 3

  @param {string} agent - Account name.

• required uint32 escrow_id = 4

  @param {number} escrow_id - It is defined by the sender. It should be unique for { from }.

• required asset hbd_amount = 5

  @param {asset} hbd_amount - Escrow amount.

• required asset hive_amount = 6

  @param {asset} hive_amount - Escrow amount.

• required asset fee = 7

  @param {asset} fee - The fee amount depends on the agent. The fee is paid to the agent when approved.

• required string ratification_deadline = 8

  @param {string} ratification_deadline - Time for approval for { to } and { agent }. If the escrow is not approved till { ratification_deadline }, it will be rejected and all funds returned to { from }.

• required string escrow_expiration = 9

  @param {string} escrow_expiration - See description of escrow_release_operation.

• required string json_meta = 10

  @param {string} json_meta - json string.

Related to governance voting: account_witness_vote_operation, account_witness_proxy_operation and update_proposal_votes_operation. Generated during block processing when user did not cast any governance vote for very long time. Such user is considered not interested in governance and therefore his previous votes are nullified.

Used in: operation

• required string account = 1

  @param {string} account - user whose governance votes were nullified

Related to recurrent_transfer_operation. Generated during block processing instead of fill_recurrent_transfer_operation when there is not enought funds on from account. Note: failed transfers are not automatically repeated. Note: if too many consecutive transfers fail, whole recurrent transfer operation is discontinued. @see fill_recurrent_transfer

Used in: operation

• required string from_account = 1

  @param {string} from_account - user that initiated the transfer (source of amount that has not enough balance to cover it)

• required string to_account = 2

  @param {string} to_account - user that is target of transfer (would be receiver of amount, but no transfer actually happened)

• required asset amount = 3

  @param {asset} amount - (HIVE of HBD) amount that was scheduled for transferred in current iteration but failed

• required string memo = 4

  @param {string} memo - memo attached to the transfer

• required uint32 consecutive_failures = 5

  @param {number} consecutive_failures - number of failed iterations

• required uint32 remaining_executions = 6

  @param {number} remaining_executions - number of remaining pending transfers

• required bool deleted = 7

  @param {bool} deleted - true if whole recurrent transfer was discontinued due to too many consecutive failures

This is an operation for witnesses. The witnesses publish the exchange rate between Hive and HBD. Only the exchange rate published by the top 20 witnesses is used to define the exchange rate. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/07_feed_publish.md?ref_type=heads

Used in: operation

• required string publisher = 1

  @param {string} publisher - The witness.

• required price exchange_rate = 2

  @param {price} exchange_rate - How many HBD the 1 Hive should cost Example: "base":"0.345 HBD","quote":"1.000 HIVE"

Related to collateralized_convert_operation. Generated during block processing after conversion delay passes and HIVE is finally converted to HBD. Note: HBD is transferred immediately during execution of above operation, this vop is generated after actual price of conversion becomes known. @see collateralized_convert_immediate_conversion

Used in: operation

• required string owner = 1

  @param {string} owner - user that requested conversion (receiver of excess_collateral)

• required uint32 requestid = 2

  @param {number} requestid - id of the request

• required asset amount_in = 3

  @param {asset} amount_in - (HIVE) source of conversion (part of collateral)

• required asset amount_out = 4

  @param {asset} amount_out - (HBD) result of conversion (already transferred to owner when request was made)

• required asset excess_collateral = 5

  @param {asset} excess_collateral - (HIVE) unused part of collateral returned to owner

Related to convert_operation. Generated during block processing after conversion delay passes and HBD is converted to HIVE.

Used in: operation

• required string owner = 1

  @param {string} owner - User that requested conversion (receiver of amount_out).

• required uint32 requestid = 2

  @param {number} requestid - id of the request.

• required asset amount_in = 3

  @param {asset} amount_in - (HBD) source of conversion.

• required asset amount_out = 4

  @param {asset} amount_out - (HIVE) effect of conversion.

Related to limit_order_create_operation and limit_order_create2_operation. Generated during one of above operations when order on internal market is partially or fully matched (each match generates separate vop).

Used in: operation

• required string current_owner = 1

  @param {string} current_owner - user that recently created order (taker - receiver of open_pays)

• required uint32 current_orderid = 2

  @param {number} current_orderid - id of fresh order

• required asset current_pays = 3

  @param {asset} current_pays - (HIVE or HBD) amount paid to open_owner

• required string open_owner = 4

  @param {string} open_owner - user that had his order on the market (maker - receiver of current_pays)

• required uint32 open_orderid = 5

  @param {number} open_orderid - id of waiting order

• required asset open_pays = 6

  @param {asset} open_pays - (HBD or HIVE) amount paid to current_owner

Related to recurrent_transfer_operation. Generated during block processing starting in the block that included above operation and then after every period set in the operation until all transfers are executed, too many fail due to shortfall of funds or the transfer is cancelled. Note: in case of accumulation of very big amount of recurrent transfers to be executed in particular block, some are going to be postponed to next block(s) and so will be generation of this vop. @see failed_recurrent_transfer

Used in: operation

• required string from_account = 1

  @param {string} from_account - user that initiated the transfer (source of amount)

• required string to_account = 2

  @param {string} to_account - user that is target of transfer (receiver of amount)

• required asset amount = 3

  @param {asset} amount - (HIVE of HBD) amount transferred in current iteration

• required string memo = 4

  @param {string} memo - memo attached to the transfer

• required uint32 remaining_executions = 5

  @param {number} remaining_executions - number of remaining pending transferss

Related to transfer_from_savings_operation. Generated during block processing after savings withdraw time has passed and requested amount was transfered from savings to liquid balance.

Used in: operation

• required string from_account = 1

  @param {string} from_account - user that initiated transfer from savings

• required string to_account = 2

  @param {string} to_account - user that was specified to receive funds (receiver of amount)

• required asset amount = 3

  @param {asset} amount - (HIVE or HBD) funds transfered from savings

• required uint32 request_id = 4

  @param {number} request_id - id of transfer request

• required string memo = 5

  @param {string} memo - memo attached to transfer request

Related to withdraw_vesting_operation and set_withdraw_vesting_route_operation. Generated during block processing in batches for each active withdraw route (including implied from_account(VESTS)->from_account(HIVE)) each time vesting withdrawal period passes. Note: not generated for implied route when all funds were already distributed along explicit routes

Used in: operation

• required string from_account = 1

  @param {string} from_account - user that activated power down

• required string to_account = 2

  @param {string} to_account - target of vesting route (potentially the same as from_account - receiver of deposited)

• required asset withdrawn = 3

  @param {asset} withdraw - (VESTS) source amount

• required asset deposited = 4

  @param {asset} deposited - (HIVE or VESTS) [converted] target amount

Used in: account_create_with_delegation, account_update2, change_recovery_account, claim_account, create_claimed_account, create_proposal, recover_account, remove_proposal, request_account_recovery, transaction, update_proposal_votes, witness_set_properties

• oneof extension

  • void_t void_t = 1

Related to block processing. Generated during block processing every time new hardfork is activated. Many related vops can follow.

Used in: operation

• required uint32 hardfork_id = 1

  @param {number} hardfork_id - number of hardfork

Related to hardfork 23 (HIVE inception hardfork). Generated for every account that did not receive HIVE airdrop.

Used in: operation

• required string account = 1

  @param {string} account - account excluded from airdrop (source of amounts for airdrop)

• required string treasury = 2

  @param {string} treasury - treasury that received airdrop instead of account (receiver of funds)

• repeated string other_affected_accounts = 3

  @param {string} other_affected_accounts - delegatees that lost delegations from account - filled before pre notification

• required asset hbd_transferred = 4

  @param {asset} hbd_transferred - (HBD) part of airdrop to treasury (sourced from various HBD balances on account)

• required asset hive_transferred = 5

  @param {asset} hive_transferred - (HIVE) part of airdrop to treasury (sourced from various HIVE balances on account)

• required asset vests_converted = 6

  @param {asset} vests_converted - (VESTS) sum of all sources of VESTS on account

• required asset total_hive_from_vests = 7

  @param {asset} total_hive_from_vests - (HIVE) part of airdrop to treasury (sourced from conversion of vests_converted)

Related to hardfork 24. Generated for every account that was excluded from HF23 airdrop but won appeal. Note: the late airdrop did not apply properly since HIVE that the accounts should receive did not account for HIVE from converted VESTS. [how was it resolved?] @see hardfork_hive

Used in: operation

• required string account = 1

  @param {string} account - account to receive late airdrop (receiver of funds)

• required string treasury = 2

  @param {string} treasury - treasury, source of late airdrop

• required asset hbd_transferred = 3

  @param {asset} hbd_transferred - (HBD) part of airdrop (equals related hardfork_hive_operation.hbd_transferred)

• required asset hive_transferred = 4

  @param {asset} hive_transferred - (HIVE) part of airdrop (equals related hardfork_hive_operation.hive_transferred)

Used in: block_header_extensions

• required string hf_version = 1

• required string hf_time = 2

Related to delete_comment_operation. Generated when delete_comment_operation was executed but ignored. Note: prior to HF19 it was possible to execute delete on comment that had net positive votes. Such operation was ignored. This is the moment this vop is generated.

Used in: operation

• required string author = 1

  @param {string} author - author of attempted-delete comment

• required string permlink = 2

  @param {string} permlink - permlink of attempted-delete comment

Related to any operation that modifies HBD liquid or savings balance (including block processing). Generated when operation modified HBD balance and account received interest payment. Interest is stored in related balance (liquid when liquid was modified, savings when savings was modified). Note: since HF25 interest is not calculated nor paid on liquid balance.

Used in: operation

• required string owner = 1

  @param {string} owner - user that had his HBD balance modified (receiver of interest)

• required asset interest = 2

  @param {asset} interest - (HBD) amount of interest paid

• required bool is_saved_into_hbd_balance = 3

  @param {bool} is_saved_into_hbd_balance - true when liquid balance was modified (not happening after HF25)

Witnesses must vote on how to set certain chain properties to ensure a smooth and well functioning network. Any time owner is in the active set of witnesses these properties will be used to control the blockchain configuration.

Used in: pow, pow2, witness_update

• required asset account_creation_fee = 1

  @param {asset} account_creation_fee - This fee, paid in HIVE, is converted into VESTS for the new account. Accounts without vesting shares cannot earn usage rations and therefore are powerless. This minimum fee requires all accounts to have some kind of commitment to the network that includes the ability to vote and make transactions.

• required uint32 maximum_block_size = 2

  @param {number} maximum_block_size - This witnesses vote for the maximum_block_size which is used by the network to tune rate limiting and capacity.

• required uint32 hbd_interest_rate = 3

  @param {number} hbd_interest_rate

Cancels an order (limit_order_create_operation or limit_order_create2_operation) and returns the balance to the owner. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/06_limit_order_cancel.md?ref_type=heads

Used in: operation

• required string owner = 1

  @param {string} owner

• required uint32 orderid = 2

  @param {number} orderid - The request_id provided by a user during creating a limit_order_create_operation or limit_order_create2_operation.

Related to limit_order_cancel_operation, limit_order_create_operation or limit_order_create2_operation. Generated every time existing limit order is cancelled. It happens on explicit call (first operation), or in rare case of filling limit order (second or third operation) when, after filling most of it, remaining funds are too small (would round to zero when sold). Finally also generated during block processing for orders that reached expiration time without being filled. @see fill_order

Used in: operation

• required string seller = 1

  @param {string} seller - user that placed an order (receiver of amount_back)

• required uint32 orderid = 2

  @param {number} orderid - id of the order

• required asset amount_back = 3

  @param {asset} amount_back - (HIVE or HBD) remaining funds from original order that were not traded until cancellation

This operation creates a limit order and matches it against existing open orders. It allows to sell Hive and buy HBD or sell HBD and buy Hive. It is a way for a user to declare they want to sell {amount_to_sell} Hive/HBD for at least {min_to_receive} HBD/Hive. The user may be a taker (if a user creates an order and the order matches some order(s)) or a maker (if a user creates an order and the order doesn’t match and the order is waiting for a match on the market). If there is a partial match, a user may be a taker and maker for the same order. If a taker creates an order for all orders on the market the order(s) that are the best deal for the taker are matched. If there are two orders with the same price, the older one is matched. The operation is used by the markets see: https://wallet.hive.blog/market Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/05_limit_order_create.md?ref_type=heads

Used in: operation

• required string owner = 1

  @param {string} owner

• required uint32 orderid = 2

  @param {number} orderid - an ID assigned by owner, must be unique.

• required asset amount_to_sell = 3

  @param {asset} amount_to_sell

• required asset min_to_receive = 4

  @param {asset} min_to_receive

• required bool fill_or_kill = 5

  @param {bool} fill_or_kill - If fill_or_kill = true, then the operation is executed immediately or it fails (the operation is not added to the block). If fill_or_kill = false, then the order is valid till 'expiration'.

• required string expiration = 6

  @param {string} expiration

This operation creates a limit order and matches it against existing open orders. It is similar to limit_order_create except it serializes the price rather than calculating it from other fields. It allows to sell Hive and buy HBD or sell HBD and buy Hive. It is a way for a user to declare they wants to sell {amount_to_sell} Hive/HBD for at least {exchange_rate} per HBD/Hive. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/21_limit_order_create2.md?ref_type=heads

Used in: operation

• required string owner = 1

  @param {string} owner

• required uint32 orderid = 2

  @param {number} orderid - an ID assigned by owner, must be unique.

• required asset amount_to_sell = 3

  @param {asset} amount_to_sell

• required bool fill_or_kill = 4

  @param {bool} fill_or_kill - If fill_or_kill = true, then the operation is executed immediately or it fails (the operation is not added to the block). If fill_or_kill = false, then the order is valid till {expiration}.

• required price exchange_rate = 5

  @param {price} exchange_rate

• required string expiration = 6

  @param {string} expiration

Related to limit_order_create_operation and limit_order_create2_operation. Generated during block processing to indicate reward paid to the market makers on internal HIVE<->HBD market. No longer active after HF12. @see fill_order_operation

Used in: operation

• required string owner = 1

  @param {string} owner - market maker (receiver of payout)

• required asset payout = 2

  @param {asset} payout - (HIVE) reward for provided liquidity

NOTE: do not change the order of any operations prior to the virtual operations or it will trigger a hardfork.

Used in: transaction

• oneof value

  • vote vote = 1

  • comment comment = 2

  • transfer transfer = 3

  • transfer_to_vesting transfer_to_vesting = 4

  • withdraw_vesting withdraw_vesting = 5

  • limit_order_create limit_order_create = 6

  • limit_order_cancel limit_order_cancel = 7

  • feed_publish feed_publish = 8

  • convert convert = 9

  • account_create account_create = 10

  • account_update account_update = 11

  • witness_update witness_update = 12

  • account_witness_vote account_witness_vote = 13

  • account_witness_proxy account_witness_proxy = 14

  • pow pow = 15

  • custom custom = 16

  • witness_block_approve witness_block_approve = 17

  • delete_comment delete_comment = 18

  • custom_json custom_json = 19

  • comment_options comment_options = 20

  • set_withdraw_vesting_route set_withdraw_vesting_route = 21

  • limit_order_create2 limit_order_create2 = 22

  • claim_account claim_account = 23

  • create_claimed_account create_claimed_account = 24

  • request_account_recovery request_account_recovery = 25

  • recover_account recover_account = 26

  • change_recovery_account change_recovery_account = 27

  • escrow_transfer escrow_transfer = 28

  • escrow_dispute escrow_dispute = 29

  • escrow_release escrow_release = 30

  • pow2 pow2 = 31

  • escrow_approve escrow_approve = 32

  • transfer_to_savings transfer_to_savings = 33

  • transfer_from_savings transfer_from_savings = 34

  • cancel_transfer_from_savings cancel_transfer_from_savings = 35

  • decline_voting_rights decline_voting_rights = 37

  • claim_reward_balance claim_reward_balance = 40

  • delegate_vesting_shares delegate_vesting_shares = 41

  • account_create_with_delegation account_create_with_delegation = 42

  • witness_set_properties witness_set_properties = 43

  • account_update2 account_update2 = 44

  • create_proposal create_proposal = 45

  • update_proposal_votes update_proposal_votes = 46

  • remove_proposal remove_proposal = 47

  • update_proposal update_proposal = 48

  • collateralized_convert collateralized_convert = 49

  • recurrent_transfer recurrent_transfer = 50

  • fill_convert_request fill_convert_request = 100

    Virtual operations:

  • author_reward author_reward = 101

  • curation_reward curation_reward = 102

  • comment_reward comment_reward = 103

  • liquidity_reward liquidity_reward = 104

  • interest interest = 105

  • fill_vesting_withdraw fill_vesting_withdraw = 106

  • fill_order fill_order = 107

  • shutdown_witness shutdown_witness = 108

  • fill_transfer_from_savings fill_transfer_from_savings = 109

  • hardfork hardfork = 110

  • comment_payout_update comment_payout_update = 111

  • return_vesting_delegation return_vesting_delegation = 112

  • comment_benefactor_reward comment_benefactor_reward = 113

  • producer_reward producer_reward = 114

  • clear_null_account_balance clear_null_account_balance = 115

  • proposal_pay proposal_pay = 116

  • dhf_funding dhf_funding = 117

  • hardfork_hive hardfork_hive = 118

  • hardfork_hive_restore hardfork_hive_restore = 119

  • delayed_voting delayed_voting = 120

  • consolidate_treasury_balance consolidate_treasury_balance = 121

  • effective_comment_vote effective_comment_vote = 122

  • ineffective_delete_comment ineffective_delete_comment = 123

  • dhf_conversion dhf_conversion = 124

  • expired_account_notification expired_account_notification = 125

  • changed_recovery_account changed_recovery_account = 126

  • transfer_to_vesting_completed transfer_to_vesting_completed = 127

  • pow_reward pow_reward = 128

  • vesting_shares_split vesting_shares_split = 129

  • account_created account_created = 130

  • fill_collateralized_convert_request fill_collateralized_convert_request = 131

  • system_warning system_warning = 132

  • fill_recurrent_transfer fill_recurrent_transfer = 133

  • failed_recurrent_transfer failed_recurrent_transfer = 134

  • limit_order_cancelled limit_order_cancelled = 135

  • producer_missed producer_missed = 136

  • proposal_fee proposal_fee = 137

  • collateralized_convert_immediate_conversion collateralized_convert_immediate_conversion = 138

  • escrow_approved escrow_approved = 139

  • escrow_rejected escrow_rejected = 140

  • proxy_cleared proxy_cleared = 141

  • declined_voting_rights declined_voting_rights = 142

Used in: operation

• required string worker_account = 1

• required string block_id = 2

• required uint64 nonce = 3

• required pow_work work = 4

• required legacy_chain_properties props = 5

Used in: operation

• required pow2_work work = 1

• optional string new_owner_key = 2

• required legacy_chain_properties props = 3

Used in: equihash_pow, pow2_pow

• required string worker_account = 1

• required string prev_block = 2

• required uint64 nonce = 3

Used in: pow2_work

• required pow2_input input = 1

• required uint32 pow_summary = 2

Used in: pow2

• oneof value

  • pow2_pow pow2 = 1

  • equihash_pow equihash_pow = 2

Related to pow_operation and pow2_operation. Generated every time one of above operations is executed (up to HF16). Note: pow2_operation could be executed up to HF17 but mining rewards were stopped after HF16.

Used in: operation

• required string worker = 1

  @param {string} worker - (potentially new) witness that calculated PoW (receiver of reward)

• required asset reward = 2

  @param {asset} reward - (VESTS or HIVE) reward for work (HIVE only during first 30 days after genesis)

Used in: pow

• required string worker = 1

• required string input = 2

• required string signature = 3

• required string work = 4

Represents quotation of the relative value of asset against another asset. Similar to 'currency pair' used to determine value of currencies. For example: 1 EUR / 1.25 USD where: 1 EUR is an asset specified as a base 1.25 USD us an asset specified as a qute can determine value of EUR against USD.

Used in: feed_publish, limit_order_create2

• required asset base = 1

  @param {asset} base - Represents a value of the price object to be expressed relatively to quote asset. Cannot have amount == 0 if you want to build valid price.

• required asset quote = 2

  @param {asset} quote - represents an relative asset. Cannot have amount == 0, otherwise asertion fail.

Related to block processing. Generated during block processing when witness failed to produce his block on time. @see shutdown_witness

Used in: operation

• required string producer = 1

  @param {string} producer - witness that failed to produce his block on time

Related to block processing. Generated during block processing every block for current witness.

Used in: operation

• required string producer = 1

  @param {string} producer - witness (receiver of vesting_shares)

• required asset vesting_shares = 2

  @param {asset} vesting_shares - (VESTS or HIVE) reward for block production (HIVE only during first 30 days after genesis)

Related to create_proposal_operation. Generated every time above operation is executed. Supplements it with paid fee.

Used in: operation

• required string creator = 1

  @param {string} creator - user that created proposal (source of fee)

• required string treasury = 2

  @param {string} treasury - treasury account (receiver of fee)

• required uint32 proposal_id = 3

  @param {number} proposal_id - id of proposal

• required asset fee = 4

  @param {asset} fee - (HBD) amount paid for proposal [should actually be part of create_proposal_operation but it's too late now]

Related to create_proposal_operation. Generated during block processing during proposal maintenance in batches for each proposal that is chosen and receives funding.

Used in: operation

• required uint32 proposal_id = 1

  @param {number} proposal_id - id of chosen proposal

• required string receiver = 2

  @param {string} receiver - account designated to receive funding (receiver of payment)

• required string payer = 3

  @param {string} payer - treasury account, source of payment

• required asset payment = 4

  @param {asset} payment - (HBD) paid amount

There are 4 cases( 4 operations ) that can generate `proxy_cleared_operation` virtual operation: `account_witness_proxy_operation`: A vop `proxy_cleared_operation` is created in the same block. We want to set a proxy, but an old proxy exists: 1) {"type":"proxy_cleared_operation","value":{"account":"ACCOUNT","proxy":"OLD-PROXY-ACCOUNT-NAME"}} We don't want to set a proxy: 2) {"type":"proxy_cleared_operation","value":{"account":"ACCOUNT","proxy":"OLD-PROXY-ACCOUNT-NAME"}} `decline_voting_rights_operation`: A vop `proxy_cleared_operation` is generated automatically after `HIVE_OWNER_AUTH_RECOVERY_PERIOD` time ( 30 days ). 3) {"type":"proxy_cleared_operation","value":{"account":"ACCOUNT","proxy":"OLD-PROXY-ACCOUNT-NAME"}} `update_proposal_votes_operation`, `account_witness_proxy_operation`, `account_witness_vote_operation`: After HF25 a vop `proxy_cleared_operation` is generated automatically after `HIVE_GOVERNANCE_VOTE_EXPIRATION_PERIOD` time ( 365 days ). 4) {"type":"proxy_cleared_operation","value":{"account":"ACCOUNT","proxy":"OLD-PROXY-ACCOUNT-NAME"}}

Used in: operation

• required string account = 1

  @param {string} account - user that sets/unsets a proxy

• required string proxy = 2

  @param {string} proxy - proxy user that facilitates voting on witnesses

This operation is part of the recovery account process (more information in request_account_recovery). After creating by recovery account the operation request_account_recovery, the user has HIVE_ACCOUNT_RECOVERY_REQUEST_EXPIRATION_PERIOD hours to respond using operation recover_account_operation and set a new owner authority. The operation recover_account_operation has to be signed using the two owner authorities, the old one (maybe compromised) and the new one (see request_account_recovery). There must be at least 60 minutes (HIVE_OWNER_UPDATE_LIMIT) between executions of operation recover_account_operation. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/25_recover_account.md?ref_type=heads

Used in: operation

• required string account_to_recover = 1

  @param {string} account_to_recover - The account to be recovered.

• required authority new_owner_authority = 2

  @param {authority} new_owner_authority - The new owner authority as specified in the request account recovery operation.

• required authority recent_owner_authority = 3

  @param {authority} recent_owner_authority - A previous owner's authority, may be compromised. If the operation change_recovery_account_operation was generated, it has not been yet 30 days since its creation.

• repeated future_extensions extensions = 4

  @param {future_extensions} extensions - Not currently used.

Creates/updates/removes a recurrent transfer in the currency Hive or HBD. Since HF 28, if user has more than one recurrent transfer to the same receiver or if user creates the recurrent transfer using pair_id in the extensions, user has to specify the pair_id in order to update or remove the defined recurrent transfer. - If amount is set to 0, the recurrent transfer will be deleted and the virtual operation fill_recurrent_transfer_operation is not generated - If there is already a recurrent transfer matching 'from' and 'to', the recurrent transfer will be replaced, but: - If the 'recurrence' is not changed, the next execution will be according to “old definition” - If the 'recurrence' is changed, then the next execution will be “update date” + 'recurrence' there is no execution on the update date. - Up to HF28 there can be only one recurrent transfer for sender 'from' and receiver 'to'. Since H28 users may define more recurrent transfers to the same sender and receiver using pair_id in the 'executions'. - The one account may define up to 255 recurrent transfers to other accounts. - The execution date of the last transfer should be no more than 730 days in the future. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/49_recurrent_transfer.md?ref_type=heads

Used in: operation

• required string from_account = 1

  @param {string} from_account

• required string to_account = 2

  @param {string} to_account - Account to transfer asset to. Cannot set a transfer to yourself.

• required asset amount = 3

  @param {asset} amount - The amount of asset to transfer from @ref from to @ref to. If the recurrent transfer failed 10 (HIVE_MAX_CONSECUTIVE_RECURRENT_TRANSFER_FAILURES) times because of the lack of funds, the recurrent transfer will be deleted. Allowed currency: Hive and HBD.

• required string memo = 4

  @param {string} memo - must be shorter than 2048.

• required uint32 recurrence = 5

  @param {number} recurrence - How often will the payment be triggered, unit: hours. The first transfer is executed immediately. The minimum value of the parameter is 24 h.

• required uint32 executions = 6

  @param {number} executions - How many times the recurrent payment will be executed. Executions must be at least 2, if you set executions to 1 the recurrent transfer will not be executed.

• repeated recurrent_transfer_extension extensions = 7

  @param {recurrent_transfer_extension} extensions - Extensions. Since HF 28 it may contain the 'pair_id'. It allows to define more than one recurrent transfer from sender to the same receiver 'to'. Default value 'pair_id=0'.

Used in: recurrent_transfer

• oneof extension

  • void_t void_t = 1

  • recurrent_transfer_pair_id recurrent_transfer_pair_id = 2

Used in: recurrent_transfer_extension

• required uint32 pair_id = 1

Using operation remove_proposal_operation, a user may remove proposals specified by given IDs. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/46_remove_proposal.md?ref_type=heads

Used in: operation

• required string proposal_owner = 1

  @param {string} proposal_owner

• repeated int64 proposal_ids = 2

  @param {number} proposal_ids

• repeated future_extensions extensions = 3

  @param {future_extensions} extensions

In case of the compromised owner authority, a user may recover it. There are two conditions that have to be fulfilled to do it: 1. A user should have an actual recovery account. During an account creation, the account that created a new account is set as a recovery account by default, but it can be changed by the user (using operation change_recovery_account_operation). If the account was created by account temp, then a recovery account is empty and it is set as a top witness – it is not good a recovery account. Note: it takes HIVE_OWNER_AUTH_RECOVERY_PERIOD (30 days) after sending change_recovery_account_operation. for the new recovery agent to become active. During that period the previous agent remains active for the account. 2. The compromised owner authority is still recent. Owner authority is considered recent and remains valid for the purpose of account recovery for HIVE_OWNER_AUTH_RECOVERY_PERIOD (30 days) after it was changed. Note: look for account_update_operation or account_update2_operation in account history to see when its owner authority was compromised. The recovery account process. Conditions: 1. An account { account_to_recover } has an actual recovery account. 2. An account { account_to_recover } realizes that someone may have access to its owner key and it is less than 30 days from generating an operation: change_recovery_account_operation. Steps: A user { account_to_recover } asks his recovery account { recovery_account } to create a request account recovery (outside the blockchain). A recovery account { recovery_account } creates an operation: request_account_recovery_operation with {new_owner_authority}. A user { account_to_recover } creates an operation: recover_account_operation using { new_owner_authority} and {recent_owner_authority} and signing with two signatures (the old one and the new one). A user has HIVE_ACCOUNT_RECOVERY_REQUEST_EXPIRATION_PERIOD to generate this operation. In order to cancel a request, a user should create a new request with weight of authority =0. The operation: request_account_recovery is valid HIVE_ACCOUNT_RECOVERY_REQUEST_EXPIRATION_PERIOD hours and if after HIVE_ACCOUNT_RECOVERY_REQUEST_EXPIRATION_PERIOD hours there is no response (operation: recover_account_operation) it is expired. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/24_request_account_recovery.md?ref_type=heads

Used in: operation

• required string recovery_account = 1

  @param {string} recovery_account - The account that may create a request for account recovery. It is important to keep it actual.

• required string account_to_recover = 2

  @param {string} account_to_recover - The account to be recovered.

• required authority new_owner_authority = 3

  @param {authority} new_owner_authority - The new owner authority – the public, not private key. The new authority should be satisfiable.

• repeated future_extensions extensions = 4

  @param {future_extensions} extensions - Not currently used.

Related to delegate_vesting_shares_operation. Generated during block processing when process of returning removed or lowered vesting delegation is finished (after return period passed) and delegator received back his vests.

Used in: operation

• required string account = 1

  @param {string} account - delegator (receiver of vesting_shares)

• required asset vesting_shares = 2

  @param {asset} vesting_shares - (VESTS) returned delegation

The operation set_withdraw_vesting_route_operation allows a user to decide where and how much percent of hive should be transferred to the account { to_account } from power down operation. A user may also decide that the Hive may be immediately converted to Hive Power. The operation may be created in any moment of power down operation and even if there is no power down operation in progress. The setting is valid till a user creates an operation set_withdraw_vesting_route_operation with the same { to_account} and with the {percent} = 0. A user may set up 10 { to_account } accounts. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/20_set_withdraw_vesting_route.md?ref_type=heads

Used in: operation

• required string from_account = 1

  @param {string} from_account - The account the funds are coming from.

• required string to_account = 2

  @param {string} to_account - The account the funds are going to. A user may set up 10 accounts.

• required uint32 percent = 3

  @param {number} percent - The percentage of the HP shares. If the sum of the setting shares is less than 100%, the rest is transferred to the liquid balance of { from_account }. Default value: percent = 0;

• required bool auto_vest = 4

  @param {bool} auto_vest - If auto_vest = true, then the amount of the Hive is immediately converted into HP on the { to_account } balance. If auto_vest = false, there is no conversion from Hive into HP. Default auto_vest = false;

Related to block processing. Generated during block processing when witness is removed from active witnesses after it was detected he have missed all blocks scheduled for him for last day. No longer active after HF20. @see producer_missed_operation

Used in: operation

• required string owner = 1

  @param {string} owner - witness that was shut down

Related to block processing or selected operations. Generated every time something occurs that would normally be only visible to node operators in their logs but might be interesting to general HIVE community. Such vops can be observed on account history of 'initminer'. Currently the following generate system warnings: - unknown type of witness during block processing [should probably be FC_ASSERT] indicates some problem in the code - shortfall of collateral during finalization of HIVE->HBD conversion (@see fill_collateralized_convert_request_operation) the community covers the difference in form of tiny amount of extra inflation - artificial correction of internal price of HIVE due to hitting of HBD hard cap limit every operation that involves conversion from HBD to HIVE will give output amount that is smaller than real world value - noncanonical fee symbol used by witness [should disappear if it never happened as suggested by TODO message] - witnesses changed maximum block size

Used in: operation

• required string message = 1

  @param {string} message - warning message

Used in: block

• required uint32 ref_block_num = 1

• required uint32 ref_block_prefix = 2

• required string expiration = 3

• repeated operation operations = 4

• repeated future_extensions extensions = 5

• repeated string signatures = 6

  for signed_transaction

@brief Transfers any liquid asset (nonvesting) from one account to another. Transfer funds from 'from_account' to 'to_account'. HIVE and HBD can be transferred. Memo for the transaction can be encrypted if message is started with '#'. Private Memo Key must already be in the wallet for encrypted memo to work. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/02_transfer.md?ref_type=heads

Used in: operation

• required string from_account = 1

  @param {string} from_account - The account the funds are coming from.

• required string to_account = 2

  @param {string} to_account - The account the funds are going to.

• required asset amount = 3

  @param {asset} amount - The amount of asset to transfer from @ref from_account to @ref to_account, the allowed currency: HIVE and HBD.

• required string memo = 4

  @param {string} memo - The memo is plain-text, any encryption on the memo is up to a higher level protocol, must be shorter than 2048.

Funds withdrawals from the savings to an account take three days. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/33_transfer_from_savings.md?ref_type=heads

Used in: operation

• required string from_account = 1

  @param {string} from_account - Account name.

• required uint32 request_id = 2

  @param {number} request_id - The number is given by a user. Should be unique for a user.

• required string to_account = 3

  @param {string} to_account - Account name.

• required asset amount = 4

  @param {asset} amount - The allowed currency: HIVE and HBD, amount > 0.

• required string memo = 5

  @param {string} memo - Have to be UTF8, must be shorter than 2048.

A user can place Hive and Hive Dollars into savings balances. Funds can be withdrawn from these balances after a three day delay. Keeping funds on the savings balance mitigates loss from hacked and compromised accounts. The maximum amount a user can lose instantaneously is the sum of what they hold in liquid balances. Assuming an account can be recovered quickly, loss in such situations can be kept to a minimum Additionally for keeping Hive Dollars on the savings balance, the interests are calculated. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/32_transfer_to_savings.md?ref_type=heads

Used in: operation

• required string from_account = 1

  @param {string} from_account - The account the funds are coming from.

• required string to_account = 2

  @param {string} to_account - The account the funds are going to. The funds may be transferred to someone else savings balance.

• required asset amount = 3

  @param {asset} amount - The allowed currency: HIVE and HBD, amount > 0.

• required string memo = 4

  @param {string} memo - Have to be UTF8, must be shorter than 2048.

The operation is also called Staking. This operation converts Hive into Hive Power (also called Vesting Fund Shares or VESTS) at the current exchange rate. The conversion may be done between the same account or to another account. The more HP (Hive Power) the account has, the more: a. Governance voting power (for witnesses and proposals) has b. Social voting power has (indirectly affects Increase curation rewards) c. Resource Credit has Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/03_transfer_to_vesting.md?ref_type=heads

Used in: operation

• required string from_account = 1

  @param {string} from_account - The account the funds are coming from.

• required string to_account = 2

  @param {string} to_account - The account the funds are going to. If null, then the same as 'from_account'.

• required asset amount = 3

  @param {asset} amount - Must be HIVE, amount > 0.

Related to transfer_to_vesting_operation. Generated every time above operation is executed. Supplements it with amount of VESTS received. Note: power up immediately increases mana regeneration and vote power for comments, but there is a grace period before it activates as governance vote power. @see delayed_voting

Used in: operation

• required string from_account = 1

  @param {string} from_account - account that executed power up (source of hive_vested)

• required string to_account = 2

  @param {string} to_account - account that gets power up (receiver of vesting_shares_received)

• required asset hive_vested = 3

  @param {asset} hive_vested - (HIVE) liquid funds being turned into VESTS

• required asset vesting_shares_received = 4

  @param {asset} vesting_shares_received - (VESTS) result of power up

A user who created the proposal may update it. A user may decrease {daily_pay}, change subject, permlink and {end_date} (using {extensions}). In order to update the proposal parameters, all parameters should be entered. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/47_update_proposal.md?ref_type=heads

Used in: operation

• required int64 proposal_id = 1

  @param {number} proposal_id

• required string creator = 2

  @param {string} creator

• required asset daily_pay = 3

  @param {asset} daily_pay

• required string subject = 4

  @param {string} subject

• required string permlink = 5

  @param {string} permlinks

• repeated update_proposal_extension extensions = 6

  @param {update_proposal_extension} extensions

Used in: update_proposal_extension

• required string end_date = 1

Used in: update_proposal

• oneof value

  • void_t void_t = 1

  • update_proposal_end_date update_proposal_end_date = 2

A user may vote for proposals directly using an operation: update_proposal_votes_operation, or indirectly using the proxy - operation: account_witness_proxy_operation. A user may vote for proposals submitted by the other users. By voting for the proposal, a user may select which proposals should be funded. A user may vote for as many proposals as they wants, but you cannot vote twice for the same proposal. If a proxy is specified then all existing votes are deactivated. When the proxy is removed, the votes will be activated. Your vote power depends on your HP. If the operation account_witness_vote_operation or account_witness_proxy_operation or update_proposal_votes_operation is not executed in HIVE_GOVERNANCE_VOTE_EXPIRATION_PERIOD, the votes are removed and the virtual operation: expired_account_notification_operation is generated. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/45_update_proposal_votes.md?ref_type=heads

Used in: operation

• required string voter = 1

  @param {string} voter - Account name.

• repeated int64 proposal_ids = 2

  @param {number} proposal_ids - IDs of proposals to vote for/against. Before HF28 nonexisting IDs are ignored from HF28 they trigger an error.

• required bool approve = 3

  @param {bool} approve - To vote for the proposal, the approve = true. To remove the vote, the approve = false.

• repeated future_extensions extensions = 4

  @param {future_extensions} extensions

Related to hardfork 1. Generated for every account with nonzero vesting balance. Note: due to too small precision of VESTS asset it was increased by 6 digits, meaning all underlying amounts had to be multiplied by million.s

Used in: operation

• required string owner = 1

  @param {string} owner - affected account (source of vesting_shares_before_split and receiver of vesting_shares_after_split)

• required asset vesting_shares_before_split = 2

  @param {asset} vesting_shares_before_split - (VESTS) balance before split

• required asset vesting_shares_after_split = 3

  @param {asset} vesting_shares_after_split - (VESTS) balance after split

Used in: block_header_extensions, future_extensions, recurrent_transfer_extension, update_proposal_extension

(message has no fields)

A user may upvote or downvote a post or a comment. A user has a voting power. The max voting power depends on HP. There are two manabars related to voting: Voting manabar and Downvoting manabar. Voting and downvoting manabars are defined as a percentage of total vote weight. Downvote manabar has 25% of the vote power weight and vote manabar has 100% of the vote power weight, but a user downvote with the total vote weight (not 25 %, but 100%). When a user casts a vote, 1/50th of the remaining mana is used for a 100% vote. The voting powers regenerate from 0 to 100% in 5 days (20% per day). If a voter casts another vote for the same post or comment before rewards are paid, it counts as vote edit. Vote edit cancels all effects of previous vote and acts as completely new vote, except mana used for previous vote is not returned. The author of the post or the comment may receive the reward, the amount of the author's reward depends on the numbers and powers of the votes. By default the author reward is paid 50% HP and 50 % HBD. A user who votes for the post or the comment may receive the curation reward. It is paid 100% HP. Its share depends on: - voting power - weight of the vote – a user may decide about the weight of the vote - the time when they vote – the sooner you vote, the higher the share in the curation reward (the first 24 h the weight of the vote is 100% - early voting, next 48 hours the weight is divided by 2, then – till the 7th day - it is divided by 8) When a post or a comment receives a reward, it is divided between the author's reward and the curation reward. The curation reward is shared among curators. The calculated reward should be more than 0.02 HBD to be paid, if it is less, it is not paid. A downvoting user doesn’t receive the curation reward. Downvoting may affect the author of the comment's reputation when a user who downvotes has a higher reputation than the author. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/00_vote.md?ref_type=heads

Used in: operation

• required string voter = 10

  @param {string} voter - Account name.

• required string author = 11

  @param {string} author - Account name, the author of the post or the comment.

• required string permlink = 12

  @param {string} permlink - The identifier of the post or comment.

• required uint32 weight = 13

  @param {number} weight - It defines how many percent of the non-used voting power a user wants to use. Allowed values from -10000 (-100%) to 10000 (100%). Downvotes: from -10000 (-100%) to 0. Upvotes: from 0 to 10000 (100%).

This operation converts Hive Power (also called Vesting Fund Shares or VESTS) into HIVE. At any given point in time an account can be withdrawing from their vesting shares. A user may change the number of shares they wish to cash out at any time between 0 and their total vesting stake. After applying this operation, vesting_shares will be withdrawn at a rate of vesting_shares/13 per week for 13 weeks starting one week after this operation is included in the blockchain. This operation is not valid if a user has no vesting shares. There can be only one withdraw_vesting_operation processed at the same time. If a user wants to stop withdraw_vesting_operation, they should create an operation withdraw_vesting_operation with amount =0. If a user creates a new withdraw_vesting_operation when the old one is still processed, then the old withdraw_vesting_operation will be canceled and a new one will be processed. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/04_withdraw_vesting.md?ref_type=heads

Used in: operation

• required string account = 1

  @param {string} account - The account the funds are coming from.

• required asset vesting_shares = 2

  @param {asset} vesting_shares - Amount of VESTS (HP)

This is an operation for witnesses. This operation is used in the process of block_validity_vote (see https://hive.blog/hive-139531/@blocktrades/one-block-irreversibility-for-delegated-proof-of-stake-dpos). Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/16_witness_block_approve.md?ref_type=heads

Used in: operation

• required string witness = 1

  @param {string} witness

• required string block_id = 2

  @param {string} block_id

This is an operation for witnesses. This is one of the two operations allowing to update witness properties (@see witness_update_operation). The whole list of properties is available here: https://gitlab.syncad.com/hive/hive/-/blob/master/doc/witness_parameters.md. Description https://gitlab.syncad.com/hive/hive/-/blob/develop/doc/devs/operations/42_witness_set_properties.md?ref_type=heads

Used in: operation

• required string owner = 1

  @param {string} owner - Witness account name.

• map<string, string> props = 2

  @param {map<string, string>} props - There are the following properties available in the {props}: account_creation_fee, account_subsidy_budget, account_subsidy_decay, maximum_block_size, hbd_interest_rate. hbd_exchange_rate, url and new_signing_key.

• repeated future_extensions extensions = 3

  @param {future_extensions} extensions

The operation witness_update_operation may be used to become a new witness or to update witness properties. There are two operations that allow to update witness properties witness_update_operation and witness_set_properties_operation. In order to update witness properties it is recommended to use witness_set_properties_operation. If a user wants to become a witness, the operation witness_update_operation should be created. If the witness doesn’t want to be a witness any more, the operation witness_update_operation with empty { block_signing_key } should be created.

Used in: operation

• required string owner = 1

  @param {string} owner - The witness who wants to update properties or a user who wants to become a witness.

• required string url = 2

  @param {string} url - url to information about witness.

• required string block_signing_key = 3

  @param {string} block_signing_key - Public block signing key.

• required legacy_chain_properties props = 4

  @param {legacy_chain_properties} props

• required asset fee = 5

  @param {asset} fee - The asset is validated (the format should be correct and should be expressed in Hive), but the fee is currently ignored.