Class TransactionHeartbeat

Fields for a heartbeat transaction. Definition: data/transactions/heartbeat.go : HeartbeatTxnFields

Implements

Encodable

Index

Constructors

constructor

new TransactionHeartbeat(__namedParameters): TransactionHeartbeat
Creates a new TransactionHeartbeat object.
Parameters
- __namedParameters: {
      hbAddress: string;
      hbChallengeDiscount?: boolean;
      hbKeyDilution: number | bigint;
      hbProof: HbProofFields;
      hbSeed: string | Uint8Array;
      hbVoteId: string | Uint8Array;
  }
  - hbAddress: string
  - Optional hbChallengeDiscount?: boolean
  - hbKeyDilution: number | bigint
  - hbProof: HbProofFields
  - hbSeed: string | Uint8Array
  - hbVoteId: string | Uint8Array
Returns TransactionHeartbeat
- Defined in client/v2/indexer/models/types.ts:8183

Properties

hbAddress

hbAddress: string

(hbad) HbAddress is the account this txn is proving onlineness for.

`Optional` hbChallengeDiscount

hbChallengeDiscount?: boolean

(hbc) HbChallengeDiscount requests the challenge fee discount, reducing the required fee by one min fee. It is a request, not an assertion: it is granted only if HbAddress is actually under challenge.

hbKeyDilution

hbKeyDilution: bigint

(hbkd) HbKeyDilution must match HbAddress account's current KeyDilution.

hbProof

hbProof: HbProofFields

(hbprf) HbProof is a signature using HeartbeatAddress's partkey, thereby showing it is online.

hbSeed

hbSeed: Uint8Array

(hbsd) HbSeed must be the block seed for the this transaction's firstValid block.

hbVoteId

hbVoteId: Uint8Array

(hbvid) HbVoteID must match the HbAddress account's current VoteID.

`Static` `Private` encodingSchemaValue

encodingSchemaValue: undefined | Schema

Accessors

`Static` encodingSchema

get encodingSchema(): Schema
Returns Schema
- Defined in client/v2/indexer/models/types.ts:8105

Methods

getEncodingSchema

getEncodingSchema(): Schema
Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.

Returns Schema
Implementation of Encodable.getEncodingSchema
- Defined in client/v2/indexer/models/types.ts:8208

toEncodingData

toEncodingData(): Map<string, unknown>
Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

Returns Map<string, unknown>
Implementation of Encodable.toEncodingData
- Defined in client/v2/indexer/models/types.ts:8212

`Static` fromEncodingData

fromEncodingData(data): TransactionHeartbeat
Parameters
- data: unknown
Returns TransactionHeartbeat
- Defined in client/v2/indexer/models/types.ts:8223

Class TransactionHeartbeat

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { hbAddress: string; hbChallengeDiscount?: boolean; hbKeyDilution: number | bigint; hbProof: HbProofFields; hbSeed: string | Uint8Array; hbVoteId: string | Uint8Array; }

hbAddress: string

Optional hbChallengeDiscount?: boolean

hbKeyDilution: number | bigint

hbProof: HbProofFields

hbSeed: string | Uint8Array

hbVoteId: string | Uint8Array

Returns TransactionHeartbeat

Properties

hbAddress

Optional hbChallengeDiscount

hbKeyDilution

hbProof

hbSeed

hbVoteId

Static Private encodingSchemaValue

Accessors

Static encodingSchema

Returns Schema

Methods

getEncodingSchema

Returns Schema

toEncodingData

Returns Map<string, unknown>

Static fromEncodingData

Parameters

data: unknown

Returns TransactionHeartbeat

Settings

Member Visibility

Theme

On This Page

__namedParameters: {
hbAddress: string;
hbChallengeDiscount?: boolean;
hbKeyDilution: number | bigint;
hbProof: HbProofFields;
hbSeed: string | Uint8Array;
hbVoteId: string | Uint8Array;
}

`Optional` hbChallengeDiscount?: boolean

`Optional` hbChallengeDiscount

`Static` `Private` encodingSchemaValue

`Static` encodingSchema

`Static` fromEncodingData