Vibrant Documentation
  • ๐Ÿ‘‹Welcome to Vibrant
  • Overview
    • ๐Ÿ’กWhat we do
    • โ›“๏ธSupported Blockchains
    • โœจOur Features
    • ๐Ÿ™ŒFree Version
  • Discord Basics
    • ๐Ÿ› ๏ธGetting set up
      • ๐Ÿค–Inviting the bot
      • ๐Ÿ“Setting permissions
      • โœ…Verification Setup
    • โฉNext steps
    • ๐ŸŽจCustomize your Community
  • Guides
    • ๐ŸŽจFor NFT projects
      • ๐ŸงชPre-Mint
      • ๐ŸงฑMint
      • ๐Ÿš€Post launch
      • ๐Ÿ™๏ธCommunity Building
      • โญAdvanced Token Roles
      • ๐ŸคConnect with other Communities
    • ๐ŸŒŠFor Stakepools
      • ๐Ÿง‘Delegation Roles
      • โ•Stakepool Updates
      • ๐Ÿ™๏ธCommunity Building
    • ๐Ÿ“ˆFor DeFi Projects
      • ๐Ÿง‘Token Roles
      • ๐Ÿ™๏ธCommunity Building
    • ๐ŸคFor DAOs
      • ๐Ÿง‘Token Roles
      • ๐Ÿ—ณ๏ธVoting and Decisions
      • ๐Ÿ™๏ธCommunity Building
  • Discord Commands
    • User Commands
      • General
        • โ”/help
        • โ„น๏ธ/info
        • ๐Ÿ›ก๏ธ/policyid
        • ๐Ÿ—ณ๏ธ/vote
        • ๐Ÿง‘/whois
        • ๐Ÿˆ/premium
        • ๐Ÿ›’/claim
      • Verification
        • โ”/verify help
        • ๐Ÿ“ƒ/verify list
        • โž•/verify add
        • ๐Ÿ”—/verify link
        • โšก/verify unlink
        • ๐Ÿ›‘/verify cancel
        • ๐Ÿ—‘๏ธ/verify remove
      • Whitelist Signup
        • ๐Ÿ“ƒ/whitelist list
        • ๐Ÿ—ณ๏ธ/whitelist register
        • ๐Ÿ—‘๏ธ/whitelist unregister
      • Messaging
        • ๐Ÿ“ฉ/ping send
        • ๐Ÿ“ƒ/ping list
      • Profile
        • ๐Ÿ”ฒ/profile toggle
        • ๐Ÿ“›/profile defaulthandle
    • Admin Commands
      • General Administration
        • โ–ถ๏ธ/start
        • ๐Ÿ“ข/configure-social announce
        • โœ”๏ธ/configure-verify announce
      • Policy IDs
        • ๐Ÿ“ƒ/configure-policyid list
        • โž•/configure-policyid add
        • ๐Ÿ“ข/configure-policyid announce
        • ๐Ÿ”ข/configure-policyid mintcounter
        • ๐Ÿ—‘๏ธ/configure-policyid remove
      • NFT/Token Roles
        • ๐Ÿ“ƒ/configure-tokenroles list
        • ๐Ÿ”ค/configure-tokenroles details
        • โž•/configure-tokenroles add
        • ๐Ÿงช/configure-tokenroles test
        • โœ๏ธ/configure-tokenroles update
        • ๐Ÿ›ก๏ธ/configure-tokenroles policies add
        • โšก/configure-tokenroles policies remove
        • โž•/configure-tokenroles metadatafilter add
        • โšก/configure-tokenroles metadatafilter remove
        • ๐Ÿ—‘๏ธ/configure-tokenroles remove
      • Widgets & Info
        • โŒš/configure-info epochclock
      • Stakepools
        • ๐Ÿ“ƒ/configure-stakepool list
        • โž•/configure-stakepool add
        • ๐Ÿ—‘๏ธ/configure-stakepool remove
      • Delegator Roles
        • ๐Ÿ“ƒ/configure-delegatorroles list
        • โž•/configure-delegatorroles add
        • ๐Ÿงช/configure-delegatorroles test
        • ๐Ÿ—‘๏ธ/configure-delegatorroles remove
      • Polls and Votes
        • ๐Ÿ“ƒ/configure-poll list
        • โž•/configure-poll add
        • ๐Ÿ”—/configure-poll add-onchain
        • ๐Ÿ“ข/configure-poll announce
        • ๐Ÿง‘/configure-poll update addrole
        • โšก/configure-poll update removerole
        • ๐Ÿ—‘๏ธ/configure-poll remove
      • Giveaways
        • ๐Ÿ“ƒ/configure-giveaway list
        • โž•/configure-giveaway add
        • ๐Ÿ“ข/configure-giveaway announce
        • โน๏ธ/configure-giveaway end
        • ๐Ÿง‘/configure-giveaway update addrole
        • โšก/configure-giveaway update removerole
        • ๐Ÿ—‘๏ธ/configure-giveaway remove
      • Whitelists
        • ๐Ÿ“ƒ/configure-whitelist list
        • โž•/configure-whitelist add
        • ๐Ÿ›‘/configure-whitelist close
        • ๐Ÿšช/configure-whitelist open
        • ๐Ÿ“ข/configure-whitelist announce
        • โœ๏ธ/configure-whitelist update
        • ๐ŸŽ/configure-whitelist share
        • ๐Ÿšซ/configure-whitelist unshare
        • ๐Ÿ”ฝ/configure-whitelist download
        • ๐Ÿ—‘๏ธ/configure-whitelist remove
      • Scam Protection
        • ๐Ÿ’ก/configure-protection status
        • ๐Ÿ’‚โ€โ™€๏ธ /configure-protection addressremove
        • ๐Ÿ‘‚/configure-protection auditchannel
      • Marketplace & Minting
        • ๐Ÿ›’Sales
          • ๐Ÿ“ƒ/configure-marketplace sales list
          • ๐Ÿ›’/configure-marketplace sales add
          • ๐Ÿ—‘๏ธ/configure-marketplace sales remove
        • ๐Ÿ’ฒListings
          • ๐Ÿ“ƒ/configure-marketplace listings list
          • ๐Ÿ’ฒ/configure-marketplace listings add
          • ๐Ÿ—‘๏ธ/configure-marketplace listings remove
        • ๐ŸงฑMint
          • ๐Ÿ“ƒ/configure-marketplace mint list
          • ๐Ÿงฑ/configure-marketplace mint add
          • ๐Ÿ—‘๏ธ/configure-marketplace mint remove
        • โž•/configure-marketplace metadatafilter add
        • ๐Ÿ—‘๏ธ/configure-marketplace metadatafilter remove
      • Settings and Premium
        • โš™๏ธ/configure-settings features
        • ๐ŸŽจ/configure-settings customize
        • โ™ฅ๏ธ/configure-healthcheck
        • โ„น๏ธ/configure-premium status
        • ๐Ÿ”‹/configure-premium refill
      • Admin Roles
        • ๐Ÿ“ƒ/configure-adminaccess list
        • ๐Ÿ”’/configure-adminaccess add
        • ๐Ÿ”“/configure-adminaccess remove
      • API Access
        • ๐Ÿšช/configure-api generatetoken
        • ๐Ÿ›ก๏ธ/configure-api removetoken
