Interface iBalanceDocWithDetails<T>

interface iBalanceDocWithDetails<T> {
    _docId: string;
    _id?: string;
    autoApproveSelfInitiatedIncomingTransfers: boolean;
    autoApproveSelfInitiatedOutgoingTransfers: boolean;
    balances: iBalance<T>[];
    bitbadgesAddress: string;
    collectionId: T;
    contentHash?: string;
    fetchedAt?: T;
    fetchedAtBlock?: T;
    incomingApprovals: iUserIncomingApprovalWithDetails<T>[];
    isPermanent?: boolean;
    onChain: boolean;
    outgoingApprovals: iUserOutgoingApprovalWithDetails<T>[];
    updateHistory: iUpdateHistory<T>[];
    uri?: string;
    userPermissions: iUserPermissionsWithDetails<T>;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

_docId _id? autoApproveSelfInitiatedIncomingTransfers autoApproveSelfInitiatedOutgoingTransfers balances bitbadgesAddress collectionId contentHash? fetchedAt? fetchedAtBlock? incomingApprovals isPermanent? onChain outgoingApprovals updateHistory uri? userPermissions

Properties

_docId

_docId: string

A unique stringified document ID

Optional_id

_id?: string

A unique document ID (Mongo DB ObjectID)

autoApproveSelfInitiatedIncomingTransfers

autoApproveSelfInitiatedIncomingTransfers: boolean

Whether the user's self-initiated incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals.

autoApproveSelfInitiatedOutgoingTransfers

autoApproveSelfInitiatedOutgoingTransfers: boolean

Whether the user's self-initiated outgoing transfers are auto-approved. If not, they must be explicitly approved using the outgoing approvals.

balances

balances: iBalance<T>[]

The user's balances.

bitbadgesAddress

bitbadgesAddress: string

The BitBadges address of the user

collectionId

collectionId: T

The collection ID

OptionalcontentHash

contentHash?: string

The content hash of the off-chain balances

OptionalfetchedAt

fetchedAt?: T

The timestamp of when the off-chain balances were fetched (milliseconds since epoch). For BitBadges indexer, we only populate this for Mint and Total docs.

OptionalfetchedAtBlock

fetchedAtBlock?: T

The block number of when the off-chain balances were fetched. For BitBadges indexer, we only populate this for Mint and Total docs.

incomingApprovals

incomingApprovals: iUserIncomingApprovalWithDetails<T>[]

The incoming approvals with details like metadata and address lists.

OptionalisPermanent

isPermanent?: boolean

True if the off-chain balances are using permanent storage

onChain

onChain: boolean

True if the balances are on-chain

outgoingApprovals

outgoingApprovals: iUserOutgoingApprovalWithDetails<T>[]

The outgoing approvals with details like metadata and address lists.

updateHistory

updateHistory: iUpdateHistory<T>[]

The update history of this balance

Optionaluri

uri?: string

The URI of the off-chain balances

userPermissions

userPermissions: iUserPermissionsWithDetails<T>

The user permissions with details like metadata and address lists.

Settings

Member Visibility

On This Page

Properties