arkiv-sdk
    Preparing search index...

    Type Alias EntityMetaData

    Complete metadata information for an entity stored in Arkiv.

    This type contains all the information about an entity including its expiration, data payload, annotations, and ownership details. It's returned by query operations to provide comprehensive entity information.

    const metadata: EntityMetaData = await client.getEntityMetaData("0x1234567890abcdef");

    console.log(`Entity expires at block: ${metadata.expiresAtBlock}`);
    console.log(`Entity owner: ${metadata.owner}`);
    console.log(`Data payload: ${metadata.payload}`);

    // Access annotations
    metadata.stringAnnotations.forEach(ann => {
      console.log(`${ann.key}: ${ann.value}`);
    });
    type EntityMetaData = {
        expiresAtBlock: bigint;
        numericAnnotations: NumericAnnotation[];
        owner: Hex;
        payload: string;
        stringAnnotations: StringAnnotation[];
    }
    Index

    Properties

    expiresAtBlock numericAnnotations owner payload stringAnnotations

    Properties

    expiresAtBlock: bigint

    The block number at which this entity will expire and be automatically deleted

    numericAnnotations: NumericAnnotation[]

    Numeric-valued metadata annotations attached to the entity

    owner: Hex

    The Ethereum address of the entity owner

    payload: string

    The base64-encoded data payload stored in the entity

    stringAnnotations: StringAnnotation[]

    String-valued metadata annotations attached to the entity

    Settings

    Member Visibility

    On This Page

    Properties