API

Helium Entity Manager 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

approve_maker_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
rewardable_entity_configimmutno
sub_daoimmutno
hnt_mintimmutno
escrowimmutno
authorityimmutno
makerimmutno
maker_approvalimmutno
system_programimmutno
token_programimmutno
associated_token_programimmutno
daoimmutno

Args

NameTypeDocs

approve_program_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
daoimmutno
authorityimmutno
program_approvalimmutno
system_programimmutno

Args

NameTypeDocs
args[object Object]

initialize_data_only_v0

Accounts

NameMutabilitySignerDocs
authorityimmutno
data_only_configimmutno
daoimmutno
tree_authorityimmutno
merkle_treeimmutno
collectionimmutno
token_accountimmutno
master_editionimmutno
metadataimmutno
token_metadata_programimmutno
log_wrapperimmutno
system_programimmutno
bubblegum_programimmutno
compression_programimmutno
token_programimmutno
associated_token_programimmutno

Args

NameTypeDocs
args[object Object]

initialize_maker_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
makerimmutno
daoimmutno
collectionimmutno
metadataimmutno
master_editionimmutno
token_accountimmutno
token_metadata_programimmutno
associated_token_programimmutno
system_programimmutno
token_programimmutno

Args

NameTypeDocs
args[object Object]

initialize_rewardable_entity_config_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
sub_daoimmutno
authorityimmutno
rewardable_entity_configimmutno
system_programimmutno

Args

NameTypeDocs
args[object Object]

issue_data_only_entity_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
ecc_verifierimmutno
collectionimmutno
collection_metadataimmutno
collection_master_editionimmutno
data_only_configimmutno
entity_creatorimmutno
daoimmutno
key_to_assetimmutno
tree_authorityimmutno
recipientimmutno
merkle_treeimmutno
data_only_escrowimmutno
bubblegum_signerimmutno
token_metadata_programimmutno
log_wrapperimmutno
bubblegum_programimmutno
compression_programimmutno
system_programimmutno

Args

NameTypeDocs
args[object Object]

issue_entity_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
ecc_verifierimmutno
issuing_authorityimmutno
collectionimmutno
collection_metadataimmutno
collection_master_editionimmutno
makerimmutno
entity_creatorimmutno
daoimmutno
key_to_assetimmutno
tree_authorityimmutno
recipientimmutno
merkle_treeimmutno
bubblegum_signerimmutno
token_metadata_programimmutno
log_wrapperimmutno
bubblegum_programimmutno
compression_programimmutno
system_programimmutno

Args

NameTypeDocs
args[object Object]

issue_iot_operations_fund_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
authorityimmutno
daoimmutno
entity_creatorimmutno
key_to_assetimmutno
recipientimmutno
recipient_accountimmutno
mintimmutno
metadataimmutno
master_editionimmutno
token_metadata_programimmutno
token_programimmutno
associated_token_programimmutno
system_programimmutno

Args

NameTypeDocs

issue_not_emitted_entity_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
authorityimmutno
daoimmutno
entity_creatorimmutno
key_to_assetimmutno
recipientimmutno
recipient_accountimmutno
mintimmutno
metadataimmutno
master_editionimmutno
token_metadata_programimmutno
token_programimmutno
associated_token_programimmutno
system_programimmutno
instructionsimmutno
no_emit_programimmutno

Args

NameTypeDocs

issue_program_entity_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
program_approverimmutno
program_approvalimmutno
collection_authorityimmutno
collectionimmutno
collection_metadataimmutno
collection_master_editionimmutno
entity_creatorimmutno
daoimmutno
key_to_assetimmutno
tree_authorityimmutno
recipientimmutno
merkle_treeimmutno
bubblegum_signerimmutno
token_metadata_programimmutno
log_wrapperimmutno
bubblegum_programimmutno
compression_programimmutno
system_programimmutno

Args

NameTypeDocs
args[object Object]

onboard_data_only_iot_hotspot_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
dc_fee_payerimmutno
iot_infoimmutno
hotspot_ownerimmutno
merkle_treeimmutno
dc_burnerimmutno
rewardable_entity_configimmutno
data_only_configimmutno
daoimmutno
key_to_assetimmutno
sub_daoimmutno
dc_mintimmutno
dcimmutno
compression_programimmutno
data_credits_programimmutno
token_programimmutno
associated_token_programimmutno
system_programimmutno
helium_sub_daos_programimmutno

Args

NameTypeDocs
args[object Object]

