Interface: iCollectionApprovalWithDetails<T>

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

Extends#

• iCollectionApproval<T>

Type Parameters#

T#

T extends NumberType

Properties#

approvalCriteria?#

optional approvalCriteria?: iApprovalCriteriaWithDetails<T>

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

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.

Overrides#

iCollectionApproval.approvalCriteria

---

approvalId#

approvalId: string

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/approvals.ts:342

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

Inherited from#

iCollectionApproval.approvalId

---

customData?#

optional customData?: string

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/approvals.ts:346

Arbitrary custom data of the approval

Inherited from#

iCollectionApproval.customData

---

details?#

optional details?: iApprovalInfoDetails

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

The approval metadata details

---

fromList#

fromList: iAddressList

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

The populated address list for the fromListId

---

fromListId#

fromListId: string

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/approvals.ts:332

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.

Inherited from#

iCollectionApproval.fromListId

---

initiatedByList#

initiatedByList: iAddressList

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

The populated address list for the initiatedByListId

---

initiatedByListId#

initiatedByListId: string

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/approvals.ts:334

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.

Inherited from#

iCollectionApproval.initiatedByListId

---

ownershipTimes#

ownershipTimes: iUintRange<T>[]

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/approvals.ts:340

The ownership times of the tokens being transferred.

Inherited from#

iCollectionApproval.ownershipTimes

---

tokenIds#

tokenIds: iUintRange<T>[]

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/approvals.ts:338

The token IDs to be transferred.

Inherited from#

iCollectionApproval.tokenIds

---

toList#

toList: iAddressList

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

The populated address list for the toListId

---

toListId#

toListId: string

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/approvals.ts:330

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.

Inherited from#

iCollectionApproval.toListId

---

transferTimes#

transferTimes: iUintRange<T>[]

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/approvals.ts:336

The times allowed for the transfer transaction.

Inherited from#

iCollectionApproval.transferTimes

---

uri?#

optional uri?: string

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/approvals.ts:344

The URI of the approval.

Inherited from#

iCollectionApproval.uri

---

version#

version: T

Defined in: packages/bitbadgesjs-sdk/src/interfaces/types/approvals.ts:350

The version of the approval.0

Inherited from#

iCollectionApproval.version