[][src]Module factom::tx

Functions relating to transactions

Structs

Commitdata
DeleteTx

delete-transaction function

EcOutput
Ecoutput
EntryAck
Entrydata
FactoidAck
Factoidtransaction
FctSubmit

factoid-submit function

Input
NewTx

new-transaction and add-ec-output functions

Output
PendingTx
PendingTxs

pending-transactions function

Sigblock
TmpTransaction
TmpTransactions

tmp-transactions function

Transaction

transaction function

Transactions

transactions function

Tx

add-input, add-output, add-fee, sub-fee, sign-transaction functions

TxInput
TxOutput
Txs

Individual transactions from the transactions function

Enums

SearchBy

Search options for the transactions function

Functions

add_ec_output

When adding entry credit outputs, the amount given is in factoshis, not entry credits. This means math is required to determine the correct amount of factoshis to pay to get X EC.

add_fee

Addfee is a shortcut and safeguard for adding the required additional factoshis to covert the fee. The fee is displayed in the returned transaction after each step, but addfee should be used instead of manually adding the additional input. This will help to prevent overpaying.

add_input

Adds an input to the transaction from the given address. The public address is given, and the wallet must have the private key associated with the address to successfully sign the transaction.

add_output

Adds a factoid address output to the transaction. Keep in mind the output is done in factoshis. 1 factoid is 1,000,000,000 factoshis.

delete_transaction

Deletes a working transaction in the wallet. The full transaction will be returned, and then deleted.

ec_ack

This api call is used to find the status of a transaction, whether it be a factoid, reveal entry, or commit entry. When using this, you must specify the type of the transaction by giving the chainid field 1 of 3 values:

factoid_submit

Submit a factoid transaction. The transaction hex encoded string is documented here: Github Documentation

fct_ack

See documentation for ec_ack

new_transaction

This will create a new transaction. The txid is in flux until the final transaction is signed. Until then, it should not be used or recorded.

pending_transactions

Returns an array of factoid transactions that have not yet been recorded in the blockchain, but are known to the system.

sign_transaction

Signs the transaction. It is now ready to be executed.

sub_fee

When paying from a transaction, you can also make the receiving transaction pay for it. Using sub fee, you can use the receiving address in the parameters, and the fee will be deducted from their output amount.

tmp_transactions

Lists all the current working transactions in the wallet. These are transactions that are not yet sent.

transaction

Retrieve details of a factoid transaction using a transaction’s hash (or corresponding transaction id).

transactions

There are a few ways to search for a transaction