ResponseMetadata

@iota/grpc

---

@iota/grpc / ResponseMetadata

Type Alias: ResponseMetadata

ResponseMetadata = object

Defined in: sdk/grpc/src/metadata.ts:17

The x-iota-* headers every response carries. A field is unset when its header is missing or malformed.

Properties

chain?

optional chain?: string

Defined in: sdk/grpc/src/metadata.ts:21

Chain name, such as mainnet.

---

chainId?

optional chainId?: string

Defined in: sdk/grpc/src/metadata.ts:19

Base58 digest identifying the chain.

---

checkpointHeight?

optional checkpointHeight?: bigint

Defined in: sdk/grpc/src/metadata.ts:25

Current checkpoint height.

---

epoch?

optional epoch?: bigint

Defined in: sdk/grpc/src/metadata.ts:23

Current epoch.

---

lowestAvailableCheckpoint?

optional lowestAvailableCheckpoint?: bigint

Defined in: sdk/grpc/src/metadata.ts:31

Lowest checkpoint whose checkpoints, transactions, effects and events can still be read.

---

lowestAvailableCheckpointObjects?

optional lowestAvailableCheckpointObjects?: bigint

Defined in: sdk/grpc/src/metadata.ts:33

Lowest checkpoint whose input and output objects can still be read.

---

serverVersion?

optional serverVersion?: string

Defined in: sdk/grpc/src/metadata.ts:35

Server version, such as iota-node/1.32.1.

---

timestamp?

optional timestamp?: string

Defined in: sdk/grpc/src/metadata.ts:29

Current chain time, as RFC 3339.

---

timestampMs?

optional timestampMs?: bigint

Defined in: sdk/grpc/src/metadata.ts:27

Current chain time, in milliseconds since the Unix epoch.