Chain Models

pydantic model pyil2.models.chain.ChainCreatedModel

Bases: ChainIdModel

Chain created response.

field closed: bool = False (alias 'isClosedForNewTransactions')

If True, this chain is not able to accept new records.

field id: str [Required]

Chain ID.

field key_files: List[ExportedKeyFileModel] [Optional] (alias 'keyFiles')

Key file names.

field last_record: int = 0 (alias 'lastRecord')

Last record (serial number).

field last_update: datetime.datetime [Required] (alias 'lastUpdate')

Date last record was added.

field licensing_status: str | None = None (alias 'licensingStatus')

Licensing status.

field name: str | None = None

Chain name.

field size_in_bytes: int = 0 (alias 'sizeInBytes')

Chain size in bytes.

pydantic model pyil2.models.chain.ChainCreationModel

Bases: BaseCamelModel

Chain creation model.

field addional_apps: List[int] [Optional] (alias 'addionalApps')

List of additional apps (only numeric ids).

field api_certificates: List[CertificatePermitModel] | None = None (alias 'apiCertificates')

List of certificates to permit in the chain.

field description: str | None = None

Description (perhaps intended primary usage).

field emergency_closing_key_password: str [Required] (alias 'emergencyClosingKeyPassword')

Emergency closing key password.

Constraints:
  • min_length = 1

field emergency_closing_key_strength: KeyStrength = KeyStrength.EXTRA_STRONG (alias 'emergencyClosingKeyStrength')

Emergency closing key strength of key.

field keys_algorithm: Algorithms | None = None (alias 'keysAlgorithm')

Keys algorithm.

field management_key_password: str [Required] (alias 'managementKeyPassword')

Key management key password.

Constraints:
  • min_length = 1

field management_key_strength: KeyStrength = KeyStrength.STRONG (alias 'managementKeyStrength')

Key management strength of key.

field name: str [Required]

Name of the chain.

Constraints:
  • min_length = 1

field operating_key_algorithm: Algorithms | None = None (alias 'operatingKeyAlgorithm')

Operating key algorithm.

field operating_key_strength: KeyStrength = KeyStrength.NORMAL (alias 'operatingKeyStrength')

Operating key strength of key.

field parent: str | None = None

Parent chain ID.

pydantic model pyil2.models.chain.ChainIdModel

Bases: BaseCamelModel

Chain summary.

field closed: bool = False (alias 'isClosedForNewTransactions')

If True, this chain is not able to accept new records.

field id: str [Required]

Chain ID.

field last_record: int = 0 (alias 'lastRecord')

Last record (serial number).

field last_update: datetime [Required] (alias 'lastUpdate')

Date last record was added.

field licensing_status: str | None = None (alias 'licensingStatus')

Licensing status.

field name: str | None = None

Chain name.

field size_in_bytes: int = 0 (alias 'sizeInBytes')

Chain size in bytes.

pydantic model pyil2.models.chain.ChainSummaryModel

Bases: ChainIdModel

Chain summary.

field active_apps: List[int] [Optional] (alias 'activeApps')

List of active apps (only the numeric ids).

field closed: bool = False (alias 'isClosedForNewTransactions')

If True, this chain is not able to accept new records.

field description: str | None = None

Chain description.

field id: str [Required]

Chain ID.

field is_mirror: bool = False (alias 'isMirror')

If True, this chain is a mirror copy from an outside node.

field last_record: int = 0 (alias 'lastRecord')

Last record (serial number).

field last_update: datetime.datetime [Required] (alias 'lastUpdate')

Date last record was added.

field licensing_status: str | None = None (alias 'licensingStatus')

Licensing status.

field name: str | None = None

Chain name.

field size_in_bytes: int = 0 (alias 'sizeInBytes')

Chain size in bytes.