Overview

Notes are the actions or events generated by accounts, such as writing a blog post, getting a NFT dynamic, donation to others, etc.

You can initialize with ipfsGateway to get potentially faster response or higher stability.

API

const notes: Notes = await unidata.notes.get(options: {
    source: string;
    identity: string;
    limit?: number;
    cursor?: any;
});

• identity: Ethereum address, Solana address, Flow address, etc.
• limit: The number of assets to return. Since providers use different pagination schemes, it cannot guarantee that the quantities are always accurate.
• cursor: The pagination cursor returned from the previous page's results. Since providers use different pagination schemes, its type is uncertain.

Specification

All returned data conform to the following specification.

type Notes = {
    total: number;
    cursor?: any;

    list: {
        date_created: string;
        date_updated: string;

        related_urls?: string[];

        tags?: string[];
        authors: AccountInstanceURI[];
        title?: string;
        summary?: string;

        previews?: {
            content?: string;
            address?: URI;
            mime_type?: string;
            size_in_bytes?: number;
        }[];

        items?: {
            content?: string;
            address?: URI;
            mime_type?: string;
            size_in_bytes?: number;
        }[];

        source: NoteSource;

        metadata?: {
            network: Network;
            proof: string;

            [key: string]: any;
        };
    }[];
};