Class VoteStaple

Static ReadonlyVoteBlockHash

blocks

• get blocks(): Block[]

  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

touchedAccounts

• get touchedAccounts(): InstanceSet<Account<AccountKeyAlgorithm>>

  Returns InstanceSet<Account<AccountKeyAlgorithm>>

timestamp

• timestamp(preferRep?: Account<KeyPairKeyAlgorithm>): 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<KeyPairKeyAlgorithm>

  Returns Date

toBytes

• toBytes(uncompressed?: boolean): ArrayBuffer

  Get the serialized version

  Parameters

  • Optionaluncompressed: boolean

  Returns ArrayBuffer

toJSON

• toJSON(
      options?: ToJSONSerializableOptions<boolean>,
  ): {
      $binary?: string;
      blocks: (
          {
              $hash: BlockHashString;
              $opening: boolean;
              account: | TokenPublicKeyString
              | NetworkPublicKeyString
              | StoragePublicKeyString
              | MultisigPublicKeyString
              | Secp256K1PublicKeyString
              | Secp256R1PublicKeyString
              | ED25519PublicKeyString;
              date: string;
              network: string;
              operations: (
                  | {
                      amount: string;
                      to: string;
                      token: TokenPublicKeyString;
                      type: SEND;
                  } & { external?: string }
                  | { to: string; type: SET_REP } & {}
                  | {
                      description: string;
                      metadata: string;
                      name: string;
                      type: SET_INFO;
                  } & {
                      defaultPermission?: | false
                      | [string, number[]]
                      | [string, string]
                      | [number[] | BaseFlagNames, number[]];
                  }
                  | {
                      method: AdjustMethod;
                      permissions: | null
                      | false
                      | [string, number[]]
                      | [string, string]
                      | [number[] | BaseFlagNames, number[]];
                      principal: string;
                      type: MODIFY_PERMISSIONS;
                  } & { target?: string }
                  | { identifier: string; type: CREATE_IDENTIFIER } & {
                      createArguments?:
                          | {
                              quorum: string;
                              signers: (
                                  | MultisigPublicKeyString
                                  | Secp256K1PublicKeyString
                                  | Secp256R1PublicKeyString
                                  | ED25519PublicKeyString
                              )[];
                              type: MULTISIG;
                          } & {}
                          | {
                              quorum: string;
                              signers: (
                                  | MultisigPublicKeyString
                                  | Secp256K1PublicKeyString
                                  | Secp256R1PublicKeyString
                                  | ED25519PublicKeyString
                              )[];
                              type: MULTISIG;
                          } & {};
                  }
                  | { amount: string; method: ADD
                  | SUBTRACT; type: TOKEN_ADMIN_SUPPLY } & {}
                  | {
                      amount: string;
                      method: AdjustMethod;
                      token: TokenPublicKeyString;
                      type: TOKEN_ADMIN_MODIFY_BALANCE;
                  } & {}
                  | {
                      amount: string;
                      from: string;
                      token: TokenPublicKeyString;
                      type: RECEIVE;
                  } & { exact?: boolean; forward?: string }
                  | {
                      certificateOrHash:
                          | string
                          | CertificateHashString
                          | {
                              $hash: CertificateHashString;
                              issuer: string;
                              issuerDN: { name: string; value: string }[];
                              notAfter: string;
                              notBefore: string;
                              serial: string;
                              subject: string;
                              subjectDN: { name: string; value: string }[];
                              subjectPublicKey:
                                  | Secp256K1PublicKeyString
                                  | Secp256R1PublicKeyString
                                  | ED25519PublicKeyString;
                          } & {
                              $binary?: string;
                              $chain?: undefined;
                              baseExtensions?: {} & {
                                  authorityKeyIdentifier?: {
                                      contains: string;
                                      type: "context";
                                      value: 0;
                                  } & {};
                                  basicConstraints?: [ca: boolean, pathLenConstraint?: null | string];
                                  keyUsage?: KeyUsage;
                                  subjectKeyIdentifier?: string;
                              };
                          }
                          | {
                              $hash: CertificateHashString;
                              issuer: string;
                              issuerDN: { name: string; value: string }[];
                              notAfter: string;
                              notBefore: string;
                              serial: string;
                              subject: string;
                              subjectDN: { name: string; value: string }[];
                              subjectPublicKey:
                                  | Secp256K1PublicKeyString
                                  | Secp256R1PublicKeyString
                                  | ED25519PublicKeyString;
                          } & {
                              $binary?: string;
                              $chain?: undefined;
                              baseExtensions?: {} & {
                                  authorityKeyIdentifier?: {
                                      contains: string;
                                      type: "context";
                                      value: 0;
                                  } & {};
                                  basicConstraints?: [ca: boolean, pathLenConstraint?: null | string];
                                  keyUsage?: KeyUsage;
                                  subjectKeyIdentifier?: string;
                              };
                          };
                      method: ADD
                      | SUBTRACT;
                      type: MANAGE_CERTIFICATE;
                  } & {
                      intermediateCertificates?: | null
                      | string
                      | { certificates: string[] };
                  }
              )[];
              previous: BlockHashString;
              purpose: BlockPurpose;
              signer: | Secp256K1PublicKeyString
              | Secp256R1PublicKeyString
              | ED25519PublicKeyString
              | [
                  MultisigPublicKeyString,
                  (
                      Secp256K1PublicKeyString | Secp256R1PublicKeyString | ED25519PublicKeyString | [MultisigPublicKeyString, (Secp256K1PublicKeyString | ... 2 more ... | [...])[]]
                  )[],
              ];
              version: 1
              | 2;
          } & {
              $binary?: string;
              idempotent?: string;
              signature?: string;
              signatures?: string[];
              subnet?: string;
          }
      )[];
      votes: (
          {
              $id: string;
              $permanent: boolean;
              $trusted: boolean;
              $uid: string;
              blocks: BlockHashString[];
              issuer: | Secp256K1PublicKeyString
              | Secp256R1PublicKeyString
              | ED25519PublicKeyString;
              serial: string;
              signature: string;
              validityFrom: string;
              validityTo: string;
          } & {
              $binary?: string;
              fee?: | { amount: string } & { payTo?: string; token?: string }
              | ({ amount: string } & { payTo?: string; token?: string })[];
              quote?: boolean;
          }
      )[];
  }

  Parameters

  • Optionaloptions: ToJSONSerializableOptions<boolean>

  Returns {
      $binary?: string;
      blocks: (
          {
              $hash: BlockHashString;
              $opening: boolean;
              account: | TokenPublicKeyString
              | NetworkPublicKeyString
              | StoragePublicKeyString
              | MultisigPublicKeyString
              | Secp256K1PublicKeyString
              | Secp256R1PublicKeyString
              | ED25519PublicKeyString;
              date: string;
              network: string;
              operations: (
                  | {
                      amount: string;
                      to: string;
                      token: TokenPublicKeyString;
                      type: SEND;
                  } & { external?: string }
                  | { to: string; type: SET_REP } & {}
                  | {
                      description: string;
                      metadata: string;
                      name: string;
                      type: SET_INFO;
                  } & {
                      defaultPermission?: | false
                      | [string, number[]]
                      | [string, string]
                      | [number[] | BaseFlagNames, number[]];
                  }
                  | {
                      method: AdjustMethod;
                      permissions: | null
                      | false
                      | [string, number[]]
                      | [string, string]
                      | [number[] | BaseFlagNames, number[]];
                      principal: string;
                      type: MODIFY_PERMISSIONS;
                  } & { target?: string }
                  | { identifier: string; type: CREATE_IDENTIFIER } & {
                      createArguments?:
                          | {
                              quorum: string;
                              signers: (
                                  | MultisigPublicKeyString
                                  | Secp256K1PublicKeyString
                                  | Secp256R1PublicKeyString
                                  | ED25519PublicKeyString
                              )[];
                              type: MULTISIG;
                          } & {}
                          | {
                              quorum: string;
                              signers: (
                                  | MultisigPublicKeyString
                                  | Secp256K1PublicKeyString
                                  | Secp256R1PublicKeyString
                                  | ED25519PublicKeyString
                              )[];
                              type: MULTISIG;
                          } & {};
                  }
                  | { amount: string; method: ADD
                  | SUBTRACT; type: TOKEN_ADMIN_SUPPLY } & {}
                  | {
                      amount: string;
                      method: AdjustMethod;
                      token: TokenPublicKeyString;
                      type: TOKEN_ADMIN_MODIFY_BALANCE;
                  } & {}
                  | {
                      amount: string;
                      from: string;
                      token: TokenPublicKeyString;
                      type: RECEIVE;
                  } & { exact?: boolean; forward?: string }
                  | {
                      certificateOrHash:
                          | string
                          | CertificateHashString
                          | {
                              $hash: CertificateHashString;
                              issuer: string;
                              issuerDN: { name: string; value: string }[];
                              notAfter: string;
                              notBefore: string;
                              serial: string;
                              subject: string;
                              subjectDN: { name: string; value: string }[];
                              subjectPublicKey:
                                  | Secp256K1PublicKeyString
                                  | Secp256R1PublicKeyString
                                  | ED25519PublicKeyString;
                          } & {
                              $binary?: string;
                              $chain?: undefined;
                              baseExtensions?: {} & {
                                  authorityKeyIdentifier?: {
                                      contains: string;
                                      type: "context";
                                      value: 0;
                                  } & {};
                                  basicConstraints?: [ca: boolean, pathLenConstraint?: null | string];
                                  keyUsage?: KeyUsage;
                                  subjectKeyIdentifier?: string;
                              };
                          }
                          | {
                              $hash: CertificateHashString;
                              issuer: string;
                              issuerDN: { name: string; value: string }[];
                              notAfter: string;
                              notBefore: string;
                              serial: string;
                              subject: string;
                              subjectDN: { name: string; value: string }[];
                              subjectPublicKey:
                                  | Secp256K1PublicKeyString
                                  | Secp256R1PublicKeyString
                                  | ED25519PublicKeyString;
                          } & {
                              $binary?: string;
                              $chain?: undefined;
                              baseExtensions?: {} & {
                                  authorityKeyIdentifier?: {
                                      contains: string;
                                      type: "context";
                                      value: 0;
                                  } & {};
                                  basicConstraints?: [ca: boolean, pathLenConstraint?: null | string];
                                  keyUsage?: KeyUsage;
                                  subjectKeyIdentifier?: string;
                              };
                          };
                      method: ADD
                      | SUBTRACT;
                      type: MANAGE_CERTIFICATE;
                  } & {
                      intermediateCertificates?: | null
                      | string
                      | { certificates: string[] };
                  }
              )[];
              previous: BlockHashString;
              purpose: BlockPurpose;
              signer: | Secp256K1PublicKeyString
              | Secp256R1PublicKeyString
              | ED25519PublicKeyString
              | [
                  MultisigPublicKeyString,
                  (
                      Secp256K1PublicKeyString | Secp256R1PublicKeyString | ED25519PublicKeyString | [MultisigPublicKeyString, (Secp256K1PublicKeyString | ... 2 more ... | [...])[]]
                  )[],
              ];
              version: 1
              | 2;
          } & {
              $binary?: string;
              idempotent?: string;
              signature?: string;
              signatures?: string[];
              subnet?: string;
          }
      )[];
      votes: (
          {
              $id: string;
              $permanent: boolean;
              $trusted: boolean;
              $uid: string;
              blocks: BlockHashString[];
              issuer: | Secp256K1PublicKeyString
              | Secp256R1PublicKeyString
              | ED25519PublicKeyString;
              serial: string;
              signature: string;
              validityFrom: string;
              validityTo: string;
          } & {
              $binary?: string;
              fee?: | { amount: string } & { payTo?: string; token?: string }
              | ({ amount: string } & { payTo?: string; token?: string })[];
              quote?: boolean;
          }
      )[];
  }

