This guide will walk you through how to perform swaps with Portal’s iOS SDK.
PortalSwaps
class allows you to easily extend your existing Portal
instance with swaps functionality.
Portal
instance and a Swaps API Key. If you have not received a Swaps API Key, please contact support at partner@portalhq.io.getSources()
function returns a dictionary containing valid, swappable token sources that can be used with your Portal MPC Wallet. The existing Portal
instance that was provided at initialization is used to scope the request to the current chain.
In order to retrieve this list, you can use the following code.
getSources()
function is a set of key/value pairs where the key is the name of the token and the value is the token address for that token.
getQuote()
function returns a Quote
object for a given set of arguments.
Quote
arguments are a buyToken
, a sellToken
, and either a buyAmount
or a sellAmount
.
An example of a valid QuoteArgs
object would look something like this.
QuoteArgs
object, you can call the getQuote()
function.
Quote
object includes two properties:
allowanceTarget
The address requiring allowances to complete the Swapcost
The total cost (gas fees) of the swap transactiontransaction
The transaction to perform the swapallowanceTarget
to give the associated contract permissions to access a given amount of the token you’re selling. This requires a token allowance of at least what you’re selling. If you’re selling ETH
, this step is not necessary.
When you’re ready to execute a swap, you can use the request
function on your existing Portal
instance to sign the transaction and make a request to the chain.