Class MsgUniversalUpdateCollection<T>

MsgUniversalUpdateCollection is a universal transaction that can be used to create / update any collection. It is only executable by the manager. MsgCreateCollection and MsgUpdateCollection are special cases of this message.

Upon initial creation, you can set the default approved outgoing transfers, default approved incoming transfers, default user permissions, and balances type. However, after that, they are final and ignored in subsequent MsgUniversalUpdateCollection calls.

For a new collection, specify collectionId == "0".

Note that you must have the necessary privileges to update specific fields. If you do not have the necessary privileges, it will throw an error. We update any CollectionPermissions at the end, so the permissions checked for the current execution are the permissions BEFORE the update. In the case of the first MsgUniversalUpdateCollection, the previous permissions are by default all permitted.

To specify you would like to update a field, the corresponding update field must be set to true. If it is set to false, we ignore it.

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

badgeMetadataTimeline? badgesToCreate? balancesType? collectionApprovals? collectionId collectionMetadataTimeline? collectionPermissions? creator customDataTimeline? defaultBalances? isArchivedTimeline? managerTimeline? offChainBalancesMetadataTimeline? standardsTimeline? updateBadgeMetadataTimeline? updateCollectionApprovals? updateCollectionMetadataTimeline? updateCollectionPermissions? updateCustomDataTimeline? updateIsArchivedTimeline? updateManagerTimeline? updateOffChainBalancesMetadataTimeline? updateStandardsTimeline?

Methods

clone convert equals getNumberFieldNames toJson toJsonString toProto fromJson fromJsonString fromProto

Constructors

constructor

Properties

Optional badgeMetadataTimeline

badgeMetadataTimeline?: BadgeMetadataTimeline<T>[]

The new badge metadata timeline. Must have the necessary permissions in future transactions to update. However, no restrictions in this genesis Msg. Note we take first-match only for badge IDs, so do not define duplicates.

Optional badgesToCreate

badgesToCreate?: BalanceArray<T>

The badges to create. Newly created badges will be sent to the "Mint" address. Must have necessary permissions in future transactions to update. However, no restrictions in this genesis Msg. Only used if collection has "Standard" balance type.

Optional balancesType

balancesType?: string

The balances type. Either "Standard", "Off-Chain - Indexed", "Off-Chain - Non-Indexed" or "Non-Public"

Optional collectionApprovals

collectionApprovals?: CollectionApproval<T>[]

The new collection approved transfers timeline. Must have the necessary permissions in future transactions to update. However, no restrictions in this genesis Msg.

collectionId

collectionId: T

The ID of the collection to update.

Optional collectionMetadataTimeline

collectionMetadataTimeline?: CollectionMetadataTimeline<T>[]

The new collection metadata timeline. Must have the necessary permissions in future transactions to update. However, no restrictions in this genesis Msg.

Optional collectionPermissions

collectionPermissions?: CollectionPermissions<T>

The new collection permissions. Must have the necessary permissions in future transactions to update. However, no restrictions in this genesis Msg.

creator

creator: string

The creator of the transaction.

Optional customDataTimeline

customDataTimeline?: CustomDataTimeline<T>[]

The new custom data timeline. Must have the necessary permissions in future transactions to update. However, no restrictions in this genesis Msg.

Optional defaultBalances

defaultBalances?: UserBalanceStore<T>

The default balances for users who have not interacted with the collection yet. Only can be set on initial creation. Only used if collection has "Standard" balance type.

Optional isArchivedTimeline

isArchivedTimeline?: IsArchivedTimeline<T>[]

The new is archived timeline. Must have the necessary permissions in future transactions to update. However, no restrictions in this genesis Msg.

Optional managerTimeline

managerTimeline?: ManagerTimeline<T>[]

The new manager timeline. Must have the necessary permissions in future transactions to update. However, no restrictions in this genesis Msg.

Optional offChainBalancesMetadataTimeline

offChainBalancesMetadataTimeline?: OffChainBalancesMetadataTimeline<T>[]

The new off-chain balances metadata timeline. Must have the necessary permissions in future transactions to update. However, no restrictions in this genesis Msg. Only used if "Off-Chain - Indexed" or "Off-Chain - Non-Indexed" balance type.

Optional standardsTimeline

standardsTimeline?: StandardsTimeline<T>[]

The new standards timeline. Must have the necessary permissions in future transactions to update. However, no restrictions in this genesis Msg.

Optional updateBadgeMetadataTimeline

updateBadgeMetadataTimeline?: boolean

Whether or not to update the badge metadata timeline.

Optional updateCollectionApprovals

updateCollectionApprovals?: boolean

Whether or not to update the collection approved transfers timeline.

Optional updateCollectionMetadataTimeline

updateCollectionMetadataTimeline?: boolean

Whether or not to update the collection metadata timeline.

Optional updateCollectionPermissions

updateCollectionPermissions?: boolean

Whether or not to update the collection permissions.

Optional updateCustomDataTimeline

updateCustomDataTimeline?: boolean

Whether or not to update the custom data timeline.

Optional updateIsArchivedTimeline

updateIsArchivedTimeline?: boolean

Whether or not to update the is archived timeline.

Optional updateManagerTimeline

updateManagerTimeline?: boolean

Whether or not to update the manager timeline.

Optional updateOffChainBalancesMetadataTimeline

updateOffChainBalancesMetadataTimeline?: boolean

Whether or not to update the off-chain balances metadata timeline.

Optional updateStandardsTimeline

updateStandardsTimeline?: boolean

Whether or not to update the standards timeline.

Methods

clone

convert

equals

  • equals<U>(other, normalizeNumberTypes?): boolean

  • Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

    If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

    Type Parameters

    Parameters

    • other: undefined | null | CustomType<U>
    • Optional normalizeNumberTypes: boolean

    Returns boolean

getNumberFieldNames

toJson

toJsonString

toProto

Static fromJson

Static fromJsonString

Static fromProto

Settings

Member Visibility

Theme

On This Page

constructorbadgeMetadataTimelinebadgesToCreatebalancesTypecollectionApprovalscollectionIdcollectionMetadataTimelinecollectionPermissionscreatorcustomDataTimelinedefaultBalancesisArchivedTimelinemanagerTimelineoffChainBalancesMetadataTimelinestandardsTimelineupdateBadgeMetadataTimelineupdateCollectionApprovalsupdateCollectionMetadataTimelineupdateCollectionPermissionsupdateCustomDataTimelineupdateIsArchivedTimelineupdateManagerTimelineupdateOffChainBalancesMetadataTimelineupdateStandardsTimelinecloneconvertequalsgetNumberFieldNamestoJsontoJsonStringtoProtofromJsonfromJsonStringfromProto