Class Vote

A vote is a certificate issued indicating that the issuer "vouches" for the blocks specified will fit into the ledger of the operator/issuer.

Hierarchy (View Summary)

PossiblyExpiredVote
- Vote

Index

Constructors

constructor

new Vote(
    vote:
        | string
        | Buffer
        | ArrayBuffer
        | VoteJSON
        | Vote
        | PossiblyExpiredVote
        | {
            $binary?: string;
            $id: string;
            $permanent: boolean;
            $trusted: boolean;
            $uid: string;
            blocks: BlockHashString[];
            issuer: | Secp256K1PublicKeyString
            | Secp256R1PublicKeyString
            | ED25519PublicKeyString;
            serial: string;
            signature: string;
            validityFrom: string;
            validityTo: string;
        },
    options?: VoteOptions,
): Vote
Parameters
- vote:
      | string
      | Buffer
      | ArrayBuffer
      | VoteJSON
      | Vote
      | PossiblyExpiredVote
      | {
          $binary?: string;
          $id: string;
          $permanent: boolean;
          $trusted: boolean;
          $uid: string;
          blocks: BlockHashString[];
          issuer: | Secp256K1PublicKeyString
          | Secp256R1PublicKeyString
          | ED25519PublicKeyString;
          serial: string;
          signature: string;
          validityFrom: string;
          validityTo: string;
      }
- options: VoteOptions = {}
Returns Vote
Overrides PossiblyExpiredVote.constructor

Properties

`Readonly`$id

$id: string

`Readonly`$permanent

$permanent: boolean = false

`Readonly`$trusted

$trusted: boolean = false

`Readonly`$uid

$uid: string

`Readonly`blocks

blocks: BlockHash[]

`Readonly`issuer

issuer: Account

`Readonly`possiblyExpired

possiblyExpired: false

`Readonly`serial

serial: bigint

`Readonly`signature

signature: ArrayBuffer

`Readonly`validityFrom

validityFrom: Date

`Readonly`validityTo

validityTo: Date

`Protected` `Static`allowedSlop

allowedSlop: number = ...

`Static`Builder

Builder: typeof VoteBuilder

`Static`isInstance

isInstance: (obj: any, strict?: boolean) => obj is Vote = ...

`Protected` `Static`permanentVoteThreshold

permanentVoteThreshold: number = ...

`Static`Staple

Staple: typeof VoteStaple

`Static` `Readonly`VoteBlocksHash

VoteBlocksHash: typeof VoteBlockHash = VoteBlockHash

Accessors

blocksHash

get blocksHash(): VoteBlockHash
Returns VoteBlockHash
Inherited from PossiblyExpiredVote.blocksHash

expired

get expired(): boolean
Returns boolean
Inherited from PossiblyExpiredVote.expired

hash

get hash(): VoteHash
Returns VoteHash
Inherited from PossiblyExpiredVote.hash

Methods

`Protected`expirationCheckMoment

expirationCheckMoment(): number
Returns number
Inherited from PossiblyExpiredVote.expirationCheckMoment

toBytes

toBytes(): ArrayBuffer
Returns ArrayBuffer
Inherited from PossiblyExpiredVote.toBytes

toJSON

toJSON(
    options?: ToJSONSerializableOptions<boolean>,
): {
    $binary?: string;
    $id: string;
    $permanent: boolean;
    $trusted: boolean;
    $uid: string;
    blocks: BlockHash[];
    issuer: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>;
    serial: bigint;
    signature: ArrayBuffer;
    validityFrom: Date;
    validityTo: Date;
}
Parameters
- Optionaloptions: ToJSONSerializableOptions<boolean>
Returns {
    $binary?: string;
    $id: string;
    $permanent: boolean;
    $trusted: boolean;
    $uid: string;
    blocks: BlockHash[];
    issuer: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>;
    serial: bigint;
    signature: ArrayBuffer;
    validityFrom: Date;
    validityTo: Date;
}
Inherited from PossiblyExpiredVote.toJSON

toString

toString(): string
Returns string
Inherited from PossiblyExpiredVote.toString

`Static`fromJSON