toString

• toString(): string

  Returns string

StaticfromJSON

• fromJSON<T extends VoteBlockBundle>(
      this: VoteBundleConstructor<T>,
      staple: VoteStapleJSON,
      voteOptions?: VoteOptions,
  ): T

  Type Parameters

  • T extends VoteBlockBundle

  Parameters

  • this: VoteBundleConstructor<T>
  • staple: VoteStapleJSON
  • voteOptions: VoteOptions = {}

  Returns T

StaticfromVotesAndBlocks

• fromVotesAndBlocks<T extends VoteBlockBundle>(
      this: VoteBundleConstructor<T>,
      votes: Vote[],
      blocks: Block[],
      voteOptions?: VoteOptions,
  ): T

  Construct a new vote bundle from votes and blocks

  Type Parameters

  • T extends VoteBlockBundle

  Parameters

  • this: VoteBundleConstructor<T>
  • votes: Vote[]
  • blocks: Block[]
  • voteOptions: VoteOptions = {}

  Returns T

StaticfromVotesAndBlocksToHashMap

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

  Type Parameters

  • T extends VoteBlockBundle

  Parameters

  • this: VoteBundleConstructor<T>
  • votes: PossiblyExpiredVote[]
  • blocks: Block[]
  • opts: VoteOptions & { voteBlockHashes?: VoteBlockHash[] }

  Returns VoteBlockHashMap<null | T>

StaticfromVotesAndBlocksWithFiltering

• fromVotesAndBlocksWithFiltering<T extends VoteBlockBundle>(
      this: VoteBundleConstructor<T>,
      votes: PossiblyExpiredVote[],
      blocks: Block[],
      opts: undefined | VoteOptions,
  ): null | T

  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

  Type Parameters

  • T extends VoteBlockBundle

  Parameters

  • this: VoteBundleConstructor<T>
  • votes: PossiblyExpiredVote[]
  • blocks: Block[]
  • opts: undefined | VoteOptions

  Returns null | T

StaticisValidJSON

• isValidJSON(staple: VoteStapleJSON): boolean

  Parameters

  • staple: VoteStapleJSON

  Returns boolean