Class Block

Block: An item which contains a number of operations (transactions) which originated from an account at a particular instant

Implements

BlockCanonical

Index

Constructors

constructor

new Block(
    input:
        | string
        | Buffer
        | ArrayBuffer
        | BlockJSON
        | Block
        | {
            $binary?: string;
            $hash: BlockHashString;
            $opening: boolean;
            account: | TokenPublicKeyString
            | NetworkPublicKeyString
            | StoragePublicKeyString
            | MultisigPublicKeyString
            | Secp256K1PublicKeyString
            | Secp256R1PublicKeyString
            | ED25519PublicKeyString;
            date: string;
            network: string;
            operations: ExportedJSONOperation[];
            previous: BlockHashString;
            signature: string;
            signer: | Secp256K1PublicKeyString
            | Secp256R1PublicKeyString
            | ED25519PublicKeyString;
            subnet: undefined
            | string;
            version: 1;
        },
): Block
Parameters
- input:
      | string
      | Buffer
      | ArrayBuffer
      | BlockJSON
      | Block
      | {
          $binary?: string;
          $hash: BlockHashString;
          $opening: boolean;
          account: | TokenPublicKeyString
          | NetworkPublicKeyString
          | StoragePublicKeyString
          | MultisigPublicKeyString
          | Secp256K1PublicKeyString
          | Secp256R1PublicKeyString
          | ED25519PublicKeyString;
          date: string;
          network: string;
          operations: ExportedJSONOperation[];
          previous: BlockHashString;
          signature: string;
          signer: | Secp256K1PublicKeyString
          | Secp256R1PublicKeyString
          | ED25519PublicKeyString;
          subnet: undefined
          | string;
          version: 1;
      }
Returns Block

Properties

`Readonly`$opening

$opening: boolean = false

`Readonly`$signatureValid

$signatureValid: boolean = true

`Readonly`account

account: GenericAccount

`Readonly`date

date: Date

`Readonly`network

network: bigint

`Readonly`operations

operations: BlockOperations[]

`Readonly`previous

previous: BlockHash

`Readonly`signature

signature: Buffer

`Readonly`signer

signer: Account

`Readonly`subnet

subnet: undefined | bigint

`Readonly`version

version: 1

`Static`AdjustMethod

AdjustMethod: typeof AdjustMethod = AdjustMethod

`Static`Builder

Builder: typeof BlockBuilder

`Static`Hash

Hash: typeof BlockHash = BlockHash

`Static`isInstance

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

`Static`NO_PREVIOUS

NO_PREVIOUS: string = NO_PREVIOUS

`Static`Operation

Operation: {
    CREATE_IDENTIFIER: typeof BlockOperationCREATE_IDENTIFIER;
    MANAGE_CERTIFICATE: typeof BlockOperationMANAGE_CERTIFICATE;
    MODIFY_PERMISSIONS: typeof BlockOperationMODIFY_PERMISSIONS;
    RECEIVE: typeof BlockOperationRECEIVE;
    SEND: typeof BlockOperationSEND;
    SET_INFO: typeof BlockOperationSET_INFO;
    SET_REP: typeof BlockOperationSET_REP;
    TOKEN_ADMIN_MODIFY_BALANCE: typeof BlockOperationTOKEN_ADMIN_MODIFY_BALANCE;
    TOKEN_ADMIN_SUPPLY: typeof BlockOperationTOKEN_ADMIN_SUPPLY;
} = Operations.Operation

`Static`OperationType

OperationType: typeof OperationType = Operations.OperationType

Accessors

hash

get hash(): BlockHash
Hash of the block minus the signature

