Portal Developer Docs
Search…
⌃K
🏋♀

@portal-hq/core

The @portal-hq/core package includes a class constructor for the Portal class, a React Context Provider for the PortalContext, the usePortal hook for use within child components, and some helpful types and enums for working with Portal in your app. These pieces allow you to initialize Portal in your app, expose the instance to your component tree, and consume the instance in your child components.

The Portal class

The Portal class that houses three main sub-classes
  • api makes requests to the Portal api
  • mpc facilitates the generation, backup, and recovery of MPC wallets
  • provider the core Portal provider (EIP-1193 compliant)

Instantiation

When instantiating the Portal class, you must provide a PortalOptions object. This object is used to initialize all of the sub-classes (and their sub-classes).

Example instantiation

import { BackupMethods, Portal } from '@portal-hq/core'
​
const portal = new Portal({
apiKey: 'YOUR_PORTAL_CLIENT_API_KEY',
backup: {
// Expects an instance of @portal-hq/gdrive-storage
[BackupMethods.GoogleDrive]: gDriveStorage,
// Expects an instance of @portal-hq/icloud-storage
[BackupMethods.iCloud]: iCloudStorage,
},
chainId: 1,
gatewayConfig: 'https://mainnet.infura.io/v3/YOUR_INFURA_API_KEY',
isSimulator: DeviceInfo.isEmulator(),
// Expects an instance of @portal-hq/keychain
// or @portal-hq/mobile-key-values
keychain: keychain,
})

PortalOptions

The PortalOptions object is where you configure your instance of Portal. It contains a set of required properties and a set of optional properties.
Required properties
  • apiKey string a valid Portal Client API Key created via the Portal REST API​
  • backup object
  • chainId number the ID of the current Ethereum chain you'd like to perform actions on
    • You can update this property on your Portal instance later – if your app requires this – by setting portal.chainId property
  • gatewayConfig string or GatewayConfig the base url (including your API key) you'd like us to use for Gateway requests (reading from and writing to chain) Note: this will be required in the future
    • GatewayConfig – if you don't want to use the same url for all requests, you can instead provide a chain-level config for all Gateway RPC calls this can be passed in as an object with key/value pairs where the key is the chainId as a number and the value is the base url you'd like to use when performing actions on this chainId
  • isSimulator boolean whether or not you're currently running the app in a simulator (this is required to ensure that keychain storage is configured appropriately for the current device)
  • keychain MobileStorageAdapter - an instance of either @portal-hq/keychain or @portal-hq/mobile-key-values​
Optional properties
  • autoApprove boolean (default: false) whether you'd like the provider to auto-approve transactions
  • mpcEnabled boolean (default: true) whether or not to use MPC

api

The api property contains an instance of the PortalApi class, which has a number of helper methods to facilitate the retrieval of relevant application data from the Portal REST API.

Methods

getEnabledDapps
Fetches a list of allowed dApps based on your dApp settings in the Portal web app.
Example usage
const dapps = await portal.api.getEnabledDapps()
getNetworks
Fetches a list of supported networks based on your dApp settings in the Portal web app.
Example usage
const networks = await portal.api.getNetworks()

mpc

The mpc property contains an instance of the PortalMpc class, which has a number of helper methods to facilitate the management of Portal MPC wallets.

Methods

generate
Performs the MPC generate process to create an MPC wallet and its signing shares
Example usage
const createWallet = async () => {
await portal.mpc.generate()
}
backup
Performs the MPC backup process to create the backup shares for the generated MPC wallet.
Example usage
const backupWallet = async () => {
await portal.mpc.backup()
}
recover
Performs the MPC recovery process to generate new signing shares for the MPC wallet.
Example usage
const recoverWallet = async () => {
await portal.mpc.recover()
}

provider

The provider property contains an EIP-1193 compliant provider.

Making requests through the provider