Powered by GitBook
On this page

Was this helpful?

  1. Discord Commands
  2. Admin Commands
  3. Giveaways

/configure-giveaway add

Add a new giveaway and its details

Black Edition

With the /CONFIGURE-GIVEAWAY ADD command you can create powerful giveaways for your community, right within Discord. The giveaways range from simple raffles for everyone on your server to weighted giveaways based on token ownership for verified wallets with dedicated snapshot dates and drawing multiple winners.

There are multiple steps to create a giveaway after running the actual command, and these steps have to be done in a specific order, as described below. Ensure that you run these commands in a channel the bot has rights to Read Messages, because certain inputs are typed into the channel. We highly recommend to use a private channel or channel only your moderators have access to.

  • 1. Description

    Provide a description to explain what your are giving away

    The description has to be typed into the channel and can contain Discord markup to make it more interesting or readable. There is a 4000 character limit in place for your giveaway description. The whole description has to be sent in one message and should include what the prizes are. After sending the message, the giveaway widget will show you a preview of your text and you can click a button to either to start over with another description or to use the one you typed and move on to step 2.

  • 2. Configuration

    Choose the settings for your giveaway

    You can now choose your settings, like what data about the winners you want to receive (Discord info or wallet address). You can also determine if in a multi-winner scenario the same person can be drawn multiple times. Lastly, you can determine if only verified token-owners can participate in your giveaway or if anyone can join. If you choose Everyone, you can immediately create the giveaway with the Create giveaway button.

    If you choose to that only token holders can join (either one entry per holder or weighted based on number of tokens owned), the giveaway system will let you click Provide token details in an optional 3rd step.

  • 3. Optional: Token details

    Provide token policy ID and optional asset fingerprint for a participation snapshot

    As the last step, if doing a token-based giveaway, you can now send a message to the channel with the policy ID that determines who can join and who cannot. In addition, you can also provide an asset fingerprint, if you are using a policy that has multiple different fungible tokens minted on it and you would just like to allow one of them to be used in the ownership/weighting calculation. If using asset fingerprints, your message should look as follows: policyid+assetfingerprint.

    Once the details have been sent to the channel and the format of the policy ID and asset fingerprint have been verified, you can click Create Giveaway. This will kick off a blockchain snapshot (at snapshot-time or immediately, if not set) to collect the current owners of tokens for the given policy ID. Only the users that have the respective verified wallet can participate in the giveaway.

