codechain-es/lib/types.d.ts

CodeChain-es-js provides the rich object types of the CodeChain-primitive-js that are indexed by indexer and used in the CodeChain Explorer, the CodeChain Wallet.

/// <reference types="node" />
export interface BlockDoc {
    parentHash: string;
    timestamp: number;
    number: number;
    author: string;
    extraData: Buffer;
    parcelsRoot: string;
    stateRoot: string;
    invoicesRoot: string;
    score: string;
    seal: Buffer[];
    hash: string;
    parcels: ParcelDoc[];
    isRetracted: boolean;
    miningReward: string;
}
export interface ParcelDoc {
    blockNumber: number | null;
    blockHash: string | null;
    parcelIndex: number | null;
    nonce: string;
    fee: string;
    networkId: string;
    sig: string;
    hash: string;
    action: ActionDoc;
    signer: string;
    timestamp: number;
    countOfTransaction: number;
    isRetracted: boolean;
}
export declare type ActionDoc = AssetTransactionGroupDoc | PaymentDoc | SetRegularKeyDoc | CreateShardDoc;
export interface AssetTransactionGroupDoc {
    action: string;
    transactions: TransactionDoc[];
}
export interface PaymentDoc {
    action: string;
    receiver: string;
    amount: string;
    invoice?: boolean;
    errorType?: string;
}
export interface SetRegularKeyDoc {
    action: string;
    key: string;
    invoice?: boolean;
    errorType?: string;
}
export interface CreateShardDoc {
    action: string;
    invoice?: boolean;
    errorType?: string;
}
export declare type TransactionDoc = AssetMintTransactionDoc | AssetTransferTransactionDoc;
export interface AssetSchemeDoc {
    metadata: string;
    registrar: string | null;
    amount: number | null;
    networkId: string;
}
export interface AssetBundleDoc {
    assetScheme: AssetSchemeDoc;
    asset: AssetDoc;
}
export interface AssetDoc {
    assetType: string;
    lockScriptHash: string;
    parameters: Buffer[];
    amount: number;
    transactionHash: string;
    transactionOutputIndex: number;
}
export interface AssetMintTransactionDoc {
    type: string;
    data: {
        output: {
            lockScriptHash: string;
            parameters: Buffer[];
            amount: number | null;
            owner: string;
            assetType: string;
        };
        networkId: string;
        metadata: string;
        registrar: string | null;
        nonce: number;
        hash: string;
        timestamp: number;
        assetName: string;
        parcelHash: string;
        blockNumber: number;
        parcelIndex: number;
        transactionIndex: number;
        invoice?: boolean;
        errorType?: string;
    };
    isRetracted: boolean;
}
export interface AssetTransferTransactionDoc {
    type: string;
    data: {
        networkId: string;
        burns: AssetTransferInputDoc[];
        inputs: AssetTransferInputDoc[];
        outputs: AssetTransferOutputDoc[];
        nonce: number;
        hash: string;
        timestamp: number;
        parcelHash: string;
        blockNumber: number;
        parcelIndex: number;
        transactionIndex: number;
        invoice?: boolean;
        errorType?: string;
    };
    isRetracted: boolean;
}
export interface AssetTransferInputDoc {
    prevOut: {
        transactionHash: string;
        index: number;
        assetType: string;
        assetScheme: AssetSchemeDoc;
        amount: number;
        owner: string;
        lockScriptHash: string;
        parameters: Buffer[];
    };
    lockScript: Buffer;
    unlockScript: Buffer;
}
export interface AssetTransferOutputDoc {
    lockScriptHash: string;
    parameters: Buffer[];
    assetType: string;
    assetScheme: AssetSchemeDoc;
    amount: number;
    owner: string;
}
export interface PendingParcelDoc {
    parcel: ParcelDoc;
    status: string;
    timestamp: number;
}
export interface PendingTransactionDoc {
    transaction: TransactionDoc;
    status: string;
    timestamp: number;
}