bitbadgesjs-sdk - v0.22.7
    Preparing search index...

    Class TokenCollection

    A TokenCollection is the top-level object for a collection of tokens. It defines everything about the collection, such as the manager, metadata, etc.

    All collections are identified by a collectionId assigned by the blockchain, which is a uint64 that increments (i.e. the first collection has ID 1).

    All collections can have a manager who is responsible for managing the collection and can be granted certain admin permissions, such as the ability to mint new tokens.

    Certain fields are timeline-based, which means they may have different values at different block heights. We fetch the value according to the current time. For example, we may set the manager to be Alice from Time1 to Time2, and then set the manager to be Bob from Time2 to Time3.

    Collections may have different balance types: standard vs. off-chain - indexed vs. inherited.vs off-chain - non-indexed vs non-public.

    See documentation for more details.

    from message badges.TokenCollection

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    collectionApprovals collectionId collectionMetadataTimeline collectionPermissions? cosmosCoinWrapperPaths createdBy customDataTimeline defaultBalances? invariants? isArchivedTimeline managerTimeline mintEscrowAddress standardsTimeline tokenMetadataTimeline validTokenIds fields runtime typeName

    Methods

    equals fromBinary fromJson fromJsonString

    Constructors

    Properties

    collectionApprovals: badges.CollectionApproval[] = []

    Transferability of the collection for collections with standard balances, subject to changes over time. Overrides user approvals for a transfer if specified. Transfer must satisfy both user and collection-level approvals. Only applicable to on-chain balances.

    from field: repeated badges.CollectionApproval collectionApprovals = 7;

    collectionId: string = ""

    The unique identifier for this collection. This is assigned by the blockchain. First collection has ID 1.

    from field: string collectionId = 1;

    collectionMetadataTimeline: badges.CollectionMetadataTimeline[] = []

    The metadata for the collection itself, which can vary over time.

    from field: repeated badges.CollectionMetadataTimeline collectionMetadataTimeline = 2;

    collectionPermissions?: badges.CollectionPermissions

    Permissions that define what the manager of the collection can do or not do.

    from field: badges.CollectionPermissions collectionPermissions = 6;

    cosmosCoinWrapperPaths: badges.CosmosCoinWrapperPath[] = []

    The IBC wrapper (sdk.coin) paths for the collection.

    from field: repeated badges.CosmosCoinWrapperPath cosmosCoinWrapperPaths = 14;

    createdBy: string = ""

    The user or entity who created the collection.

    from field: string createdBy = 11;

    customDataTimeline: badges.CustomDataTimeline[] = []

    An arbitrary field that can store any data, subject to changes over time.

    from field: repeated badges.CustomDataTimeline customDataTimeline = 4;

    defaultBalances?: badges.UserBalanceStore

    The default store of a balance / approvals for a user, upon genesis.

    from field: badges.UserBalanceStore defaultBalances = 10;

    invariants?: badges.CollectionInvariants

    Collection-level invariants that cannot be broken. These are set upon genesis and cannot be modified.

    from field: badges.CollectionInvariants invariants = 15;

    isArchivedTimeline: badges.IsArchivedTimeline[] = []

    Whether the collection is archived or not, subject to changes over time. When archived, it becomes read-only, and no transactions can be processed until it is unarchived.

    from field: repeated badges.IsArchivedTimeline isArchivedTimeline = 9;

    managerTimeline: badges.ManagerTimeline[] = []

    The address of the manager of this collection, subject to changes over time.

    from field: repeated badges.ManagerTimeline managerTimeline = 5;

    mintEscrowAddress: string = ""

    The generated address of the collection. Also used to escrow Mint balances.

    from field: string mintEscrowAddress = 13;

    standardsTimeline: badges.StandardsTimeline[] = []

    Standards that define how to interpret the fields of the collection, subject to changes over time.

    from field: repeated badges.StandardsTimeline standardsTimeline = 8;

    tokenMetadataTimeline: badges.TokenMetadataTimeline[] = []

    The metadata for each token in the collection, also subject to changes over time.

    from field: repeated badges.TokenMetadataTimeline tokenMetadataTimeline = 3;

    validTokenIds: badges.UintRange[] = []

    The valid token IDs for this collection.

    from field: repeated badges.UintRange validTokenIds = 12;

    fields: FieldList = ...
    runtime: ProtoRuntime = proto3
    typeName: "badges.TokenCollection"

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods