credmark.cmf.types.ledger_series.LedgerBlockNumberTimeSeries

DTO class LedgerBlockNumberTimeSeries(*, endTimestamp, interval, exclusive=False, blockNumbers=[])[source]

Bases: BaseModel

Output for the ledger.block-time-series model.

Show JSON schema

{
   "title": "LedgerBlockNumberTimeSeries",
   "description": "Output for the ledger.block-time-series model.",
   "type": "object",
   "properties": {
      "endTimestamp": {
         "title": "Endtimestamp",
         "description": "End timestamp of block series, inclusive unless exclusive is True",
         "type": "integer"
      },
      "interval": {
         "title": "Interval",
         "description": "Series interval in seconds",
         "type": "integer"
      },
      "exclusive": {
         "title": "Exclusive",
         "description": "If true, blocks are exclusive of end timestamp",
         "default": false,
         "type": "boolean"
      },
      "blockNumbers": {
         "title": "Blocknumbers",
         "description": "List of block numbers",
         "default": [],
         "type": "array",
         "items": {
            "type": "integer"
         }
      }
   },
   "required": [
      "endTimestamp",
      "interval"
   ]
}

Fields

blockNumbers (List[credmark.cmf.types.block_number.BlockNumber])
endTimestamp (int)
exclusive (Optional[bool])
interval (int)

Parameters

endTimestamp (int) –
interval (int) –
exclusive (Optional[bool]) –
blockNumbers (List[BlockNumber]) –

Return type

None

field blockNumbers: List[BlockNumber] = []: List of block numbers

field endTimestamp: int [Required]: End timestamp of block series, inclusive unless exclusive is True

field exclusive: Optional[bool] = False: If true, blocks are exclusive of end timestamp

field interval: int [Required]: Series interval in seconds