Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated sections in 'Network Architecture' #1857

Closed
wants to merge 1 commit into from
Closed

Updated sections in 'Network Architecture' #1857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/architecture/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ In the interest of anonymity, the latitude/longitude data provided by the API is
[H3](https://h3geo.org/docs/core-library/restable/) resolution 8 rather than resolution 12 stored
on-chain on Solana.

An active Hotspot is defined as having rewards issued within the last 30 days (either for Proof of
Coverage or data transfer).
An active Hotspot is defined as having rewards issued within the last 30 days (either for
Proof-of-Coverage or data transfer).

## Wallet Info by Wallet Public Key

Expand Down
3 changes: 0 additions & 3 deletions docs/architecture/hotspot-makers/become-a-maker/burn-hnt-to-maker-wallet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,6 @@ slug: /hotspot-makers/become-a-maker/burn-hnt-to-maker-wallet
# Burning HNT to Your Maker Wallet

import useBaseUrl from '@docusaurus/useBaseUrl'
import LegacyContentBanner from '@site/src/theme/LegacyContentBanner'

<LegacyContentBanner />

Any [approved Hotspot Maker](/network-iot/hotspots-iot/full-hotspots) is responsible for supplying
Data Credits (DCs) to the onboarding server for Hotspots they sell. They do this by burning HNT to
Expand Down
7 changes: 2 additions & 5 deletions docs/architecture/hotspot-makers/become-a-maker/funding-a-maker-account.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@ slug: /hotspot-makers/become-a-maker/funding-a-maker-account
---

import useBaseUrl from '@docusaurus/useBaseUrl'
import LegacyContentBanner from '@site/src/theme/LegacyContentBanner'

<LegacyContentBanner />

Hotspot Makers must fund Maker wallets with enough Data Credits ("DC") and SOL to cover the
onboarding fees for all Hotspots they supply to customers.
Expand All @@ -28,7 +25,7 @@ A current public view on the funding status of Maker wallets is available at:

[https://dune.com/helium-foundation/helium-makers][dune-makers]

See "Data Credits By Hotspot ManufacturerH. Helium Maker DC Balances"
See "Data Credits By Hotspot Manufacturer Helium Maker DC Balances"

### SOL Fees

Expand Down Expand Up @@ -64,7 +61,7 @@ These tokens are "burned".

Funding a Maker wallet with SOL is performed the same way as sending tokens to any crypto wallet.
Send from an exchange, another wallet, or swap from another cryptocurrency within the [Helium
Wallet][helium-wallet] using the inbuilt browser and a swap aggregator such as [Jupiter][jupiter].
Wallet][helium-wallet] using the in-built browser and a swap aggregator such as [Jupiter][jupiter].

---

Expand Down
23 changes: 10 additions & 13 deletions docs/architecture/hotspot-makers/become-a-maker/hotspot-integration-testing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,8 @@ slug: /hotspot-makers/become-a-maker/hotspot-integration-testing
---

import useBaseUrl from '@docusaurus/useBaseUrl'
import LegacyContentBanner from '@site/src/theme/LegacyContentBanner'

<LegacyContentBanner />

This guide is intended for companies that have been approved via HIP-19 and successfully passed the
This guide is intended for companies that have been approved via HIP 19 and successfully passed the
hardware audit stage.

All Makers and prospective makers are required to develop, and make available to their customers,
Expand Down Expand Up @@ -61,17 +58,17 @@ Support for any other operating system will not be available.

:::info

Makers in the HIP-19 process can continue to submit their Hotspots to the Hotspot App for
Makers in the HIP 19 process can continue to submit their Hotspots to the Hotspot App for
integration. However, all active Makers by March 1, 2022 must have their own Maker app available on
App Stores.

:::

To add your Hotspot to the Hotspot App, follow the
[Maker Guide](https://github.com/helium/hotspot-app/tree/main/src/makers) in GitHub and
[submit a pull request to the Hotspot Github Repo](https://github.com/helium/hotspot-app).
[submit a pull request to the Hotspot GitHub Repo](https://github.com/helium/hotspot-app).

In this codebase, you’ll want to modify the onboarding flow to add a UI element that enables users
In this codebase, you'll want to modify the onboarding flow to add a UI element that enables users
to select your Hotspot type on this screen, add support emails to Diagnostic Reports (Bluetooth
only), add additional onboarding instructions (web/QR) and include default antenna TX/RX gain:

Expand Down Expand Up @@ -137,7 +134,7 @@ To select Bluetooth onboarding, in the `hotspot.ts` file, specify `BLE` in `onbo

# Constructing the Add Gateway Transaction

If you’re using [Helium’s miner image](https://github.com/helium/miner), constructing a transaction
If you're using [Helium's miner image](https://github.com/helium/miner), constructing a transaction
is relatively easy.

Every Hotspot on the blockchain goes through two transactions:
Expand All @@ -160,9 +157,9 @@ appropriate stage with the Manufacturing Compliance Committee. The current list
[here](https://onboarding.dewi.org/api/v2/makers).

When testing with this `payer` address, adding hotspots and asserting location transactions will be
submitted and you’ll see them as pending transactions in the Hotspot App. However, once it reaches
submitted and you'll see them as pending transactions in the Hotspot App. However, once it reaches
the blockchain, the transaction will be discarded as the payer address does not exist in the
blockchain’s `chain_var` of valid addresses. This ensures no Data Credits are spent on testing, but
blockchain's `chain_var` of valid addresses. This ensures no Data Credits are spent on testing, but
allows trial and error as Makers finish app integration.

Once you have the transaction, you will pass it onto the Helium app to sign the transaction. Once
Expand Down Expand Up @@ -193,7 +190,7 @@ By design, this transaction will fail, as this is a test account.

:::

Once you’re ready to proceed, request a Maker account and replace the test payer address with your
Once you're ready to proceed, request a Maker account and replace the test payer address with your
own maker address.

## Requesting a Maker Account
Expand Down Expand Up @@ -229,7 +226,7 @@ Maker IDs are sequential and cannot be customized.

### Testing

When you’re ready to start integration with the Test Maker account with the mobile wallet app, send
When you're ready to start integration with the Test Maker account with the mobile wallet app, send
us details about your Test Hotspot in this JSON format. :

```json
Expand Down Expand Up @@ -293,7 +290,7 @@ The final steps and flow for production onboarding are as follows:
3. Go through the Onboarding process in the Hotspot app. The app will check the Onboarding server
for the Hotspot and verify the Maker ID. The app will then sign the transaction and submit to the
blockchain.
4. You’ll see a pending transaction in your Maker address.
4. You'll see a pending transaction in your Maker address.
5. The blockchain will process the `add_gateway` and `assert_location` transaction and verify that
the maker address is in the chain variable.
6. The transaction will go through and Data Credits will be deducted from the Maker account.
Expand Down
6 changes: 1 addition & 5 deletions docs/architecture/hotspot-makers/become-a-maker/maker-approval-auditing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ image: https://docs.helium.com/img/link-image.png
slug: /hotspot-makers/become-a-maker/maker-approval-auditing
---

import LegacyContentBanner from '@site/src/theme/LegacyContentBanner'

<LegacyContentBanner />

# Maker Approval and Auditing Process

Due to the overwhelming demand for Hotspots, the community designed and approved a process for
Expand All @@ -20,7 +16,7 @@ adding new, verified manufactures to the ecosystem.
With HIP 19 in place, companies can submit an application to be reviewed by the community and the
[Helium Foundation](https://www.helium.foundation).

The full process for approving and auditing new manafacturers is as follows
The full process for approving and auditing new manufacturers is as follows
([originally outlined in this blog post](/devblog/2021/01/26/maker-audit)):

1. Makers submit a HIP-19 Proposal.
Expand Down
Loading