onboard_data_only_mobile_hotspot_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
dc_fee_payerimmutno
mobile_infoimmutno
hotspot_ownerimmutno
merkle_treeimmutno
dc_burnerimmutno
dnt_burnerimmutno
rewardable_entity_configimmutno
data_only_configimmutno
daoimmutno
key_to_assetimmutno
sub_daoimmutno
dc_mintimmutno
dnt_mintimmutno
dnt_priceimmutno
dcimmutno
compression_programimmutno
data_credits_programimmutno
token_programimmutno
associated_token_programimmutno
system_programimmutno
helium_sub_daos_programimmutno

Args

NameTypeDocs
args[object Object]

onboard_iot_hotspot_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
dc_fee_payerimmutno
issuing_authorityimmutno
iot_infoimmutno
hotspot_ownerimmutno
merkle_treeimmutno
dc_burnerimmutno
rewardable_entity_configimmutno
maker_approvalimmutno
makerimmutno
daoimmutno
key_to_assetimmutno
sub_daoimmutno
dc_mintimmutno
dcimmutno
compression_programimmutno
data_credits_programimmutno
token_programimmutno
associated_token_programimmutno
system_programimmutno
helium_sub_daos_programimmutno

Args

NameTypeDocs
args[object Object]

onboard_mobile_hotspot_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
dc_fee_payerimmutno
issuing_authorityimmutno
mobile_infoimmutno
hotspot_ownerimmutno
merkle_treeimmutno
dc_burnerimmutno
dnt_burnerimmutno
rewardable_entity_configimmutno
maker_approvalimmutno
makerimmutno
daoimmutno
key_to_assetimmutno
sub_daoimmutno
dc_mintimmutno
dnt_mintimmutno
dnt_priceimmutno
dcimmutno
compression_programimmutno
data_credits_programimmutno
token_programimmutno
associated_token_programimmutno
system_programimmutno
helium_sub_daos_programimmutno

Args

NameTypeDocs
args[object Object]

revoke_maker_v0

Accounts

NameMutabilitySignerDocs
refundimmutno
rewardable_entity_configimmutno
authorityimmutno
makerimmutno
maker_approvalimmutno
system_programimmutno

Args

NameTypeDocs

revoke_program_v0

Accounts

NameMutabilitySignerDocs
refundimmutno
daoimmutno
authorityimmutno
program_approvalimmutno
system_programimmutno

Args

NameTypeDocs
args[object Object]

set_entity_active_v0

Accounts

NameMutabilitySignerDocs
active_device_authorityimmutno
rewardable_entity_configimmutno
sub_daoimmutno
infoimmutno
helium_sub_daos_programimmutno

Args

NameTypeDocs
args[object Object]

set_maker_tree_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
update_authorityimmutno
makerimmutno
tree_authorityimmutno
merkle_treeimmutno
log_wrapperimmutno
system_programimmutno
bubblegum_programimmutno
compression_programimmutno

Args

NameTypeDocs
args[object Object]

swap_maker_stake

Accounts

NameMutabilitySignerDocs
payerimmutno
update_authorityimmutno
makerimmutno
maker_approvalimmutno
rewardable_entity_configimmutno
sub_daoimmutno
daoimmutno
dnt_mintimmutno
hnt_mintimmutno
new_stake_sourceimmutno
original_stake_destinationimmutno
original_stakeimmutno
new_escrowimmutno
associated_token_programimmutno
system_programimmutno
token_programimmutno
rentimmutno

Args

NameTypeDocs

temp_backfill_mobile_info

Accounts

NameMutabilitySignerDocs
payerimmutno
mobile_infoimmutno
system_programimmutno

Args

NameTypeDocs
args[object Object]

temp_pay_mobile_onboarding_fee_v0

Accounts

NameMutabilitySignerDocs
dc_fee_payerimmutno
dc_burnerimmutno
rewardable_entity_configimmutno
sub_daoimmutno
daoimmutno
dc_mintimmutno
dcimmutno
key_to_assetimmutno
mobile_infoimmutno
data_credits_programimmutno
token_programimmutno
associated_token_programimmutno
system_programimmutno
helium_sub_daos_programimmutno

Args

NameTypeDocs

temp_standardize_entity

Accounts

NameMutabilitySignerDocs
key_to_assetimmutno
merkle_treeimmutno
makerimmutno
data_only_configimmutno
tree_authorityimmutno
authorityimmutno
collectionimmutno
collection_metadataimmutno
leaf_ownerimmutno
payerimmutno
log_wrapperimmutno
compression_programimmutno
bubblegum_programimmutno
token_metadata_programimmutno
system_programimmutno

Args

NameTypeDocs
args[object Object]

update_data_only_tree_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
data_only_configimmutno
old_tree_authorityimmutno
new_tree_authorityimmutno
data_only_escrowimmutno
new_merkle_treeimmutno
log_wrapperimmutno
system_programimmutno
bubblegum_programimmutno
compression_programimmutno