XXX:TODO: Should the hash of the block normally include the signature ? One reason against is that it would allow for identical blocks that only differ by signature (which isn't signed)

Returns BlockHash

Methods

toBytes

toBytes(includeSignature?: boolean): ArrayBuffer
Parameters
- includeSignature: boolean = true
Returns ArrayBuffer

toJSON

toJSON(
    options?: ToJSONSerializableOptions<boolean>,
): {
    $binary?: string;
    $hash: BlockHash;
    $opening: boolean;
    account: GenericAccount;
    date: Date;
    network: bigint;
    operations: ExportedJSONOperation[];
    previous: BlockHash;
    signature: string;
    signer: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>;
    subnet: undefined | bigint;
    version: 1;
}
Parameters
- Optionaloptions: ToJSONSerializableOptions<boolean>
Returns {
    $binary?: string;
    $hash: BlockHash;
    $opening: boolean;
    account: GenericAccount;
    date: Date;
    network: bigint;
    operations: ExportedJSONOperation[];
    previous: BlockHash;
    signature: string;
    signer: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>;
    subnet: undefined | bigint;
    version: 1;
}

`Static`fromUnsignedJSON

fromUnsignedJSON(input: BlockUnsignedCanonical): Promise<Block>
Parameters
- input: BlockUnsignedCanonical
Returns Promise<Block>

`Static`getAccountOpeningHash

getAccountOpeningHash(account: GenericAccount): BlockHash
Parameters
- account: GenericAccount
Returns BlockHash

`Protected` `Static`getASN1ContainerWithoutSignature

getASN1ContainerWithoutSignature(
    input: BlockCanonical | BlockUnsignedCanonical,
): [
    0n,
    bigint,
    null
    | bigint,
    Omit<ASN1Date, "kind"> & { kind: "general" },
    Buffer,
    null | Buffer,
    Buffer,
    (
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [bigint, bigint];
            kind: "explicit";
            value: TOKEN_ADMIN_SUPPLY;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [Buffer, bigint, bigint];
            kind: "explicit";
            value: TOKEN_ADMIN_MODIFY_BALANCE;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [bigint, Buffer, undefined | null | Buffer[]];
            kind: "explicit";
            value: MANAGE_CERTIFICATE;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [
                Buffer,
                bigint,
                Buffer,
                undefined
                | Omit<ASN1String, "kind"> & { kind: "utf8" },
            ];
            kind: "explicit";
            value: SEND;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [Buffer];
            kind: "explicit";
            value: SET_REP;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [
                Omit<ASN1String, "kind"> & { kind: "utf8" },
                Omit<ASN1String, "kind"> & { kind: "utf8" },
                Omit<ASN1String, "kind"> & { kind: "utf8" },
                undefined | [bigint, bigint],
            ];
            kind: "explicit";
            value: SET_INFO;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [
                Buffer,
                bigint,
                null
                | [bigint, bigint],
                undefined | Buffer,
            ];
            kind: "explicit";
            value: MODIFY_PERMISSIONS;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [Buffer];
            kind: "explicit";
            value: CREATE_IDENTIFIER;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [bigint, Buffer, Buffer, boolean, undefined | Buffer];
            kind: "explicit";
            value: RECEIVE;
        }
    )[],
]
Parameters
- input: BlockCanonical | BlockUnsignedCanonical
Returns [
    0n,
    bigint,
    null
    | bigint,
    Omit<ASN1Date, "kind"> & { kind: "general" },
    Buffer,
    null | Buffer,
    Buffer,
    (
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [bigint, bigint];
            kind: "explicit";
            value: TOKEN_ADMIN_SUPPLY;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [Buffer, bigint, bigint];
            kind: "explicit";
            value: TOKEN_ADMIN_MODIFY_BALANCE;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [bigint, Buffer, undefined | null | Buffer[]];
            kind: "explicit";
            value: MANAGE_CERTIFICATE;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [
                Buffer,
                bigint,
                Buffer,
                undefined
                | Omit<ASN1String, "kind"> & { kind: "utf8" },
            ];
            kind: "explicit";
            value: SEND;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [Buffer];
            kind: "explicit";
            value: SET_REP;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [
                Omit<ASN1String, "kind"> & { kind: "utf8" },
                Omit<ASN1String, "kind"> & { kind: "utf8" },
                Omit<ASN1String, "kind"> & { kind: "utf8" },
                undefined | [bigint, bigint],
            ];
            kind: "explicit";
            value: SET_INFO;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [
                Buffer,
                bigint,
                null
                | [bigint, bigint],
                undefined | Buffer,
            ];
            kind: "explicit";
            value: MODIFY_PERMISSIONS;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [Buffer];
            kind: "explicit";
            value: CREATE_IDENTIFIER;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [bigint, Buffer, Buffer, boolean, undefined | Buffer];
            kind: "explicit";
            value: RECEIVE;
        }
    )[],
]

