Interface BalanceUpdateCommitment

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

Index

Properties

bondRollupAddress category change committer contractAddress cycle delayedOperationHash delegateAddress delegatorContractAddress kind origin participation revelation rpcData staker uid

Properties

`Readonly` bondRollupAddress

bondRollupAddress: null

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

`Readonly` category

category: Commitment

Usable for narrowing the type of this object from BalanceUpdate.

`Readonly` change

change: BigNumber

The actual balance change.

`Readonly` committer

committer: string

`Readonly` contractAddress

contractAddress: null

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

`Readonly` cycle

cycle: null

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

`Readonly` delayedOperationHash

delayedOperationHash: null | string

It has a value only if origin is DelayedOperation

`Readonly` delegateAddress

delegateAddress: null

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

`Readonly` delegatorContractAddress

delegatorContractAddress: null

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

`Readonly` kind

kind: Commitment

Usable for narrowing the type of this object from BalanceUpdate.

`Readonly` origin

origin: BalanceUpdateOrigin

Usable for narrowing the type of this object from BalanceUpdate.

`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: 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; })

`Readonly` staker

staker: null

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

`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]

Interface BalanceUpdateCommitment

Tezos Protocol

Hierarchy

Index

Properties

Properties

Readonly bondRollupAddress

Readonly category

Readonly change

Readonly committer

Readonly contractAddress

Readonly cycle

Readonly delayedOperationHash

Readonly delegateAddress

Readonly delegatorContractAddress

Readonly kind

Readonly origin

Readonly participation

Readonly revelation

Readonly rpcData

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; })

Readonly staker

Readonly uid

Example

Settings

Member Visibility

Theme

`Readonly` bondRollupAddress

`Readonly` category

`Readonly` change

`Readonly` committer

`Readonly` contractAddress

`Readonly` cycle

`Readonly` delayedOperationHash

`Readonly` delegateAddress

`Readonly` delegatorContractAddress

`Readonly` kind

`Readonly` origin

`Readonly` participation

`Readonly` revelation

`Readonly` rpcData

`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; })

`Readonly` staker

`Readonly` uid