fromJSON(
    voteJSON:
        | VoteJSON
        | {
            $binary?: string;
            $id: string;
            $permanent: boolean;
            $trusted: boolean;
            $uid: string;
            blocks: BlockHashString[];
            issuer: | Secp256K1PublicKeyString
            | Secp256R1PublicKeyString
            | ED25519PublicKeyString;
            serial: string;
            signature: string;
            validityFrom: string;
            validityTo: string;
        },
    options?: VoteOptions,
): Vote | PossiblyExpiredVote
Parameters
- voteJSON:
      | VoteJSON
      | {
          $binary?: string;
          $id: string;
          $permanent: boolean;
          $trusted: boolean;
          $uid: string;
          blocks: BlockHashString[];
          issuer: | Secp256K1PublicKeyString
          | Secp256R1PublicKeyString
          | ED25519PublicKeyString;
          serial: string;
          signature: string;
          validityFrom: string;
          validityTo: string;
      }
- options: VoteOptions = {}
Returns Vote | PossiblyExpiredVote
Inherited from PossiblyExpiredVote.fromJSON

`Static`isValidJSON

isValidJSON(
    voteJSON:
        | VoteJSON
        | {
            $binary?: string;
            $id: string;
            $permanent: boolean;
            $trusted: boolean;
            $uid: string;
            blocks: BlockHashString[];
            issuer: | Secp256K1PublicKeyString
            | Secp256R1PublicKeyString
            | ED25519PublicKeyString;
            serial: string;
            signature: string;
            validityFrom: string;
            validityTo: string;
        },
): voteJSON is | VoteJSON
| {
    $binary?: string;
    $id: string;
    $permanent: boolean;
    $trusted: boolean;
    $uid: string;
    blocks: BlockHashString[];
    issuer: | Secp256K1PublicKeyString
    | Secp256R1PublicKeyString
    | ED25519PublicKeyString;
    serial: string;
    signature: string;
    validityFrom: string;
    validityTo: string;
}
Parameters
- voteJSON:
      | VoteJSON
      | {
          $binary?: string;
          $id: string;
          $permanent: boolean;
          $trusted: boolean;
          $uid: string;
          blocks: BlockHashString[];
          issuer: | Secp256K1PublicKeyString
          | Secp256R1PublicKeyString
          | ED25519PublicKeyString;
          serial: string;
          signature: string;
          validityFrom: string;
          validityTo: string;
      }
Returns voteJSON is
    | VoteJSON
    | {
        $binary?: string;
        $id: string;
        $permanent: boolean;
        $trusted: boolean;
        $uid: string;
        blocks: BlockHashString[];
        issuer: | Secp256K1PublicKeyString
        | Secp256R1PublicKeyString
        | ED25519PublicKeyString;
        serial: string;
        signature: string;
        validityFrom: string;
        validityTo: string;
    }
Inherited from PossiblyExpiredVote.isValidJSON

Class Vote

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Vote

Properties

Readonly$id

Readonly$permanent

Readonly$trusted

Readonly$uid

Readonlyblocks

Readonlyissuer

ReadonlypossiblyExpired

Readonlyserial

Readonlysignature

ReadonlyvalidityFrom

ReadonlyvalidityTo

Protected StaticallowedSlop

StaticBuilder

StaticisInstance

Protected StaticpermanentVoteThreshold

StaticStaple

Static ReadonlyVoteBlocksHash

Accessors

blocksHash

Returns VoteBlockHash

expired

Returns boolean

hash

Returns VoteHash

Methods

ProtectedexpirationCheckMoment

Returns number

toBytes

Returns ArrayBuffer

toJSON

Parameters

Returns { $binary?: string; $id: string; $permanent: boolean; $trusted: boolean; $uid: string; blocks: BlockHash[]; issuer: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>; serial: bigint; signature: ArrayBuffer; validityFrom: Date; validityTo: Date;}

toString

Returns string

StaticfromJSON

Parameters

Returns Vote | PossiblyExpiredVote

StaticisValidJSON

Parameters

Settings

On This Page

`Readonly`$id

`Readonly`$permanent

`Readonly`$trusted

`Readonly`$uid

`Readonly`blocks

`Readonly`issuer

`Readonly`possiblyExpired

`Readonly`serial

`Readonly`signature

`Readonly`validityFrom

`Readonly`validityTo

`Protected` `Static`allowedSlop

`Static`Builder

`Static`isInstance

`Protected` `Static`permanentVoteThreshold

`Static`Staple

`Static` `Readonly`VoteBlocksHash

`Protected`expirationCheckMoment

Returns {
$binary?: string;
$id: string;
$permanent: boolean;
$trusted: boolean;
$uid: string;
blocks: BlockHash[];
issuer: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>;
serial: bigint;
signature: ArrayBuffer;
validityFrom: Date;
validityTo: Date;
}

`Static`fromJSON

`Static`isValidJSON