In order to perform basic web3 operations, such as eth_accounts and eth_sendTransaction, you can use the provider's request method.
This method conforms to EIP-1193.
For a full list of supported JSON RPC methods and their associated params, please see Ethereum's JSON-RPC API docs.
Example usage
const transaction = {
data: '',
to: toAddress,
value: BigNumber.from('1').toHexString(),
gas: '0x6000',
from: portal.address, // The address of the current connected wallet
}
​
const txHash = await portal.provider.request({
method: 'eth_sendTransaction',
params: transaction,
})

Switching Networks

// portal.setChainId(chainId: number)
import { BackupMethods, Portal } from '@portal-hq/core'
​
const portal = new Portal({
apiKey: 'YOUR_PORTAL_CLIENT_API_KEY',
backup: {
// Expects an instance of @portal-hq/gdrive-storage
[BackupMethods.GoogleDrive]: gDriveStorage,
// Expects an instance of @portal-hq/icloud-storage
[BackupMethods.iCloud]: iCloudStorage,
},
gatewayConfig: {1 : 'https://mainnet.infura.io/v3/YOUR_INFURA_API_KEY',
5: 'https://eth-goerli.g.alchemy.com/v2/YOUR_ALCHEMY_ID'}
isSimulator: DeviceInfo.isEmulator(),
// Expects an instance of @portal-hq/keychain
// or @portal-hq/mobile-key-values
keychain: keychain,
})
// Be sure to have the corressponding gateway url in your gateway config when you
// instantiated your portal object.
await portal.setChainId(5)

The Portal context

PortalContext is used to persist an instance of Portal within your application. This allows you to initialize Portal once, and easily share this instance between all of the components within a given scope in your app.
The exported members allow for 2 ways to set the PortalContext and one way to get the PortalContext.

Setters

You only need to choose one of these when implementing the PortalContext in your app.
  • PortalContextProvider a React Context Provider to provide your Portal instance to the components in your app

Getters

  • usePortal a React hook to use the Portal instance in any component within the PortalContextProvider scope (any component being rendered as either a shallow or deep child of the PortalContextProvider)
For more info on working with React Context, check out the docs.

PortalContextProvider

The PortalContextProvider allows you to share your instance of the Portal class with all components in your component tree. Providing a value prop with your Portal instance and wrapping your components in the PortalContextProvider enables this behavior. All children of the PortalContextProvider can access the Portal instance using the usePortal hook (see below).
Note: The easiest way to ensure you're exposing Portal to all components in your component tree is to use it in your App component
// MyRootComponent.tsx
​
import { useEffect, useState } from 'react'
import { Portal, PortalContextProvider } from '@portal-hq/core'
​
const MyRootComponent = () => {
const [portal, setPortal] = useState<Portal>(null)
​
useEffect(() => {
if (!portal) {
setPortal(
new Portal({
// ...configuration options
}),
)
}
}, [portal])
​
return (
<PortalContextProvider value={portal}>
{/*
Now all children rendered in this scope
will have access to the `Portal` instance
via the `usePortal` hook
*/}
</PortalContextProvider>
)
}

usePortal

The usePortal hook allows any child in the component tree below a PortalContextProvider to access the Portal instance.
// MyChildComponent.tsx
​
import { usePortal } from '@portal-hq/core'
​
const MyChildComponent = () => {
const portal = usePortal()
​
// You can now do things with the `Portal` instance directly, such as:
// - `await portal.api.getEnabledDapps()`
// - `await portal.mpc.generate()`
//
// For more information on this, please see the `Portal` docs in `src/lib/portal`
​
...
}

Additional exports

In addition to the Portal class and context exports, the @portal-hq/core package exports some helpful types and enums for use when building your app.
The additional exports are as follows:
  • BackupMethods – an enum of supported storage methods for backup MPC key shares
  • Contract - a type representing Portal Contract records
  • Dapp - a type representing Portal Dapp records (portal.api.getEnabledDapps() returns Dapp[])
  • PortalOptions - a type representing the object used to configure the Portal class on initialization
Previous
Using the Web3 Provider
Next - Npm Packages
@portal-hq/components
Last modified 4mo ago