Class SingleHostAddr

This relay points to a single host via its ipv4/ipv6 address and a given port.

Hierarchy

SingleHostAddr

Index

Constructors

constructor

new SingleHostAddr(port?: number, ipv4?: string, ipv6?: string): Serialization.SingleHostAddr
Initializes a new instance of the SingleHostAddr relay.
Parameters
- Optional port: number
  
  The port of the relay.
- Optional ipv4: string
  
  The IP v4 address of the relay.
- Optional ipv6: string
  
  The IP v6 address of the relay.
Returns Serialization.SingleHostAddr
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostAddr.ts:23

Properties

`Private` #ipV4

#ipV4: undefined | string

`Private` #ipV6

#ipV6: undefined | string

`Private` #originalBytes

#originalBytes: undefined | HexBlob = undefined

`Private` #port

#port: undefined | number

Methods

ipv4

ipv4(): undefined | string
Gets the IP v4 address of the relay.

Returns
The IP v4 address.

Returns undefined | string
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostAddr.ts:155

ipv6

ipv6(): undefined | string
Gets the IP v6 address of the relay.

Returns
The IP v6 address.

Returns undefined | string
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostAddr.ts:174

port

port(): undefined | number
Gets the port of the relay.

Returns
The port (0-65535).

Returns undefined | number
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostAddr.ts:136

setIpv4

setIpv4(ipV4: undefined | string): void
Sets the IP v4 address of the relay.
Parameters
- ipV4: undefined | string
  
  The IP v4 address or undefined if it should not be set.
Returns void
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostAddr.ts:164

setIpv6

setIpv6(ipV6: undefined | string): void
Sets the IP v6 address of the relay.
Parameters
- ipV6: undefined | string
  
  The IP v6 address or undefined if it should not be set.
Returns void
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostAddr.ts:183

setPort

setPort(port: undefined | number): void
Sets the port of the relay.
Parameters
- port: undefined | number
  
  The port (0-65535) or undefined if it should not be set.
Returns void
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostAddr.ts:145

toCbor

toCbor(): HexBlob
Serializes a SingleHostAddr into CBOR format.

Returns
The SingleHostAddr in CBOR format.

Returns HexBlob
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostAddr.ts:34

toCore

toCore(): Cardano.RelayByAddress
Creates a Core RelayByAddress object from the current SingleHostAddr object.

Returns
The Core RelayByAddress object.

Returns Cardano.RelayByAddress
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostAddr.ts:113

`Static` fromCbor

fromCbor(cbor: HexBlob): Serialization.SingleHostAddr
Deserializes the SingleHostAddr from a CBOR byte array.

Returns
The new SingleHostAddr instance.
Parameters
- cbor: HexBlob
  
  The CBOR encoded SingleHostAddr object.
Returns Serialization.SingleHostAddr
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostAddr.ts:60

`Static` fromCore

fromCore(relay: Cardano.RelayByAddress): Serialization.SingleHostAddr
Creates a SingleHostAddr object from the given Core RelayByAddress object.
Parameters
- relay: Cardano.RelayByAddress
  
  The core RelayByAddress object.
Returns Serialization.SingleHostAddr
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostAddr.ts:127

Class SingleHostAddr

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional port: number

Optional ipv4: string

Optional ipv6: string

Returns Serialization.SingleHostAddr

Properties

Private #ipV4

Private #ipV6

Private #originalBytes

Private #port

Methods

ipv4

Returns

Returns undefined | string

ipv6

Returns

Returns undefined | string

port

Returns

Returns undefined | number

setIpv4

Parameters

ipV4: undefined | string

Returns void

setIpv6

Parameters

ipV6: undefined | string

Returns void

setPort

Parameters

port: undefined | number

Returns void

toCbor

Returns

Returns HexBlob

toCore

Returns

Returns Cardano.RelayByAddress

Static fromCbor

Returns

Parameters

cbor: HexBlob

Returns Serialization.SingleHostAddr

Static fromCore

Parameters

relay: Cardano.RelayByAddress

Returns Serialization.SingleHostAddr

Settings

Member Visibility

Theme

`Optional` port: number

`Optional` ipv4: string

`Optional` ipv6: string

`Private` #ipV4

`Private` #ipV6

`Private` #originalBytes

`Private` #port

`Static` fromCbor

`Static` fromCore