Skip to main content
Version: Next

Interface: Drop

Information related to a specific drop.

Properties

config

Optional config: DropConfig

All drops regardless of their type can have a suite of configurations such as how many uses each key has or how often a key can be used.

Defined in

lib/types/drops.ts:50


depositPerUse

depositPerUse: string

How much $yoctoNEAR will be transferred anytime a key is used that is part of this drop.

Defined in

lib/types/drops.ts:40


dropId

dropId: string

Drop ID for this specific drop.

Defined in

lib/types/drops.ts:36


fc

Optional fc: FCData

For Function-Call drops, important information needs to be stored such as which methods, the attached deposit, args etc.

Defined in

lib/types/drops.ts:48


ft

Optional ft: FTData

For Fungible Token drops, important information such as the amount of tokens to transfer, or contract need to be stored.

Defined in

lib/types/drops.ts:46


metadata

Optional metadata: string

Any extra information about the drop can be stored as metadata. This is up to the drop creator and can be stringified JSON, or any other string.

Defined in

lib/types/drops.ts:52


nextKeyId

nextKeyId: number

What is the next unique ID that will be given to the next access key added to this drop.

Defined in

lib/types/drops.ts:58


nft

Optional nft: NFTData

For NFT drops, important information such as the token IDs, or contract need to be stored.

Defined in

lib/types/drops.ts:44


ownerId

ownerId: string

Which account created this drop.

Defined in

lib/types/drops.ts:38


registeredUses

registeredUses: number

How many key uses are registered for this drop? This is only applicable to simple drops with lazy registrations, FT drops, and NFT drops.

Defined in

lib/types/drops.ts:54


requiredGas

requiredGas: string

In order to use an access key that's part of this drop, how much Gas needs to be attached to the call?

Defined in

lib/types/drops.ts:56


simple

Optional simple: SimpleData

For simple drops, there are specific, optional configurations.

Defined in

lib/types/drops.ts:42