Overview
Portal offers SDKs for Web, iOS, Android, and React Native. To install the chosen Portal SDK in your app, simply add the Portal package to your project.Authentication
The Portal SDK is initialized with a Client API Key or Client Session Token. You can get a test Client API Key from the Portal Admin Dashboard in theSettings
-> Test Client API Keys
section. Simply click the New +
button.
A modal will then be presented, allowing you to copy your test Client API Key. You can repeat this process as many times as you need to.
Initializing Portal
To initializePortal
in your application, create a new instance of the Portal
class included in the package dependency you added. You can provide your new test Client API Key as the apiKey
argument during initialization. rpcConfig
is a map of CAIP-2 Chain IDs to their respective RPC URLs.
Portal offers custom approval flows during the signing process, but for now, we can auto-approve all signatures with the autoApprove
argument.
Create a wallet
To create a new wallet, use theportal.createWallet()
function. You can optionally provide a callback to receive status updates during wallet creation.
Receive testnet tokens
Now that you have a wallet, the next step is to get test tokens for it. You can fund your wallet usingportal.receiveTestnetAsset
. If you are looking for a greater variety of test tokens, we recommend exploring our faucets page.
Send tokens
Portal provides two ways to send transactions:portal.sendAsset()
- A simple method for sending tokens from your Portal wallet.portal.request()
- Direct access to the underlying web3 provider for custom transactions. (You can learn more about this method here.)
portal.sendAsset()
as shown in the examples below.
EVM
If your Portal client is using Account Abstraction, then
txHash
is actually a User Operation hash. You can manually look up the user operation hash here.Solana
You will need
SOL
to submit a Solana transaction, which is not currently supported by portal.receiveTestnetAsset
. You can find a faucet to get test SOL
tokens here.You just created a Portal client, created their wallet, accessed their addresses, received testnet tokens, and sent tokens on both Monad Testnet and Solana Devnet! 🎉 Next we recommend going through the complete SDK guides where we go into much more detail.