Interface BalanceUpdateFreezer

Corresponds to RPC schema:

{ // Rewards
     "kind": "freezer",
     "category": "rewards",
     "delegate": $Signature.Public_key_hash,
     "cycle": integer ∈ [-2^31-1, 2^31],
     "change": $int64,
     "origin": "block" || "migration" || "subsidy" }
|| { // Fees
     "kind": "freezer",
     "category": "fees",
     "delegate": $Signature.Public_key_hash,
     "cycle": integer ∈ [-2^31-1, 2^31],
     "change": $int64,
     "origin": "block" || "migration" || "subsidy" }

and from Ithaca protocol:

{ // Legacy_rewards
     "kind": "freezer",
     "category": "legacy_rewards",
     "delegate": $Signature.Public_key_hash,
     "cycle": integer ∈ [-2^31-1, 2^31],
     "change": $int64,
     "origin": "block" || "migration" || "subsidy" || "simulation" }
|| { // Legacy_deposits
     "kind": "freezer",
     "category": "legacy_deposits",
     "delegate": $Signature.Public_key_hash,
     "cycle": integer ∈ [-2^31-1, 2^31],
     "change": $int64,
     "origin": "block" || "migration" || "subsidy" || "simulation" }
|| { // Legacy_fees
     "kind": "freezer",
     "category": "legacy_fees",
     "delegate": $Signature.Public_key_hash,
     "cycle": integer ∈ [-2^31-1, 2^31],
     "change": $int64,
     "origin": "block" || "migration" || "subsidy" || "simulation" }

Hierarchy

Properties

bondRollup category change committer contractAddress cycle delegateAddress kind origin participation revelation rpcData uid

Properties

Readonly bondRollup

bondRollup: null

Always null for this type so that the property is directly available on BalanceUpdate union.

Readonly category

category: BalanceUpdateFreezerCategory

Usable for narrowing the type of this object from BalanceUpdate.

Readonly change

change: BigNumber

Actual balance change.

Readonly committer

committer: null

Always null for this type so that the property is directly available on BalanceUpdate union.

Readonly contractAddress

contractAddress: null

Always null for this type so that the property is directly available on BalanceUpdate union.

Readonly cycle

cycle: number

Readonly delegateAddress

delegateAddress: string

User tz address.

Readonly kind

kind: Freezer

Usable for narrowing the type of this object from BalanceUpdate.

Readonly origin

origin: null | BalanceUpdateOrigin

This property was added in protocol 9 Florence. It is null for older protocols.

Readonly participation

participation: null

Always null for this type so that the property is directly available on BalanceUpdate union.

Readonly revelation

revelation: null

Always null for this type so that the property is directly available on BalanceUpdate union.

Readonly rpcData

rpcData: {
    bond_id?: ({ readonly smart_rollup?: undefined; readonly tx_rollup: string; }) | ({ readonly smart_rollup: string; readonly tx_rollup?: undefined; });
    category?: METADATA_BALANCE_UPDATES_CATEGORY;
    change: string;
    committer?: string;
    contract?: string;
    cycle?: number;
    delegate?: string;
    kind: MetadataBalanceUpdatesKindEnum;
    origin?: MetadataBalanceUpdatesOriginEnum;
    participation?: boolean;
    revelation?: boolean;
}

Raw data as received from Tezos Node RPC. Taquito interface may not be exact.

Type declaration

  • Optional Readonly bond_id?: ({ readonly smart_rollup?: undefined; readonly tx_rollup: string; }) | ({ readonly smart_rollup: string; readonly tx_rollup?: undefined; })
  • Optional Readonly category?: METADATA_BALANCE_UPDATES_CATEGORY
  • Readonly change: string
  • Optional Readonly committer?: string
  • Optional Readonly contract?: string
  • Optional Readonly cycle?: number
  • Optional Readonly delegate?: string
  • Readonly kind: MetadataBalanceUpdatesKindEnum
  • Optional Readonly origin?: MetadataBalanceUpdatesOriginEnum
  • Optional Readonly participation?: boolean
  • Optional Readonly revelation?: boolean

Readonly uid

uid: string

Universal ID of the entity on the blockchain. It is still human-readable.

Example

Block hash / operation group hash / operation index [ operation kind ]

BLvgirK7K43H5tv8f73cxBaLwcU7euFNwmfr2td2sWKpKXQXxaM/opLpKECfrpuF79YLfSYABvxb8Df8Fh71n3Q8Azy1m8vWU8Czfcn/4[transaction]

Settings

Member Visibility

Theme

Generated using TypeDoc