Below are the initial options you can provide to the command, which will further allow you to customize your giveaway, set up automatic announcements etc.

Parameter
Details

giveaway-displayname

The display name for your giveaway. It is the official name shown in all announcements.

giveaway-name

The internal name for the giveaway. It is used for API access and can only contain lower and upper case letters from A-Z, as well as numbers. Your users will never see this name.

[giveaway-opentime]

Optional: The exact time at which the giveaway opens, in the specific format

in UTC time zone (note the T between date and time and the Z at the end). After the giveaway opens, anyone who fulfills the conditions can participate. If you have designated a publish-channel, this is also the time at which the giveaway widget will be posted there. If no opening time is provided, users will immediately be able to participate.

[giveaway-closetime]

Optional: The exact time at which the giveaway closes, in the specific format

in UTC time zone. After this time, no one can participate in the giveaway any more, even if they fulfill all the conditions. No automatic announcement will be made at giveaway close time. If you do not provide a closing time, people can participate until /CONFIGURE-GIVEAWAY-END is used or the giveaway is deleted.

[snapshot-time]

Optional: The exact time at which the token snapshot is made, if you are setting up a token-based giveaway. It has to be provided in the specific format

in UTC time zone (note the T between date and time and the Z at the end). If you do not provide a snapshot time but still enter token details, the snapshot will be taken in the 30 minutes after the giveaway is created.

[image-url]

Optional: A URL to an image that will be displayed underneath your giveaway, to showcase your prizes or a logo.

[winner-count]

Optional: The number of winners you would like to draw from all entries at the end of the giveaway. If you do not provide this number, one single winner will be drawn when using /CONFIGURE-GIVEAWAY-END.

[required-role]

Optional: If you want to limit the people that can participate in a giveaway, you can add one or more roles that are required to join the giveaway. This role can be manually assigned or can be a token- or delegation- based role managed by Vibrant. Keep in mind, that this is not an replacement for snapshot-based join conditions, but an additional mechanism. This is because roles can change when people trade tokens or redelegate. When using a token-based giveaway, only the data from the snapshot (at giveaway creation time) is considered.

[channel]

Optional: The channel in which you would like to automatically post the announcement and join widget at the time the giveaway opens. The bot will need Send Messages permission on the selected channel. If you do not provide a channel, you can always manually publish the giveaway info via /CONFIGURE-GIVEAWAY ANNOUNCE

Previous/configure-giveaway listNext/configure-giveaway announce

Last updated 1 year ago

Was this helpful?

โž•
2022-01-01T19:00:00Z
2022-02-05T23:00:00Z
2022-01-01T19:00:00Z