API

Welcome Pack SDK

Quick tip

If you are looking for a quick start guide, check out the Getting Started guide. We also have some react examples here.

Instructions

claim_welcome_pack_v0

Accounts

NameMutabilitySignerDocs
claimerimmutno
rent_refundimmutno
asset_return_addressimmutno
ownerimmutno
welcome_packimmutno
rewards_mintimmutno
recipientimmutno
rewards_recipientimmutno
token_accountimmutno
queue_authorityimmutno
task_queueimmutno
task_queue_authorityimmutno
taskimmutno
tree_authorityimmutno
merkle_treeimmutno
log_wrapperimmutno
compression_programimmutno
system_programimmutno
mini_fanout_programimmutno
associated_token_programimmutno
token_programimmutno
bubblegum_programimmutno
tuktuk_programimmutno
lazy_distributor_programimmutno

Args

NameTypeDocs
args[object Object]

close_welcome_pack_v0

Accounts

NameMutabilitySignerDocs
ownerimmutno
welcome_packimmutno
user_welcome_packsimmutno
rent_refundimmutno
merkle_treeimmutno
tree_authorityimmutno
log_wrapperimmutno
compression_programimmutno
system_programimmutno
bubblegum_programimmutno

Args

NameTypeDocs
args[object Object]

initialize_welcome_pack_v0

Accounts

NameMutabilitySignerDocs
ownerimmutno
payerimmutno
rent_refundimmutno
lazy_distributorimmutno
recipientimmutno
asset_return_addressimmutno
user_welcome_packsimmutno
welcome_packimmutno
tree_authorityimmutno
leaf_ownerimmutno
merkle_treeimmutno
log_wrapperimmutno
compression_programimmutno
system_programimmutno
bubblegum_programimmutno

Args

NameTypeDocs
args[object Object]

Accounts

LazyDistributorV0

undefined

RecipientV0

undefined

UserWelcomePacksV0

undefined

WelcomePackV0

undefined

Types

ClaimWelcomePackArgsV0

FieldType
data_hash[object Object]
creator_hash[object Object]
root[object Object]
indexu32
approval_expiration_timestampi64
claim_signature[object Object]
task_idu16

CloseWelcomePackArgsV0

FieldType
data_hash[object Object]
creator_hash[object Object]
root[object Object]
indexu32

InitializeWelcomePackArgsV0

FieldType
sol_amountu64
rewards_split[object Object]
rewards_schedulestring
data_hash[object Object]
creator_hash[object Object]
root[object Object]
indexu32

LazyDistributorV0

FieldType
versionu16
rewards_mintpubkey
rewards_escrowpubkey
authoritypubkey
oracles[object Object]
bump_seedu8
approverpubkey

MiniFanoutShareArgV0

FieldType
walletpubkey
share[object Object]

OracleConfigV0

FieldType
oraclepubkey
urlstring

RecipientV0

FieldType
lazy_distributorpubkey
assetpubkey
total_rewardsu64
current_config_versionu16
current_rewards[object Object]
bump_seedu8
reservedu64
destinationpubkey

Share

VariantFields
Shareamount: u32
Fixedamount: u64

UserWelcomePacksV0

FieldType
next_idu32
ownerpubkey
bump_seedu8

WelcomePackV0

FieldType
idu32
ownerpubkey
assetpubkey
lazy_distributorpubkey
rewards_mintpubkey
rent_refundpubkey
sol_amountu64
rewards_split[object Object]
rewards_schedulestring
asset_return_addresspubkey
bump_seedu8
Previous