Args

NameTypeDocs

update_iot_info_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
dc_fee_payerimmutno
iot_infoimmutno
hotspot_ownerimmutno
merkle_treeimmutno
tree_authorityimmutno
dc_burnerimmutno
rewardable_entity_configimmutno
daoimmutno
sub_daoimmutno
dc_mintimmutno
dcimmutno
bubblegum_programimmutno
compression_programimmutno
data_credits_programimmutno
token_programimmutno
associated_token_programimmutno
system_programimmutno

Args

NameTypeDocs
args[object Object]

update_maker_tree_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
makerimmutno
tree_authorityimmutno
new_tree_authorityimmutno
new_merkle_treeimmutno
log_wrapperimmutno
system_programimmutno
bubblegum_programimmutno
compression_programimmutno

Args

NameTypeDocs
args[object Object]

update_maker_v0

Accounts

NameMutabilitySignerDocs
makerimmutno
update_authorityimmutno

Args

NameTypeDocs
args[object Object]

update_mobile_info_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
dc_fee_payerimmutno
mobile_infoimmutno
hotspot_ownerimmutno
merkle_treeimmutno
tree_authorityimmutno
dc_burnerimmutno
rewardable_entity_configimmutno
daoimmutno
sub_daoimmutno
dc_mintimmutno
dcimmutno
bubblegum_programimmutno
compression_programimmutno
data_credits_programimmutno
token_programimmutno
associated_token_programimmutno
system_programimmutno

Args

NameTypeDocs
args[object Object]

update_rewardable_entity_config_v0

Accounts

NameMutabilitySignerDocs
payerimmutno
authorityimmutno
rewardable_entity_configimmutno
system_programimmutno

Args

NameTypeDocs
args[object Object]

Accounts

DaoV0

undefined

DataCreditsV0

undefined

DataOnlyConfigV0

undefined

IotHotspotInfoV0

undefined

KeyToAssetV0

undefined

MakerApprovalV0

undefined

MakerV0

undefined

MobileHotspotInfoV0

undefined

ProgramApprovalV0

undefined

RewardableEntityConfigV0

undefined

SubDaoV0

undefined

TreeConfig

undefined

Types

ApproveProgramArgsV0

FieldType
program_idpubkey

ConfigSettingsV0

VariantFields
IotConfigmin_gain: i32, max_gain: i32, full_location_staking_fee: u64, dataonly_location_staking_fee: u64
MobileConfigfull_location_staking_fee: u64, dataonly_location_staking_fee: u64
MobileConfigV1fees_by_device: [object Object]
MobileConfigV2fees_by_device: [object Object]

Creator

FieldType
addresspubkey
verifiedbool
shareu8

DaoV0

FieldType
hnt_mintpubkey
dc_mintpubkey
authoritypubkey
registrarpubkey
hst_poolpubkey
net_emissions_capu64
num_sub_daosu32
emission_schedule[object Object]
hst_emission_schedule[object Object]
bump_seedu8
rewards_escrowpubkey
delegator_poolpubkey
delegator_rewards_percentu64
proposal_namespacepubkey
recent_proposals[object Object]

DataCreditsV0

FieldType
dc_mintpubkey
hnt_mintpubkey
authoritypubkey
hnt_price_oraclepubkey
data_credits_bumpu8
account_payerpubkey
account_payer_bumpu8

DataOnlyConfigV0

FieldType
authoritypubkey
bump_seedu8
collectionpubkey
merkle_treepubkey
collection_bump_seedu8
daopubkey
new_tree_depthu32
new_tree_buffer_sizeu32
new_tree_spaceu64
new_tree_fee_lamportsu64

DecompressibleState

VariantFields
Enabled
Disabled

DeviceFeesV0

FieldType
device_type[object Object]
dc_onboarding_feeu64
location_staking_feeu64

DeviceFeesV1

FieldType
device_type[object Object]
dc_onboarding_feeu64
location_staking_feeu64
mobile_onboarding_fee_usdu64
reserved[object Object]

EmissionScheduleItem

FieldType
start_unix_timei64
emissions_per_epochu64

InitializeDataOnlyArgsV0

FieldType
authoritypubkey
new_tree_depthu32
new_tree_buffer_sizeu32
new_tree_spaceu64
new_tree_fee_lamportsu64
namestring
metadata_urlstring

InitializeMakerArgsV0

FieldType
update_authoritypubkey
issuing_authoritypubkey
namestring
metadata_urlstring

InitializeRewardableEntityConfigArgsV0

FieldType
symbolstring
settings[object Object]
staking_requirementu64

