bitbadgesjs-sdk - v0.27.2
    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.

    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

    aliasPaths collectionApprovals collectionId collectionMetadata? collectionPermissions? cosmosCoinWrapperPaths createdBy customData defaultBalances? invariants? isArchived manager mintEscrowAddress standards tokenMetadata validTokenIds fields runtime typeName

    Methods

    equals fromBinary fromJson fromJsonString

    Constructors

    Properties

    aliasPaths: badges.AliasPath[] = []

    The alias (non-wrapping) paths for the collection.

    from field: repeated badges.AliasPath aliasPaths = 16;

    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;

    collectionMetadata?: badges.CollectionMetadata

    The metadata for the collection itself.

    from field: badges.CollectionMetadata collectionMetadata = 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;

    customData: string = ""

    An arbitrary field that can store any data.

    from field: string customData = 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;

    isArchived: boolean = false

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

    from field: bool isArchived = 9;

    manager: string = ""

    The address of the manager of this collection.

    from field: string manager = 5;

    mintEscrowAddress: string = ""

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

    from field: string mintEscrowAddress = 13;

    standards: string[] = []

    Standards that define how to interpret the fields of the collection.

    from field: repeated string standards = 8;

    tokenMetadata: badges.TokenMetadata[] = []

    The metadata for each token in the collection.

    from field: repeated badges.TokenMetadata tokenMetadata = 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