Class Block

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

Implements

Omit<BlockV2Canonical, "version">

Constructors

constructor

new Block(
    input:
        | string
        | Buffer
        | ArrayBuffer
        | BlockJSON
        | Block
        | {
            $binary?: string;
            $hash: BlockHash;
            $opening: boolean;
            account: GenericAccount;
            date: Date;
            idempotent: undefined
            | string;
            network: bigint;
            operations: ExportedJSONOperation[];
            previous: BlockHash;
            purpose: BlockPurpose;
            signature?: string;
            signatures?: string[];
            signer:
                | Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>
                | [MultisigAddress, any[]];
            subnet: undefined | bigint;
            version: 1 | 2;
        }
        | {
            $binary?: string;
            $hash: BlockHashString;
            $opening: boolean;
            account: TokenPublicKeyString | NetworkPublicKeyString | StoragePublicKeyString | MultisigPublicKeyString | Secp256K1PublicKeyString | Secp256R1PublicKeyString | ED25519PublicKeyString;
            date: string;
            idempotent: undefined
            | string;
            network: string;
            operations: ExportedJSONOperation[];
            previous: BlockHashString;
            purpose: BlockPurpose;
            signature?: string;
            signatures?: string[];
            signer: Secp256K1PublicKeyString | Secp256R1PublicKeyString | ED25519PublicKeyString | [MultisigPublicKeyString, any[]];
            subnet: undefined | string;
            version: 1 | 2;
        },
): Block
Parameters
- input:
      | string
      | Buffer
      | ArrayBuffer
      | BlockJSON
      | Block
      | {
          $binary?: string;
          $hash: BlockHash;
          $opening: boolean;
          account: GenericAccount;
          date: Date;
          idempotent: undefined
          | string;
          network: bigint;
          operations: ExportedJSONOperation[];
          previous: BlockHash;
          purpose: BlockPurpose;
          signature?: string;
          signatures?: string[];
          signer:
              | Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>
              | [MultisigAddress, any[]];
          subnet: undefined | bigint;
          version: 1 | 2;
      }
      | {
          $binary?: string;
          $hash: BlockHashString;
          $opening: boolean;
          account: TokenPublicKeyString | NetworkPublicKeyString | StoragePublicKeyString | MultisigPublicKeyString | Secp256K1PublicKeyString | Secp256R1PublicKeyString | ED25519PublicKeyString;
          date: string;
          idempotent: undefined
          | string;
          network: string;
          operations: ExportedJSONOperation[];
          previous: BlockHashString;
          purpose: BlockPurpose;
          signature?: string;
          signatures?: string[];
          signer: Secp256K1PublicKeyString | Secp256R1PublicKeyString | ED25519PublicKeyString | [MultisigPublicKeyString, any[]];
          subnet: undefined | string;
          version: 1 | 2;
      }
Returns Block

Properties

`Readonly`$opening

$opening: boolean = false

`Readonly`account

account: GenericAccount

`Readonly`date

date: Date

`Readonly`idempotent

idempotent: undefined | Buffer

`Readonly`network

network: bigint

`Readonly`operations

operations: BlockOperations[]

`Readonly`previous

previous: BlockHash

`Readonly`subnet

subnet: undefined | bigint

`Readonly`version

version: 1 | 2

`Static` `Readonly`AdjustMethod

AdjustMethod: typeof AdjustMethod = AdjustMethod

`Static`Builder

Builder: typeof BlockBuilder

`Static` `Readonly`Hash

Hash: typeof BlockHash = BlockHash

`Static`isInstance

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

`Static` `Readonly`NO_PREVIOUS

NO_PREVIOUS: "9bd05fa2-8e59-42a2-8153-26d8e8c10143:NO_PREVIOUS" = NO_PREVIOUS

