Class SingleHostName

This relay points to a single host via a DNS (pointing to an A or AAAA DNS record) name and a given port.

Hierarchy

SingleHostName

Index

Constructors

Properties

#dnsName #originalBytes #port

Methods

dnsName port setDnsName setPort toCbor toCore fromCbor fromCore

Constructors

constructor

new SingleHostName(dnsName: string, port?: number): Serialization.SingleHostName
Initializes a new instance of the SingleHostName relay.
Parameters
- dnsName: string
  
  The DNS name of the relay (pointing to an A or AAAA DNS record).
- Optional port: number
  
  The port of the relay.
Returns Serialization.SingleHostName
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostName.ts:21

Properties

`Private` #dnsName

#dnsName: string

`Private` #originalBytes

#originalBytes: undefined | HexBlob = undefined

`Private` #port

#port: undefined | number

Methods

dnsName

dnsName(): string
Gets the DNS name of the relay.

Returns
The DNS name of the relay (pointing to an A or AAAA DNS record).

Returns string
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostName.ts:142

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/SingleHostName.ts:123

setDnsName

setDnsName(dnsName: string): void
Sets DNS name of the relay.
Parameters
- dnsName: string
  
  The DNS name of the relay (pointing to an A or AAAA DNS record).
Returns void
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostName.ts:151

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/SingleHostName.ts:132

toCbor

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

Returns
The SingleHostName in CBOR format.

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

toCore

toCore(): Cardano.RelayByName
Creates a Core RelayByName object from the current SingleHostName object.

Returns
The Core RelayByName object.

Returns Cardano.RelayByName
- Defined in packages/core/src/Serialization/Certificates/PoolParams/Relay/SingleHostName.ts:101

`Static` fromCbor

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

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

`Static` fromCore

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

Generated using TypeDoc