package cash.z.wallet.sdk.ffi

Get desktop application:
View/edit binary Protocol Buffers messages

A proposed change or ephemeral output. If the transparent value pool is selected, the `memo` field must be null. When the `isEphemeral` field of a `ChangeValue` is set, it represents an ephemeral output, which must be spent by a subsequent step. This is only supported for transparent outputs. Each ephemeral output will be given a unique t-address.

Used in: TransactionBalance

• uint64 value = 1

  The value of a change or ephemeral output to be created, in zatoshis.

• ValuePool valuePool = 2

  The value pool in which the change or ephemeral output should be created.

• optional MemoBytes memo = 3

  The optional memo that should be associated with the newly created output. Memos must not be present for transparent outputs.

• bool isEphemeral = 4

  Whether this is to be an ephemeral output.

The fee rule used in constructing a Proposal

Used in: Proposal

• FeeRuleNotSpecified = 0

  Protobuf requires that enums have a zero discriminant as the default value. However, we need to require that a known fee rule is selected, and we do not want to fall back to any default, so sending the FeeRuleNotSpecified value will be treated as an error.

• PreZip313 = 1

  10000 ZAT

• Zip313 = 2

  1000 ZAT

• Zip317 = 3

  MAX(10000, 5000 * logical_actions) ZAT

An object wrapper for memo bytes, to facilitate representing the `change_memo == None` case.

Used in: ChangeValue

• bytes value = 1

A mapping from ZIP 321 payment index to the output pool that has been chosen for that payment, based upon the payment address and the selected inputs to the transaction.

Used in: ProposalStep

• uint32 paymentIndex = 1

• ValuePool valuePool = 2

A reference to a change or ephemeral output from a prior step of the proposal.

Used in: ProposedInput

• uint32 stepIndex = 1

• uint32 changeIndex = 2

A reference to a payment in a prior step of the proposal. This payment must belong to the wallet.

Used in: ProposedInput

• uint32 stepIndex = 1

• uint32 paymentIndex = 2

A data structure that describes a series of transactions to be created.

• uint32 protoVersion = 1

  The version of this serialization format.

• FeeRule feeRule = 2

  The fee rule used in constructing this proposal

• uint32 minTargetHeight = 3

  The target height for which the proposal was constructed The chain must contain at least this many blocks in order for the proposal to be executed.

• repeated ProposalStep steps = 4

  The series of transactions to be created.

A data structure that describes the inputs to be consumed and outputs to be produced in a proposed transaction.

Used in: Proposal

• string transactionRequest = 1

  ZIP 321 serialized transaction request

• repeated PaymentOutputPool paymentOutputPools = 2

  The vector of selected payment index / output pool mappings. Payment index 0 corresponds to the payment with no explicit index.

• uint32 anchorHeight = 3

  The anchor height to be used in creating the transaction, if any. Setting the anchor height to zero will disallow the use of any shielded inputs.

• repeated ProposedInput inputs = 4

  The inputs to be used in creating the transaction.

• optional TransactionBalance balance = 5

  The total value, fee value, and change outputs of the proposed transaction

• bool isShielding = 6

  A flag indicating whether the step is for a shielding transaction, used for determining which OVK to select for wallet-internal outputs.

The unique identifier and value for an input to be used in the transaction.

Used in: ProposalStep

• oneof value

  • ReceivedOutput receivedOutput = 1

  • PriorStepOutput priorStepOutput = 2

  • PriorStepChange priorStepChange = 3

The unique identifier and value for each proposed input that does not require a back-reference to a prior step of the proposal.

Used in: ProposedInput

• bytes txid = 1

• ValuePool valuePool = 2

• uint32 index = 3

• uint64 value = 4

The proposed change outputs and fee value.

Used in: ProposalStep

• repeated ChangeValue proposedChange = 1

  A list of change or ephemeral output values.

• uint64 feeRequired = 2

  The fee to be paid by the proposed transaction, in zatoshis.

Used in: ChangeValue, PaymentOutputPool, ReceivedOutput

• PoolNotSpecified = 0

  Protobuf requires that enums have a zero discriminant as the default value. However, we need to require that a known value pool is selected, and we do not want to fall back to any default, so sending the PoolNotSpecified value will be treated as an error.

• Transparent = 1

  The transparent value pool (P2SH is not distinguished from P2PKH)

• Sapling = 2

  The Sapling value pool

• Orchard = 3

  The Orchard value pool