`Static` `Readonly`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` `Readonly`OperationType

OperationType: typeof OperationType = Operations.OperationType

`Static` `Readonly`Purpose

Purpose: typeof BlockPurpose = BlockPurpose

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

principal

get principal(): | Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>
| MultisigAddress
Returns Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1> | MultisigAddress

Methods

toBytes

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

toJSON

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

`Static`fromUnsignedJSON

fromUnsignedJSON(
input: BlockV2UnsignedCanonical | BlockV1UnsignedCanonical,
): Promise<Block>
Parameters
- input: BlockV2UnsignedCanonical | BlockV1UnsignedCanonical
Returns Promise<Block>

`Static`getAccountOpeningHash

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

`Protected` `Static`getASN1ContainerWithoutSignature

getASN1ContainerWithoutSignature(
    input:
        | BlockV2Canonical
        | BlockV2UnsignedCanonical
        | BlockV1UnsignedCanonical
        | BlockV1Canonical,
): BlockASN1SchemaWithoutSignature
Parameters
- input:
      | BlockV2Canonical
      | BlockV2UnsignedCanonical
      | BlockV1UnsignedCanonical
      | BlockV1Canonical
Returns BlockASN1SchemaWithoutSignature

`Protected` `Static`getV1ASN1ContainerWithoutSignature

getV1ASN1ContainerWithoutSignature(
    input: BlockV1UnsignedCanonical | BlockV1Canonical,
): [
    version: 0n,
    network: bigint,
    subnet: null
    | bigint,
    idempotent: Buffer,
    date: Omit<ASN1Date, "kind"> & { kind: "general" },
    signer: Buffer,
    account: null | Buffer,
    previous: Buffer,
    operations: (
        | 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,
                | undefined
                | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
                    contains: [Buffer[], bigint];
                    kind: "explicit";
                    value: 7;
                },
            ];
            kind: "explicit";
            value: CREATE_IDENTIFIER;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [bigint, Buffer, Buffer, boolean, undefined | Buffer];
            kind: "explicit";
            value: RECEIVE;
        }
    )[],
]
Parameters
- input: BlockV1UnsignedCanonical | BlockV1Canonical
Returns [
    version: 0n,
    network: bigint,
    subnet: null
    | bigint,
    idempotent: Buffer,
    date: Omit<ASN1Date, "kind"> & { kind: "general" },
    signer: Buffer,
    account: null | Buffer,
    previous: Buffer,
    operations: (
        | 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,
                | undefined
                | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
                    contains: [Buffer[], bigint];
                    kind: "explicit";
                    value: 7;
                },
            ];
            kind: "explicit";
            value: CREATE_IDENTIFIER;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [bigint, Buffer, Buffer, boolean, undefined | Buffer];
            kind: "explicit";
            value: RECEIVE;
        }
    )[],
]

`Protected` `Static`getV2ASN1ContainerWithoutSignature

getV2ASN1ContainerWithoutSignature(
    input: BlockV2Canonical | BlockV2UnsignedCanonical,
): [
    network: bigint,
    subnet: bigint,
    idempotent: Buffer,
    date: Omit<ASN1Date, "kind"> & { kind: "general" },
    purpose: bigint,
    account: Buffer,
    signer: null | Buffer | [multisigPubKey: Buffer, signers: any[]],
    previous: Buffer,
    operations: (
        | 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,
                | undefined
                | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
                    contains: [Buffer[], bigint];
                    kind: "explicit";
                    value: 7;
                },
            ];
            kind: "explicit";
            value: CREATE_IDENTIFIER;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [bigint, Buffer, Buffer, boolean, undefined | Buffer];
            kind: "explicit";
            value: RECEIVE;
        }
    )[],
]
Parameters
- input: BlockV2Canonical | BlockV2UnsignedCanonical
Returns [
    network: bigint,
    subnet: bigint,
    idempotent: Buffer,
    date: Omit<ASN1Date, "kind"> & { kind: "general" },
    purpose: bigint,
    account: Buffer,
    signer: null | Buffer | [multisigPubKey: Buffer, signers: any[]],
    previous: Buffer,
    operations: (
        | 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,
                | undefined
                | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
                    contains: [Buffer[], bigint];
                    kind: "explicit";
                    value: 7;
                },
            ];
            kind: "explicit";
            value: CREATE_IDENTIFIER;
        }
        | Omit<ASN1ContextTag, "kind" | "value" | "contains"> & {
            contains: [bigint, Buffer, Buffer, boolean, undefined | Buffer];
            kind: "explicit";
            value: RECEIVE;
        }
    )[],
]

`Static`isValidJSON

isValidJSON<Version extends 1 | 2>(
block: unknown,
version?: Version,
): block is { "1": BlockV1JSON; "2": BlockV2JSON }[Version]
Type Parameters
- Version extends 1 | 2
Parameters
- block: unknown
- Optionalversion: Version
Returns block is { "1": BlockV1JSON; "2": BlockV2JSON }[Version]

Class Block

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Block

Properties

Readonly$opening

Readonlyaccount

Readonlydate

Readonlyidempotent

Readonlynetwork

Readonlyoperations

Readonlyprevious

Readonlypurpose

Readonlysignatures

Readonlysigner

Readonlysubnet

Readonlyversion

Static ReadonlyAdjustMethod

StaticBuilder

Static ReadonlyHash

StaticisInstance

Static ReadonlyNO_PREVIOUS

Static ReadonlyOperation

Static ReadonlyOperationType

Static ReadonlyPurpose

Accessors

hash

Returns BlockHash

principal

Returns Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1> | MultisigAddress

Methods

toBytes

Parameters

Returns ArrayBuffer

toJSON

Parameters

StaticfromUnsignedJSON

Parameters

Returns Promise<Block>

StaticgetAccountOpeningHash

Parameters

Returns BlockHash

Protected StaticgetASN1ContainerWithoutSignature

Parameters

Returns BlockASN1SchemaWithoutSignature

Protected StaticgetV1ASN1ContainerWithoutSignature

Parameters

Protected StaticgetV2ASN1ContainerWithoutSignature

Parameters

StaticisValidJSON

Type Parameters

Parameters

Returns block is { "1": BlockV1JSON; "2": BlockV2JSON }[Version]

Settings

On This Page

`Readonly`$opening

`Readonly`account

`Readonly`date

`Readonly`idempotent

`Readonly`network

`Readonly`operations

`Readonly`previous

`Readonly`purpose

`Readonly`signatures

`Readonly`signer

`Readonly`subnet

`Readonly`version

`Static` `Readonly`AdjustMethod

`Static`Builder

`Static` `Readonly`Hash

`Static`isInstance

`Static` `Readonly`NO_PREVIOUS

`Static` `Readonly`Operation

`Static` `Readonly`OperationType

`Static` `Readonly`Purpose

`Static`fromUnsignedJSON

`Static`getAccountOpeningHash

`Protected` `Static`getASN1ContainerWithoutSignature

`Protected` `Static`getV1ASN1ContainerWithoutSignature

`Protected` `Static`getV2ASN1ContainerWithoutSignature

`Static`isValidJSON