Class VotingProcedure

A voting procedure is a pair of:

a vote.
an anchor, it links the vote to arbitrary off-chain JSON payload of metadata.

Hierarchy

VotingProcedure

Index

Constructors

Properties

#anchor #originalBytes #vote

Methods

anchor setAnchor setVote toCbor toCore vote fromCbor fromCore

Constructors

constructor

new VotingProcedure(vote: Cardano.Vote, anchor?: Serialization.Anchor): Serialization.VotingProcedure
Initialize a new instance of the VotingProcedure class.
Parameters
- vote: Cardano.Vote
  
  The vote (Yes, No or Abstain).
- Optional anchor: Serialization.Anchor
  
  The vote anchor (or undefined if none).
Returns Serialization.VotingProcedure
- Defined in packages/core/src/Serialization/TransactionBody/VotingProcedures/VotingProcedure.ts:27

Properties

`Private` #anchor

#anchor: undefined | Serialization.Anchor

`Private` #originalBytes

#originalBytes: undefined | HexBlob = undefined

`Private` #vote

#vote: Cardano.Vote

Methods

anchor

anchor(): undefined | Serialization.Anchor
Gets the anchor, a link to arbitrary off-chain JSON payload of metadata.

Returns
The anchor.

Returns undefined | Serialization.Anchor
- Defined in packages/core/src/Serialization/TransactionBody/VotingProcedures/VotingProcedure.ts:128

setAnchor

setAnchor(anchor: undefined | Serialization.Anchor): void
Sets the anchor, a link to arbitrary off-chain JSON payload of metadata.
Parameters
- anchor: undefined | Serialization.Anchor
  
  The anchor.
Returns void
- Defined in packages/core/src/Serialization/TransactionBody/VotingProcedures/VotingProcedure.ts:137

setVote

setVote(vote: Cardano.Vote): void
Sets the vote.
Parameters
- vote: Cardano.Vote
  
  The vote.
Returns void
- Defined in packages/core/src/Serialization/TransactionBody/VotingProcedures/VotingProcedure.ts:118

toCbor

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

Returns
The VotingProcedure in CBOR format.

Returns HexBlob
- Defined in packages/core/src/Serialization/TransactionBody/VotingProcedures/VotingProcedure.ts:37

toCore

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

Returns
The Core VotingProcedure object.

Returns Cardano.VotingProcedure
- Defined in packages/core/src/Serialization/TransactionBody/VotingProcedures/VotingProcedure.ts:85

vote

vote(): Cardano.Vote
Gets the vote.

Returns
The vote.

Returns Cardano.Vote
- Defined in packages/core/src/Serialization/TransactionBody/VotingProcedures/VotingProcedure.ts:109

`Static` fromCbor

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

Returns
The new VotingProcedure instance.
Parameters
- cbor: HexBlob
  
  The CBOR encoded VotingProcedure object.
Returns Serialization.VotingProcedure
- Defined in packages/core/src/Serialization/TransactionBody/VotingProcedures/VotingProcedure.ts:60

`Static` fromCore

fromCore(votingProcedure: Cardano.VotingProcedure): Serialization.VotingProcedure
Creates a VotingProcedure object from the given Core VotingProcedure object.
Parameters
- votingProcedure: Cardano.VotingProcedure
  
  The core VotingProcedure object.
Returns Serialization.VotingProcedure
- Defined in packages/core/src/Serialization/TransactionBody/VotingProcedures/VotingProcedure.ts:97

Generated using TypeDoc