stack

Home > @infiniteobjects/models > TokenClaimCampaignModel

TokenClaimCampaignModel class

Token Claim Campaign Model

Signature:

export declare class TokenClaimCampaignModel extends BaseFirebaseEntity implements ITokenClaimCampaignSchema, ITokenClaimCampaign 

Extends: BaseFirebaseEntity

Implements: ITokenClaimCampaignSchema, ITokenClaimCampaign

Properties

Property Modifiers Type Description
active   boolean Is the campaign active?
blockchain   ITokenClaimCampaignSupportedBlockChains Blockchain the campaign is using
contractAddress   string Contract address of the campaign
device   Device IO Device
emailTemplateId   string Sendgrid email template ID
encryptionKey   string | null Encryption Key, only needed for SDK V2
factoryAddress   string Factory Contract Address
id   string Unique identifier
linkdropId   string ID of the campaign on linkdrop
makeVideoPrints   boolean Should we make VideoPrints
network   BlockchainNetwork Blockchain Network the campaign is running
networkName readonly ITokenClaimCampaignNetworkNames Returns the networkName for the chosen blockchain
preferredWallet?   TokenClaimCampaignPreferredWallet (Optional) Preferred wallet
printType   VideoPrintType Print Type
schemaVersion   TokenClaimCampaignSchemaVersion Schema Version
sdkVersion   TokenClaimCampaignLinkdropSdkVersion SDK Version
shopifyProductId   number Shopify product ID
shopifyStoreId   string Shopify store ID
signingKey   string Contract address of the campaign
tokenStartIndex   number What is the first token?
tokenSupply   number How many tokens
useManualClaim   boolean Use manual claim
walletAddress   string Deployer Wallet Addres (Master Address)

Methods

Method Modifiers Description
createTokenClaims()   Creates token claims based on the supplied token supply
getUnusedClaim()   Picks a random unused token claim
isComplete()   Checks if all the tokens of the campain have been used
pickRandomClaimId()   Picks a random token claim id
toEmbedded()   Serializes this class as an simplified object
toModel(admin)   Serializes this class back to the model
toSchema()   Serializes this class to the Schema type