Class VoteStaple

constructor

• new VoteStaple(
      votesStapled: string | ArrayBuffer | Buffer | VoteStapleJSON,
      voteOptions?: VoteOptions,
  ): VoteStaple

  Construct a new staple from a message buffer

  Parameters

  • votesStapled: string | ArrayBuffer | Buffer | VoteStapleJSON
  • voteOptions: VoteOptions = {}

  Returns VoteStaple

StaticisInstance

StatictoJSONSerializablePrefix

Static ReadonlyVoteBlockHash

blocks

• get blocks(): Block[]

  Get the blocks for this staple

  Returns Block[]

blocksHash

• get blocksHash(): VoteBlockHash

  Get the hash of the blockhashes in the staple -- this is a stable ID for the staple regardless of which votes are included in the staple.

  Returns VoteBlockHash

hash

• get hash(): VoteStapleHash

  Hash of the Vote Staple -- this is the hash of the data in the canonical form of the staple, which may be different from the hash of the data passed into the this object.

  Returns VoteStapleHash

votes

• get votes(): Vote[]

  Get the votes for this staple

  Returns Vote[]

timestamp

• timestamp(
      preferRep?: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>,
  ): Date

  Get the timestamp of the staple

  This is the average of the timestamps of the votes, unless a particular account is specified then that timestamp is used if it issued a vote in the staple.

  Parameters

  • OptionalpreferRep: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>

  Returns Date

toBytes

• toBytes(uncompressed?: boolean): ArrayBuffer

  Get the serialized version

  Parameters

  • Optionaluncompressed: boolean

  Returns ArrayBuffer

toJSON

• toJSON(): { blocks: BlockJSONOutput[]; votes: VoteJSONOutput[] }

  Get the serialized version as JSON

  Returns { blocks: BlockJSONOutput[]; votes: VoteJSONOutput[] }

toString

• toString(): string

  Returns string

StaticfromJSON

• fromJSON(staple: VoteStapleJSON, voteOptions?: VoteOptions): VoteStaple

  Parameters

  • staple: VoteStapleJSON
  • voteOptions: VoteOptions = {}

  Returns VoteStaple

StaticfromVotesAndBlocks

• fromVotesAndBlocks(
      votes: Vote[],
      blocks: Block[],
      voteOptions?: VoteOptions,
  ): VoteStaple

  Construct a new staple from votes and blocks

  Parameters

  • votes: Vote[]
  • blocks: Block[]
  • voteOptions: VoteOptions = {}

  Returns VoteStaple

StaticfromVotesAndBlocksToHashMap

• fromVotesAndBlocksToHashMap(
      votes: PossiblyExpiredVote[],
      blocks: Block[],
      opts: VoteOptions & { voteBlockHashes?: VoteBlockHash[] },
  ): VoteBlockHashMap<null | VoteStaple>

  Parameters

  • votes: PossiblyExpiredVote[]
  • blocks: Block[]
  • opts: VoteOptions & { voteBlockHashes?: VoteBlockHash[] }

  Returns VoteBlockHashMap<null | VoteStaple>

StaticfromVotesAndBlocksWithFiltering

• fromVotesAndBlocksWithFiltering(
      votes: PossiblyExpiredVote[],
      blocks: Block[],
      opts: undefined | VoteOptions,
  ): null | VoteStaple

  Convert a list of Votes and Blocks into a VoteStaple This is slightly different from VoteStaple.fromVotesAndBlocks in that it will filter the supplied votes to only include those that are permanent if any permanent votes are present, otherwise only temporary votes will be included

  Additionally, it will filter out any votes that are expired

  Parameters

  • votes: PossiblyExpiredVote[]
  • blocks: Block[]
  • opts: undefined | VoteOptions

  Returns null | VoteStaple

StaticisValidJSON

• isValidJSON(staple: VoteStapleJSON): boolean

  Parameters

  • staple: VoteStapleJSON

  Returns boolean

StatictoJSONSerializable

• toJSONSerializable(
      value: VoteStaple,
      opts: ToJSONSerializableOptions,
  ): { $binary?: string; blocks: BlockJSONOutput[]; votes: VoteJSONOutput[] }

  Parameters

  • value: VoteStaple
  • opts: ToJSONSerializableOptions

  Returns { $binary?: string; blocks: BlockJSONOutput[]; votes: VoteJSONOutput[] }