`Static`isValidJSON

isValidJSON(
    block:
        | BlockJSON
        | {
            $binary?: string;
            $hash: BlockHashString;
            $opening: boolean;
            account: | TokenPublicKeyString
            | NetworkPublicKeyString
            | StoragePublicKeyString
            | MultisigPublicKeyString
            | Secp256K1PublicKeyString
            | Secp256R1PublicKeyString
            | ED25519PublicKeyString;
            date: string;
            network: string;
            operations: ExportedJSONOperation[];
            previous: BlockHashString;
            signature: string;
            signer: | Secp256K1PublicKeyString
            | Secp256R1PublicKeyString
            | ED25519PublicKeyString;
            subnet: undefined
            | string;
            version: 1;
        }
        | Partial<BlockJSON>,
): block is BlockJSON
Parameters
- block:
      | BlockJSON
      | {
          $binary?: string;
          $hash: BlockHashString;
          $opening: boolean;
          account: | TokenPublicKeyString
          | NetworkPublicKeyString
          | StoragePublicKeyString
          | MultisigPublicKeyString
          | Secp256K1PublicKeyString
          | Secp256R1PublicKeyString
          | ED25519PublicKeyString;
          date: string;
          network: string;
          operations: ExportedJSONOperation[];
          previous: BlockHashString;
          signature: string;
          signer: | Secp256K1PublicKeyString
          | Secp256R1PublicKeyString
          | ED25519PublicKeyString;
          subnet: undefined
          | string;
          version: 1;
      }
      | Partial<BlockJSON>
Returns block is BlockJSON

Class Block

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Block

Properties

Readonly$opening

Readonly$signatureValid

Readonlyaccount

Readonlydate

Readonlynetwork

Readonlyoperations

Readonlyprevious

Readonlysignature

Readonlysigner

Readonlysubnet

Readonlyversion

StaticAdjustMethod

StaticBuilder

StaticHash

StaticisInstance

StaticNO_PREVIOUS

StaticOperation

StaticOperationType

Accessors

hash

Returns BlockHash

Methods

toBytes

Parameters

Returns ArrayBuffer

toJSON

Parameters

Returns { $binary?: string; $hash: BlockHash; $opening: boolean; account: GenericAccount; date: Date; network: bigint; operations: ExportedJSONOperation[]; previous: BlockHash; signature: string; signer: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>; subnet: undefined | bigint; version: 1;}

StaticfromUnsignedJSON

Parameters

Returns Promise<Block>

StaticgetAccountOpeningHash

Parameters

Returns BlockHash

Protected StaticgetASN1ContainerWithoutSignature

Parameters

StaticisValidJSON

Parameters

Returns block is BlockJSON

Settings

On This Page

`Readonly`$opening

`Readonly`$signatureValid

`Readonly`account

`Readonly`date

`Readonly`network

`Readonly`operations

`Readonly`previous

`Readonly`signature

`Readonly`signer

`Readonly`subnet

`Readonly`version

`Static`AdjustMethod

`Static`Builder

`Static`Hash

`Static`isInstance

`Static`NO_PREVIOUS

`Static`Operation

`Static`OperationType

Returns {
$binary?: string;
$hash: BlockHash;
$opening: boolean;
account: GenericAccount;
date: Date;
network: bigint;
operations: ExportedJSONOperation[];
previous: BlockHash;
signature: string;
signer: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>;
subnet: undefined | bigint;
version: 1;
}

`Static`fromUnsignedJSON

`Static`getAccountOpeningHash

`Protected` `Static`getASN1ContainerWithoutSignature

`Static`isValidJSON