Transaction Builder

Transaction Builder

begin_builder_transaction

Create a new transaction builder.

transaction_handle_typegraphene::wallet::wallet_api::begin_builder_transaction()

Return

Handle of the new transaction builder.

add_operation_to_builder_transaction

Append a new operation to a transaction builder.

void graphene::wallet::wallet_api::add_operation_to_builder_transaction(
    transaction_handle_typetransaction_handle, 
    const operation &op)

Parameters

• transaction_handle: handle of the transaction builder

• op: the operation in JSON format

replace_operation_in_builder_transaction

Replace an operation in a transaction builder with a new operation.

void graphene::wallet::wallet_api::replace_operation_in_builder_transaction(
    transaction_handle_typehandle, 
    unsigned operation_index, 
    const operation &new_op)

Parameters

• handle: handle of the transaction builder

• operation_index: the index of the old operation in the builder to be replaced

• new_op: the new operation in JSON format

set_fees_on_builder_transaction

Calculate and update fees for the operations in a transaction builder.

asset graphene::wallet::wallet_api::set_fees_on_builder_transaction(
    transaction_handle_typehandle, 
    string fee_asset = GRAPHENE_SYMBOL)

Parameters

• handle: handle of the transaction builder

• fee_asset: name or ID of an asset that to be used to pay fees

Return

Total fees.

preview_builder_transaction

Show content of a transaction builder.

transaction graphene::wallet::wallet_api::preview_builder_transaction(
    transaction_handle_typehandle)

Parameters

• handle: handle of the transaction builder

Return

A transaction.

sign_builder_transaction

Sign the transaction in a transaction builder and optionally broadcast to the network.

signed_transaction graphene::wallet::wallet_api::sign_builder_transaction(
    transaction_handle_typetransaction_handle, 
    bool broadcast = true)

Parameters

• transaction_handle: handle of the transaction builder

• broadcast: whether to broadcast the signed transaction to the network

Return

A signed transaction.

propose_builder_transaction

Create a proposal containing the operations in a transaction builder (create a new proposal_create operation, then replace the transaction builder with the new operation), then sign the transaction and optionally broadcast to the network.

Note: this command is not effective because you're unable to specify a proposer. It will be deprecated in a future release. Use propose_builder_transaction2() instead.

signed_transaction graphene::wallet::wallet_api::propose_builder_transaction(
    transaction_handle_typehandle, 
    time_point_sec expiration = time_point::now() + fc::minutes(1), 
    uint32_t review_period_seconds = 0, 
    bool broadcast = true)

Parameters

• handle: handle of the transaction builder

• expiration: when the proposal will expire

• review_period_seconds: review period of the proposal in seconds

• broadcast: whether to broadcast the signed transaction to the network

Return

A signed transaction.

propose_builder_transaction2

Create a proposal containing the operations in a transaction builder (create a new proposal_create operation, then replace the transaction builder with the new operation), then sign the transaction and optionally broadcast to the network.

signed_transaction graphene::wallet::wallet_api::propose_builder_transaction2(
    transaction_handle_typehandle, 
    string account_name_or_id, 
    time_point_sec expiration = time_point::now() + fc::minutes(1), 
    uint32_t review_period_seconds = 0, 
    bool broadcast = true)

Parameters

• handle: handle of the transaction builder

• account_name_or_id: name or ID of the account who would pay fees for creating the proposal

• expiration: when the proposal will expire

• review_period_seconds: review period of the proposal in seconds

• broadcast: whether to broadcast the signed transaction to the network

Return

A signed transaction.

remove_builder_transaction

Destroy a transaction builder.

void graphene::wallet::wallet_api::remove_builder_transaction(
    transaction_handle_typehandle)

Parameters

• handle: handle of the transaction builder

serialize_transaction

Converts a signed_transaction in JSON form to its binary representation.

string graphene::wallet::wallet_api::serialize_transaction(
    signed_transaction tx)const

Parameters

• tx: the transaction to serialize

Return

The binary form of the transaction. It will not be hex encoded, this returns a raw string that may have null characters embedded in it

sign_transaction

Signs a transaction.

Given a fully-formed transaction that is only lacking signatures, this signs the transaction with the necessary keys and optionally broadcasts the transaction.

signed_transaction graphene::wallet::wallet_api::sign_transaction(
    signed_transaction tx, 
    bool broadcast = false)

Parameters

• tx: the unsigned transaction

• broadcast: true if you wish to broadcast the transaction

Return

The signed version of the transaction

get_prototype_operation

Returns an uninitialized object representing a given blockchain operation.

This returns a default-initialized object of the given type; it can be used during early development of the wallet when we don’t yet have custom commands for creating all of the operations the blockchain supports.

Any operation the blockchain supports can be created using the transaction builder’s add_operation_to_builder_transaction() , but to do that from the CLI you need to know what the JSON form of the operation looks like. This will give you a template you can fill in. It’s better than nothing.

operation graphene::wallet::wallet_api::get_prototype_operation(
    string operation_type)

Parameters

• operation_type: the type of operation to return, must be one of the operations defined in graphene/protocol/operations.hpp (e.g., “global_parameters_update_operation”)

Return

A default-constructed operation of the given type.