Class PoolRegistration

This certificate is used to register a new stake pool. It includes various details about the pool such as the pledge, costs, margin, reward account, and the pool's owners and relays.

Hierarchy

PoolRegistration

Index

Constructors

Properties

#originalBytes #params

Methods

poolParameters setPoolParameters toCbor toCore fromCbor fromCore

Constructors

constructor

new PoolRegistration(params: Serialization.PoolParams): Serialization.PoolRegistration
Initializes a new instance of the PoolRegistration class.
Parameters
- params: Serialization.PoolParams
  
  The pool registration/update parameters.
Returns Serialization.PoolRegistration
- Defined in packages/core/src/Serialization/Certificates/PoolRegistration.ts:23

Properties

`Private` #originalBytes

#originalBytes: undefined | HexBlob = undefined

`Private` #params

#params: Serialization.PoolParams

Methods

poolParameters

poolParameters(): Serialization.PoolParams
Gets the pool parameters from this certificate.

Returns
The pool parameters.

Returns Serialization.PoolParams
- Defined in packages/core/src/Serialization/Certificates/PoolRegistration.ts:108

setPoolParameters

setPoolParameters(parameters: Serialization.PoolParams): void
Sets the pool parameters from this certificate.
Parameters
- parameters: Serialization.PoolParams
  
  The pool parameters.
Returns void
- Defined in packages/core/src/Serialization/Certificates/PoolRegistration.ts:117

toCbor

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

Returns
The PoolRegistration in CBOR format.

Returns HexBlob
- Defined in packages/core/src/Serialization/Certificates/PoolRegistration.ts:32

toCore

toCore(): Cardano.PoolRegistrationCertificate
Creates a Core PoolRegistrationCertificate object from the current PoolRegistration object.

Returns
The Core PoolRegistrationCertificate object.

Returns Cardano.PoolRegistrationCertificate
- Defined in packages/core/src/Serialization/Certificates/PoolRegistration.ts:87

`Static` fromCbor

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

Returns
The new PoolRegistration instance.
Parameters
- cbor: HexBlob
  
  The CBOR encoded PoolRegistration object.
Returns Serialization.PoolRegistration
- Defined in packages/core/src/Serialization/Certificates/PoolRegistration.ts:53

`Static` fromCore

fromCore(cert: Cardano.PoolRegistrationCertificate): Serialization.PoolRegistration
Creates a PoolRegistration object from the given Core PoolRegistrationCertificate object.
Parameters
- cert: Cardano.PoolRegistrationCertificate
  
  core PoolRegistrationCertificate object.
Returns Serialization.PoolRegistration
- Defined in packages/core/src/Serialization/Certificates/PoolRegistration.ts:99

Generated using TypeDoc