Skip to main content
Version: Next

Interface: ProtocolReturnedPublicSaleConfig

Within the config, there are configurable options related to how keys can be sold and a funder can potentially make a profit.

Properties​

allowlist​

Optional allowlist: string[]

Which accounts are allowed to add keys? If the allowlist is empty, anyone that is not in the blocklist can add keys.

Defined in​

lib/types/protocol.ts:173


auto_withdraw_funds​

Optional auto_withdraw_funds: boolean

Should the revenue generated be sent to the funder's account balance or automatically withdrawn and sent to their NEAR wallet?

Defined in​

lib/types/protocol.ts:180


blocklist​

Optional blocklist: string[]

Which accounts are NOT allowed to add keys?

Defined in​

lib/types/protocol.ts:175


end​

Optional end: number

Block timestamp dictating the end of the public sale. If None, keys can be added indefinitely Measured in number of non-leap-nanoseconds since January 1, 1970 0:00:00 UTC.

Defined in​

lib/types/protocol.ts:190


max_num_keys​

Optional max_num_keys: number

Maximum number of keys that can be added to this drop. If None, there is no max.

Defined in​

lib/types/protocol.ts:166


price_per_key​

Optional price_per_key: string

Amount of $NEAR that the user needs to attach (if they are not the funder) on top of costs. This amount will be Automatically sent to the funder's balance. If None, the keys are free to the public.

Defined in​

lib/types/protocol.ts:171


start​

Optional start: number

Minimum block timestamp before the public sale starts. If None, keys can be added immediately Measured in number of non-leap-nanoseconds since January 1, 1970 0:00:00 UTC.

Defined in​

lib/types/protocol.ts:185