Bulk Pull by Account Support

[rkeene]

Add support for a new bootstrapping command called "bulk_pull_account" which accepts as arguments:

1. Account (256-bits)
2. Minimum Pending Amount (128 bits)
3. Flags (8-bits)

The Account argument is the public key of an account which we are interested in. The "bulk_pull_account" command will request that the remote node return all blocks related to this account. This includes the frontier for the account and information related to transactions destined for that account that have not yet been received with receiving blocks (pending).

The Minimum Pending Amount argument is the minimum amount that must be pending in a single transaction for an account or block hash to be included in the pending result section.

The Flags argument is an enumeration consisting of the following possible values:

• 0x00: PENDING_HASH_AND_AMOUNT: This option indicates that the result should include the block hash of the sending block and the amount in the pending section;
• 0x01: PENDING_ADDRESS_ONLY: This option indicates that the result should only include the sending account public keys in the pending section;
• 0x02: PENDING_HASH_AMOUNT_AND_ADDRESS (V17.0+): This option indicates the result should include the account sending public key in addition to anything supplied in PENDING_HASH_AND_AMOUNT`

The result will be in the format of

struct frontierInformation {
        blockHash_t frontierHash
        rawAmount_t frontierBalance
}
union pending {
     /* When Flags == PENDING_ADDRESS_ONLY */
     struct addressOnly[] {
          address_t sendingAccount
     }
     /* When Flags == PENDING_HASH_AND_AMOUNT */
     struct hashBalanceTuple[] {
          blockHash_t sendingBlockHash
          rawAmount_t sendingBlockAmount
     }
     /* When Flags == PENDING_HASH_AMOUNT_AND_ADDRESS */
     struct hashBalanceAddressTuple[] {
          blockHash_t sendingBlockHash
          rawAmount_t sendingBlockAmount
          address_t sendingAccount
     }
}

Where blockHash_t and address_t are a 256-bit bitfield, and rawAmount_t is a 128-bit bitfield.

The pending section will terminate with a final entry where all entries have a value of 0. That is, for the case where the PENDING_ADDRESS_ONLY option is selected the result will terminate with a value of a 256-bits 0. If the PENDING_HASH_AND_AMOUNT option is selected the result will terminate with a value of 384 (256+128) bits of 0. If the PENDING_HASH_AMOUNT_AND_ADDRESS option is selected the result will terminate with a value of 640 (256+128+256) bits of 0.

[slact]

Yes!

[inkeliz]

Wait. There's a new field, Flags (8-bits)? Why create a Flag when already have the Extesions (16-bit) in the header?

[rkeene]

@inkeliz Because if we use extension bits for this then those bits cannot be used for many things since those things may apply also to bulk_pull_account.