Class: CollectionApprovalWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2275

Extends#

• CollectionApproval<T>

Type Parameters#

T#

T extends NumberType

Implements#

• iCollectionApprovalWithDetails<T>

Constructors#

Constructor#

new CollectionApprovalWithDetails<T>(data): CollectionApprovalWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2282

Parameters#

data#

iCollectionApprovalWithDetails<T>

Returns#

CollectionApprovalWithDetails<T>

Overrides#

CollectionApproval.constructor

Properties#

approvalCriteria?#

optional approvalCriteria?: ApprovalCriteriaWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2280

The criteria to be met. These represent the restrictions that must be obeyed such as the total amount approved, max num transfers, merkle challenges, must own tokens, etc.

Implementation of#

iCollectionApprovalWithDetails.approvalCriteria

Overrides#

CollectionApproval.approvalCriteria

---

approvalId#

approvalId: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1305

The ID of the approval. Must not be a duplicate of another approval ID in the same timeline.

Implementation of#

iCollectionApprovalWithDetails.approvalId

Inherited from#

CollectionApproval.approvalId

---

customData?#

optional customData?: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1307

Arbitrary custom data of the approval

Implementation of#

iCollectionApprovalWithDetails.customData

Inherited from#

CollectionApproval.customData

---

details?#

optional details?: ApprovalInfoDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2276

The approval metadata details

Implementation of#

iCollectionApprovalWithDetails.details

---

fromList#

fromList: AddressList

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2278

The populated address list for the fromListId

Implementation of#

iCollectionApprovalWithDetails.fromList

---

fromListId#

fromListId: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1300

The list ID for the user(s) who is sending the tokens. The ID is either registered on-chain for reusability or follows the reserved ID system.

Implementation of#

iCollectionApprovalWithDetails.fromListId

Inherited from#

CollectionApproval.fromListId

---

initiatedByList#

initiatedByList: AddressList

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2279

The populated address list for the initiatedByListId

Implementation of#

iCollectionApprovalWithDetails.initiatedByList

---

initiatedByListId#

initiatedByListId: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1301

The list ID for the user(s) who initiate the transfer. The ID is either registered on-chain for reusability or follows the reserved ID system.

Implementation of#

iCollectionApprovalWithDetails.initiatedByListId

Inherited from#

CollectionApproval.initiatedByListId

---

ownershipTimes#

ownershipTimes: UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1304

The ownership times of the tokens being transferred.

Implementation of#

iCollectionApprovalWithDetails.ownershipTimes

Inherited from#

CollectionApproval.ownershipTimes

---

tokenIds#

tokenIds: UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1303

The token IDs to be transferred.

Implementation of#

iCollectionApprovalWithDetails.tokenIds

Inherited from#

CollectionApproval.tokenIds

---

toList#

toList: AddressList

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2277

The populated address list for the toListId

Implementation of#

iCollectionApprovalWithDetails.toList

---

toListId#

toListId: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1299

The list ID for the user(s) who is receiving the tokens. The ID is either registered on-chain for reusability or follows the reserved ID system.

Implementation of#

iCollectionApprovalWithDetails.toListId

Inherited from#

CollectionApproval.toListId

---

transferTimes#

transferTimes: UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1302

The times allowed for the transfer transaction.

Implementation of#

iCollectionApprovalWithDetails.transferTimes

Inherited from#

CollectionApproval.transferTimes

---

uri?#

optional uri?: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1306

The URI of the approval.

Implementation of#

iCollectionApprovalWithDetails.uri

Inherited from#

CollectionApproval.uri

---

version#

version: T

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1309

The version of the approval.0

Implementation of#

iCollectionApprovalWithDetails.version

Inherited from#

CollectionApproval.version

Methods#

castToIncomingApproval()#

castToIncomingApproval(): UserIncomingApprovalWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2363

Returns#

UserIncomingApprovalWithDetails<T>

Overrides#

CollectionApproval.castToIncomingApproval

---

castToOutgoingApproval()#

castToOutgoingApproval(): UserOutgoingApprovalWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2349

Returns#

UserOutgoingApprovalWithDetails<T>

Overrides#

CollectionApproval.castToOutgoingApproval

---

castToUniversalPermission()#

castToUniversalPermission(): UniversalPermission

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2299

Returns#

UniversalPermission

---

clone()#

clone(): CollectionApprovalWithDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2295

Deep copies the object and returns a new instance.

Returns#

CollectionApprovalWithDetails<T>

Overrides#

CollectionApproval.clone

---

convert()#

convert<U>(convertFunction, options?): CollectionApprovalWithDetails<U>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2291

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

CollectionApprovalWithDetails<U>

Overrides#

CollectionApproval.convert

---

equals()#

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

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

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#

U#

U extends CustomType<U>

Parameters#

other#

CustomType<U> | null | undefined

normalizeNumberTypes?#

boolean

Returns#

boolean

Inherited from#

CollectionApproval.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1338

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Inherited from#

CollectionApproval.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns#

boolean

Inherited from#

CollectionApproval.hasNumberFields

---

toBech32Addresses()#

toBech32Addresses(prefix): CollectionApproval<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1408

Parameters#

prefix#

string

Returns#

CollectionApproval<T>

Inherited from#

CollectionApproval.toBech32Addresses

---

toJson()#

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

CollectionApproval.toJson

---

toJsonString()#

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns#

string

Inherited from#

CollectionApproval.toJsonString

---

toProto()#

toProto(): CollectionApproval

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1346

Returns#

CollectionApproval

Inherited from#

CollectionApproval.toProto

---

fromJson()#

static fromJson<U>(jsonValue, convertFunction, options?): CollectionApproval<U>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1350

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

CollectionApproval<U>

Inherited from#

CollectionApproval.fromJson

---

fromJsonString()#

static fromJsonString<U>(jsonString, convertFunction, options?): CollectionApproval<U>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1358

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

CollectionApproval<U>

Inherited from#

CollectionApproval.fromJsonString

---

fromProto()#

static fromProto<U>(item, convertFunction): CollectionApproval<U>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1366

Type Parameters#

U#

U extends NumberType

Parameters#

item#

CollectionApproval

convertFunction#

(item) => U

Returns#

CollectionApproval<U>

Inherited from#

CollectionApproval.fromProto

---

validateUpdate()#

static validateUpdate<U>(oldApprovals, newApprovals, canUpdateCollectionApprovals): Error | null

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:2376

Type Parameters#

U#

U extends NumberType

Parameters#

oldApprovals#

CollectionApprovalWithDetails<U>[]

newApprovals#

CollectionApprovalWithDetails<U>[]

canUpdateCollectionApprovals#

CollectionApprovalPermissionWithDetails<U>[]

Returns#

Error | null

Overrides#

CollectionApproval.validateUpdate