Repository files navigation

A collection of solana programs used for Helium's Solana integration

flowchart TD  hotspot[[Hotspots]]  ingest[[Packet Router]]  s3[[S3 Storage]]  verify[Verifier]  rewards[Rewards]  oracle_rds[[Oracle RDS]]  rewards_oracle[[Rewards Oracle]]  solana[[Solana]]  oui[[OUI]]  iot[[Iot Devices]]  hotspot --> ingest  ingest --> s3  s3 --> verify  verify --valid packets--> s3  s3 --> rewards  rewards --> oracle_rds  oracle_rds --> rewards_oracle  rewards_oracle --Hotspot Lifetime Rewards--> solana  ingest --> oui  iot --> hotspot

flowchart TD  maker[Maker App]  onboarding[Onboarding Server]  crank(((Rewards Crank)))  hnt_price_oracle[[HNT Price Oracle]]  oracles[[DNT Rewards Oracle]]  wallet_app[Wallet App]  oracles --set and distribute rewards tx--> wallet_app  wallet_app --> lazy_distributor  subgraph Solana    manager[Hotspot Manager]    data_credits[Data Credits]    dnt_rewards_escrow{{DNT Escrow}}    hotspots{{Hotspot NFTs}}    helium_sub_daos[Helium Sub Daos]    lazy_distributor[Lazy Distributor]    treasury_management[Treasury Management]    user_wallet{{Hotspot Owner Wallet}}    treasury{{SubDAO Treasury}}  end  data_credits --DC Burned--> helium_sub_daos  onboarding --issue hotspot, assert location txs--> maker  maker --issue hotspot, assert location--> manager  hnt_price_oracle --HNT Price--> data_credits  dnt_rewards_escrow --> lazy_distributor  manager --Burn DC--> data_credits  manager --Create--> hotspots  manager --Device Count--> helium_sub_daos  crank --issue rewards--> helium_sub_daos  helium_sub_daos --DNT--> dnt_rewards_escrow  helium_sub_daos --set expiry--> treasury_management  helium_sub_daos --mint_hnt--> treasury  treasury -->  treasury_management  hotspots --> lazy_distributor  lazy_distributor --DNT--> user_wallet

Helium Sub Daos manages the daos and rewards structure of the Helium ecosystem. Other programs in the ecosystemare expected to call out to helium sub daos to update rewardable actions, like issuing a new hotspot and burningdata credits

Data credits manages the soulbound helium data credits, and how they can be burned to do several actions on the network. It also manages reading from an oracle to allow burning HNT for data credits

Helium Entity Manager is responsible for issuing the various types of hotspots and rewardable entities that Helium supports (wifi, iot, mobile hotspots, mobile mappers, etc)

The lazy distributor is an oracle-powered token distributor that distributes tokens to holdersof particular NFTs as specified by oracles.

In order to facilitate setting rewardsand distributing rewards in a single Solana transaction,I propose at the url specified in the oracle configuration, supportingGET andPOST

Request current rewards for the hotspot. Provide?mint=... query param with the hotspot mint.

Which should return

{  "currentRewards": ...}

Sign transaction to set rewards and distribute

{  transaction: ... // serialized transaction}

Which should return

{  transaction: ... // signed transaction}

Before signing the transaction, the oracle should validate (1) that the transaction contains only

• setCurrentRewards instructions from other validators
• distribute instructions

and (2) that the amount set forsetCurrentRewards for itself is correct.

The client should:

• Submit requests to all oracles to get the current total rewards amount
• Form instructions to set rewards from all oracles using their specified rewards amount
• Submit a sign transaction request to all oracles sequentially
• Submit the signed transaction to Solana

1. Make sure you're using Node 18+

2. Install dependencies

corepack enableyarn set version 3.6.4yarn

3. Start localnet

$: TESTING=true anchor localnet

4. Start watcher

$: yarn watch

5. Bootstrap localnet

$: . ./scripts/bootstrap-localnet.sh

6. Run tests against localnet

$: anchor test --provider.cluster localnet --skip-deploy --skip-local-validator --skip-build

If you run into trouble with your installation, run the following command to rebuild everything from scratch.

$: yarn clean && yarn && TESTING=true anchor build && yarn build

There's several packages that can be run as servers or applications. The individual instructions for them are included below.

• Start monitor

$: cd packages/monitor-service && yarn dev$: cd packages/monitor-service/docker-compose && docker-compose up -d

• Start breakpoint demo ui

$: cd packages/breakpoint-demo-ui && yarn start

• Start oracle server

$: cd packages/distributor-oracle && yarn start

• Start xNFT

$: cd packages/xnft-hotspot && yarn dev

Important urls:

• localhost:3000 // demo ui
• localhost:3001 // grafana