IotHotspotInfoV0

FieldType
assetpubkey
bump_seedu8
locationu64
elevationi32
gaini32
is_full_hotspotbool
num_location_assertsu16
is_activebool
dc_onboarding_fee_paidu64

IssueDataOnlyEntityArgsV0

FieldType
entity_keybytes

IssueEntityArgsV0

FieldType
entity_keybytes

IssueProgramEntityArgsV0

FieldType
entity_keybytes
key_serialization[object Object]
namestring
symbolstring
approver_seedsbytes
metadata_urlstring

KeySerialization

VariantFields
B58
UTF8

KeyToAssetV0

FieldType
daopubkey
assetpubkey
entity_keybytes
bump_seedu8
key_serialization[object Object]

MakerApprovalV0

FieldType
rewardable_entity_configpubkey
makerpubkey
bump_seedu8

MakerV0

FieldType
update_authoritypubkey
issuing_authoritypubkey
namestring
bump_seedu8
collectionpubkey
merkle_treepubkey
collection_bump_seedu8
daopubkey

MetadataArgs

FieldType
namestring
symbolstring
uristring
creators[object Object]

MobileDeploymentInfoV0

VariantFields
WifiInfoV0antenna: u32, elevation: i32, azimuth: u16, mechanical_down_tilt: u16, electrical_down_tilt: u16, serial: [object Object]
CbrsInfoV0radio_infos: [object Object]

MobileDeviceTypeV0

VariantFields
Cbrs
WifiIndoor
WifiOutdoor
WifiDataOnly

MobileHotspotInfoV0

FieldType
assetpubkey
bump_seedu8
locationu64
is_full_hotspotbool
num_location_assertsu16
is_activebool
dc_onboarding_fee_paidu64
device_type[object Object]
deployment_info[object Object]

OnboardDataOnlyIotHotspotArgsV0

FieldType
data_hash[object Object]
creator_hash[object Object]
root[object Object]
indexu32
locationu64
elevationi32
gaini32

OnboardDataOnlyMobileHotspotArgsV0

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

OnboardIotHotspotArgsV0

FieldType
data_hash[object Object]
creator_hash[object Object]
root[object Object]
indexu32
locationu64
elevationi32
gaini32

OnboardMobileHotspotArgsV0

FieldType
data_hash[object Object]
creator_hash[object Object]
root[object Object]
indexu32
locationu64
device_type[object Object]
deployment_info[object Object]

PercentItem

FieldType
start_unix_timei64
percentu8

ProgramApprovalV0

FieldType
daopubkey
program_idpubkey
bump_seedu8

RadioInfoV0

FieldType
radio_idstring
elevationi32

RecentProposal

FieldType
proposalpubkey
tsi64

RevokeProgramArgsV0

FieldType
program_idpubkey

RewardableEntityConfigV0

FieldType
authoritypubkey
symbolstring
sub_daopubkey
settings[object Object]
bump_seedu8
staking_requirementu64

SetEntityActiveArgsV0

FieldType
is_activebool
entity_keybytes

SetMakerTreeArgsV0

FieldType
max_depthu32
max_buffer_sizeu32

SubDaoV0

FieldType
daopubkey
dnt_mintpubkey
treasurypubkey
rewards_escrowpubkey
delegator_poolpubkey
vehnt_delegatedu128
vehnt_last_calculated_tsi64
vehnt_fall_rateu128
authoritypubkey
_deprecated_active_device_aggregatorpubkey
dc_burn_authoritypubkey
onboarding_dc_feeu64
emission_schedule[object Object]
bump_seedu8
registrarpubkey
_deprecated_delegator_rewards_percentu64
onboarding_data_only_dc_feeu64
dc_onboarding_fees_paidu64
active_device_authoritypubkey

TempBackfillMobileInfoArgs

FieldType
locationu64
deployment_info[object Object]

TempStandardizeEntityArgs

FieldType
root[object Object]
indexu32
current_metadata[object Object]

TreeConfig

FieldType
tree_creatorpubkey
tree_delegatepubkey
total_mint_capacityu64
num_mintedu64
is_publicbool
is_decompressible[object Object]

UpdateIotInfoArgsV0

FieldType
locationu64
elevationi32
gaini32
data_hash[object Object]
creator_hash[object Object]
root[object Object]
indexu32

UpdateMakerArgsV0

FieldType
issuing_authoritypubkey
update_authoritypubkey

UpdateMakerTreeArgsV0

FieldType
max_depthu32
max_buffer_sizeu32

UpdateMobileInfoArgsV0

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

UpdateRewardableEntityConfigArgsV0

FieldType
new_authoritypubkey
settings[object Object]
staking_requirementu64
Previous