`@helium/wallet-link`

Utilities for linking a 3rd party app to the helium wallet. The link token is used for hotspot onboarding, location assertion, and ownership transfer transaction signing with the Helium Wallet and Hotspot apps.

Installation

React Native

$ yarn add @helium/wallet-link @helium/crypto-react-native
$ yarn add --dev patch-package postinstall-postinstall
# or
$ npm install @helium/wallet-link @helium/crypto-react-native
$ npm install --save-dev patch-package

When using this library in React Native you must patch the @helium/crypto calls with @helium/crypto-react-native. You can do this using patch-package by adding the following file to your React Native root at /patches/@helium+wallet-link+4.6.1.patch.

diff --git a/node_modules/@helium/wallet-link/build/walletLink.js b/node_modules/@helium/wallet-link/build/walletLink.js
index 5378554..de9d701 100644
--- a/node_modules/@helium/wallet-link/build/walletLink.js
+++ b/node_modules/@helium/wallet-link/build/walletLink.js
@@ -17,7 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createUpdateHotspotUrl = exports.createSignHotspotCallbackUrl = exports.createLinkWalletCallbackUrl = exports.createWalletLinkUrl = exports.parseWalletLinkToken = exports.verifyWalletLinkToken = exports.makeAppLinkAuthToken = void 0;
 /* eslint-disable object-curly-newline */
 const address_1 = __importDefault(require("@helium/address"));
-const crypto_1 = require("@helium/crypto");
+const crypto_1 = require("@helium/crypto-react-native");
 const query_string_1 = __importDefault(require("query-string"));
 const date_fns_1 = require("date-fns");
 const types_1 = require("./types");

In your package.json add the following script to run the patch on postinstall:

 "scripts": {
+  "postinstall": "patch-package"
 }

Lastly run yarn or npm install and the patch will be installed.

Browser or other JS environments

$ yarn add @helium/wallet-link @helium/crypto
# or
$ npm install @helium/wallet-link @helium/crypto

Usage

// Create link to Helium app
const url = createWalletLinkUrl({
  universalLink: 'https://wallet.helium.com/',
  requestAppId: 'com.maker.app',
  callbackUrl: 'makerappscheme://',
  appName: 'Maker App',
})

Linking.openURL(url)

// parse received token
const parsed = parseWalletLinkToken(token)

// verify token
const verified = verifyWalletLinkToken(parsed)

// verify token with max age
const verified = verifyWalletLinkToken(parsed, { maxAgeInSeconds: 60 })

// Create link to update a hotspot
const updateParams = {
  token,
  platform: Platform.OS,
  addGatewayTxn: 'your_optional_unsigned_txn',
  assertLocationTxn: 'your_optional_unsigned_txn',
  transferHotspotTxn: 'your_optional_unsigned_txn',
} as SignHotspotRequest

const url = createUpdateHotspotUrl(updateParams)
Linking.openURL(url)

// submit signed txn

Index

Type Aliases

Variables

Functions

Type Aliases

DelegateApp

DelegateApp: { androidPackage: string; appStoreId: number; iosBundleId: string; name: string; universalLink: string }

Type declaration

androidPackage: string
appStoreId: number
iosBundleId: string
name: string
universalLink: string

LinkWalletRequest

LinkWalletRequest: { appName: string; callbackUrl: string; requestAppId: string }

Type declaration

appName: string
callbackUrl: string
requestAppId: string

LinkWalletResponse

LinkWalletResponse: { status: "success" | "user_cancelled"; token?: string }

Type declaration

status: "success" | "user_cancelled"
Optional token?: string

MakerApp

MakerApp: { androidPackage: string; iosBundleId: string; name: string; universalLink: string }

Type declaration

androidPackage: string
iosBundleId: string
name: string
universalLink: string

SignHotspotRequest

SignHotspotRequest: { addGatewayTxn?: string; assertLocationTxn?: string; solanaTransactions?: string; token: string; transferHotspotTxn?: string }

Type declaration

Optional addGatewayTxn?: string
Optional assertLocationTxn?: string
Optional solanaTransactions?: string
token: string
Optional transferHotspotTxn?: string

SignHotspotResponse

SignHotspotResponse: { assertTxn?: string; gatewayAddress?: string; gatewayTxn?: string; solanaTransactions?: string; status: "success" | "token_not_found" | "user_cancelled" | "gateway_not_found" | "invalid_link"; transferTxn?: string }

Type declaration

