Corresponds to RPC schema:

{ // Commitments
"kind": "commitment",
"category": "commitment",
"committer": $Blinded public key hash,
"change": $int64,
"origin": "block" || "migration" || "subsidy" || "simulation" }

Oxford protocol adds delayed origin for all category values:

|| { ...
"origin": "delayed_operation",
"delayed_operation_hash": $Operation_hash }

Tezos Protocol

Ithaca

Hierarchy

  • BaseBalanceUpdate
    • BalanceUpdateCommitment

Properties

bondRollupAddress: null

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

category: Commitment

Usable for narrowing the type of this object from BalanceUpdate.

change: BigNumber

The actual balance change.

committer: string
contractAddress: null

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

cycle: null

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

delayedOperationHash: null | string

It has a value only if origin is DelayedOperation

delegateAddress: null

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

delegatorContractAddress: null

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

Usable for narrowing the type of this object from BalanceUpdate.

Usable for narrowing the type of this object from BalanceUpdate.

participation: null

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

revelation: null

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

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

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

Type declaration

  • Optional Readonly bond_id?: { readonly smart_rollup: string; }
  • Optional Readonly category?: METADATA_BALANCE_UPDATES_CATEGORY
  • Readonly change: string
  • Optional Readonly committer?: string
  • Optional Readonly contract?: string
  • Optional Readonly cycle?: number
  • Optional Readonly delayed_operation_hash?: string
  • Optional Readonly delegate?: string
  • Optional Readonly delegator?: string
  • Readonly kind: MetadataBalanceUpdatesKindEnum
  • Optional Readonly origin?: MetadataBalanceUpdatesOriginEnum
  • Optional Readonly participation?: boolean
  • Optional Readonly revelation?: boolean
  • Optional Readonly staker?: ({ readonly contract: string; readonly delegate: string; }) | ({ readonly delegate: string; }) | ({ readonly baker: string; }) | ({ readonly baker_edge: string; })
staker: null

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

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]

Generated using TypeDoc