Interface: ProtocolReturnedDrop
Drop information returned from the Protocol. This interface is exactly the same as the Drop
, except all the fields are
snake cased instead of camel cased due to what the Protocol returns.
Properties
config
Optional
config: ProtocolReturnedDropConfig
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
deposit_per_use
deposit_per_use: string
How much $yoctoNEAR will be transferred anytime a key is used that is part of this drop.
Defined in
drop_id
drop_id: string
Drop ID for this specific drop.
Defined in
fc
Optional
fc: ProtocolReturnedFCData
For Function-Call drops, important information needs to be stored such as which methods, the attached deposit, args etc.
Defined in
ft
Optional
ft: ProtocolReturnedFTData
For Fungible Token drops, important information such as the amount of tokens to transfer, or contract need to be stored.
Defined in
keys
Optional
keys: ProtocolReturnedKeyInfo
[]
If calling getDrops
or getDropInformation
and withKeys
is passed in as true, an extra view call will be done to get a set of keys that are currently on the drop.
Defined in
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
next_key_id
next_key_id: number
What is the next unique ID that will be given to the next access key added to this drop.
Defined in
nft
Optional
nft: ProtocolReturnedNFTData
For NFT drops, important information such as the token IDs, or contract need to be stored.
Defined in
owner_id
owner_id: string
Which account created this drop.
Defined in
registered_uses
registered_uses: 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
required_gas
required_gas: 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
simple
Optional
simple: ProtocolReturnedSimpleData
For simple drops, there are specific, optional configurations.