Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetTransactionsRequest

Example:

{
    begin: { offsetType: 'boundary', boundary: LedgerOffsetBoundaryValue.END }
    filter: {
        filtersByParty: {
            Alice: {
                inclusive: {
                    templateIds: [
                        {
                            packageId: 'some-package-id',
                            moduleName: 'SomeModule',
                            entityName: 'SomeTemplate'
                        }
                    ]
                }
            }
        }
    }
}

To express values in a more concise way, you can have a look at the ValueHelpers.

see

LedgerOffset

see

TransactionFilter

see

Filters

see

InclusiveFilters

see

Identifier

Hierarchy

  • GetTransactionsRequest

Index

Properties

Properties

begin

Beginning of the requested ledger section.

Optional end

End of the requested ledger section.

Optional, if not set, the stream will not terminate.

filter

Requesting parties with template filters.

Optional verbose

verbose: undefined | false | true

If enabled, values served over the API will contain more information than strictly necessary to interpret the data.

In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.

Defaults to true if not explicitly set.

Generated using TypeDoc