Optional assertTxn?: string
Optional gatewayAddress?: string
Optional gatewayTxn?: string
Optional solanaTransactions?: string
status: "success" | "token_not_found" | "user_cancelled" | "gateway_not_found" | "invalid_link"
Optional transferTxn?: string

Token

Token: LinkWalletRequest & { address: string; signingAppId: string; time: number }

TokenWithSig

TokenWithSig: Token & { signature: string }

Variables

Const HELIUM_HOTSPOT_APP

HELIUM_HOTSPOT_APP: DelegateApp = ...

Const HELIUM_WALLET_APP

HELIUM_WALLET_APP: DelegateApp = ...

Functions

createLinkWalletCallbackUrl

createLinkWalletCallbackUrl(protocol: string, address: string, responseParams: LinkWalletResponse): string

- Defined in wallet-link/src/walletLink.ts:71
Parameters
- protocol: string
- address: string
- responseParams: LinkWalletResponse
Returns string

createSignHotspotCallbackUrl

createSignHotspotCallbackUrl(protocol: string, responseParams: SignHotspotResponse): string

- Defined in wallet-link/src/walletLink.ts:77
Parameters
- protocol: string
- responseParams: SignHotspotResponse
Returns string

createUpdateHotspotUrl

createUpdateHotspotUrl(opts: SignHotspotRequest): string

- Defined in wallet-link/src/walletLink.ts:82
Parameters
- opts: SignHotspotRequest
Returns string

createWalletLinkUrl

createWalletLinkUrl(opts: { appName: string; callbackUrl: string; path?: string; requestAppId: string }): string

- Defined in wallet-link/src/walletLink.ts:59
Parameters
- opts: { appName: string; callbackUrl: string; path?: string; requestAppId: string }
  - appName: string
  - callbackUrl: string
  - Optional path?: string
  - requestAppId: string
Returns string

makeAppLinkAuthToken

makeAppLinkAuthToken(tokenOpts: Token, keypair: SignableKeypair): Promise<string>

- Defined in wallet-link/src/walletLink.ts:21
Parameters
- tokenOpts: Token
- keypair: SignableKeypair
Returns Promise<string>

parseWalletLinkToken

parseWalletLinkToken(base64Token: string): TokenWithSig

- Defined in wallet-link/src/walletLink.ts:53
Parameters
- base64Token: string
Returns TokenWithSig

verifyWalletLinkToken

verifyWalletLinkToken(linkToken: TokenWithSig, opts?: { maxAgeInSeconds: number }): Promise<boolean>

- Defined in wallet-link/src/walletLink.ts:33
Parameters
- linkToken: TokenWithSig
- Optional opts: { maxAgeInSeconds: number }
  - maxAgeInSeconds: number
Returns Promise<boolean>

@helium/wallet-link

Installation

React Native

Browser or other JS environments

Usage

Index

Type Aliases

Variables

Functions

Type Aliases

DelegateApp

Type declaration

androidPackage: string

appStoreId: number

iosBundleId: string

name: string

universalLink: string

LinkWalletRequest

Type declaration

appName: string

callbackUrl: string

requestAppId: string

LinkWalletResponse

Type declaration

status: "success" | "user_cancelled"

Optional token?: string

MakerApp

Type declaration

androidPackage: string

iosBundleId: string

name: string

universalLink: string

SignHotspotRequest

Type declaration

Optional addGatewayTxn?: string

Optional assertLocationTxn?: string

Optional solanaTransactions?: string

token: string

Optional transferHotspotTxn?: string

SignHotspotResponse

Type declaration

Optional assertTxn?: string

Optional gatewayAddress?: string

Optional gatewayTxn?: string

Optional solanaTransactions?: string

status: "success" | "token_not_found" | "user_cancelled" | "gateway_not_found" | "invalid_link"

Optional transferTxn?: string

Token

TokenWithSig

Variables

Const HELIUM_HOTSPOT_APP

Const HELIUM_WALLET_APP

Functions

createLinkWalletCallbackUrl

Parameters

protocol: string

address: string

responseParams: LinkWalletResponse

Returns string

createSignHotspotCallbackUrl

Parameters

protocol: string

responseParams: SignHotspotResponse

Returns string

createUpdateHotspotUrl

Parameters

opts: SignHotspotRequest

Returns string

createWalletLinkUrl

Parameters

opts: { appName: string; callbackUrl: string; path?: string; requestAppId: string }

appName: string

callbackUrl: string

Optional path?: string

requestAppId: string

Returns string

makeAppLinkAuthToken

Parameters

tokenOpts: Token

keypair: SignableKeypair

`@helium/wallet-link`