Skip to content
Node SDK roadmap

Plan your integration with the provider team.

The embedded AntGain Node SDK is planned and is not yet available for general use. Contact the provider team to discuss an integration. Explore our plans for embedding AntGain in an application, including user consent, node controls, and integration support.

  • Planned SDK. The SDK is not yet available for general use.
  • Consent first. Users choose whether to enable sharing.
  • Private credentials. Use integration credentials that can be revoked.
Conceptual illustration of planned Node SDK integration. It does not indicate release availability.

Consent first

Users choose when to share.

Bandwidth sharing must be clearly opt-in, visible to the user, and easy to pause or remove.

User control 01

Ask permission before sharing starts

Explain bandwidth sharing clearly and ask users to opt in before it starts.

User control 02

Explain what sharing does

Show that the application uses AntGain or shares bandwidth, so users understand what they are enabling.

User control 03

Provide pause, stop, and removal controls

Let users pause, stop, and remove sharing without needing to contact support.

User control 04

Ask for a separate choice to share

Ask for a separate choice to enable sharing. Do not use preselected options or treat an unrelated action as consent.

User control 05

Keep required consent records private

Keep any consent records required by law or your agreement private. Do not send unnecessary personal information to public analytics.

Planned integration capabilities

Explore the planned integration features.

The planned SDK focuses on sign-in, start and stop controls, and the information needed to manage a deployment.

Planned capability

Partner authentication

Integration guidance

Use credentials intended for your integration. Keep long-term partner credentials out of distributed applications and public examples.

Planned capability

Node identity

Integration guidance

Plan how devices will be registered and linked to your integration. Keep private device, network, and user details out of public forms.

Planned capability

Monitoring and support

Integration guidance

Collect only the connection, version, and support information needed to manage the integration. Exclude browsing history, traffic destinations, and unrelated app activity.

Partner planning

Payout and revenue share

Integration guidance

Confirm rewards, payment options, and revenue sharing in your provider agreement or account before rollout. The SDK does not set these terms.

Planned capability

Start and stop controls

Integration guidance

Provide clear start, stop, status, and removal controls. Sharing must stop when a user disables it.

Planned capability

Remote control

Integration guidance

Limit remote actions to approved AntGain node controls and settings. The integration must not allow arbitrary commands or code to run on the device.

Keep sharing controls clear and private data protected.

The planned SDK is limited to bandwidth-sharing functions, with clear user controls and careful handling of private data.

Security 01

Keep partner credentials private

Keep passwords, API keys, private keys, and partner credentials out of public forms and distributed examples.

Security 02

Get permission before starting

Get explicit permission before starting sharing on a device or connection controlled by an end user.

Security 03

Collect only the information needed for sharing

Do not collect unrelated browsing activity, traffic destinations, balances, or wallet details for integration analytics.

Security 04

Limit remote actions to node controls

The planned SDK does not include general access to device files, software installation, or arbitrary commands.

Security 05

Let partners and users stop sharing

Partners must be able to stop rollout and revoke the integration. Users must be able to disable or remove sharing.

Measuring rollout

Track connections and activity after installation.

These milestones describe a planned rollout, from the first connected node to ongoing activity. Pageviews and downloads alone do not show active sharing.

Integration milestone

SDK integration started
Track meaningful rollout progress without exposing sensitive user or node data.

Integration milestone

First SDK node online
Track meaningful rollout progress without exposing sensitive user or node data.

Integration milestone

SDK node stays active
Track meaningful rollout progress without exposing sensitive user or node data.

Integration milestone

SDK devices with recorded activity
Track meaningful rollout progress without exposing sensitive user or node data.

Integration milestone

Recorded traffic from the SDK channel
Track meaningful rollout progress without exposing sensitive user or node data.
Next step

Ready to discuss an embedded integration?

Tell the provider team about your platforms, device count, setup, user consent, and start/stop controls. The SDK is planned; the team will confirm which integration options are available.