JavaScript Client for the UXD Solana Program
Install
npm install --save @uxd-protocol/uxd-client
Usage
About UXD on Solana
Mainnet-Beta
- UXD Program: UXD8m9cvwk4RcSxnX2HZ9VudQCEeDH6fRnB4CAP57Dr
- UXD Mint: 7kbnvuGBxxj8AG9qp8Scn56muWGaRaFqxg1FsRp3PaFT
Devnet
- UXD Program: BA67esrWE7cPzQWtAftaTbrVWtmHZJ1PbbBBpZgpjH4p
- UXD Mint: B8fvu55oqVmPzRFjo99wvnPXkuA2AcFBou5tstpeHFaR
Instantiate the Controller Object
import { Controller } from '@uxd-protocol/uxd-client';
const controller = new Controller(
'UXD',
6
'UXD8m9cvwk4RcSxnX2HZ9VudQCEeDH6fRnB4CAP57Dr'
);
Instantiate a Solana Connection
import { Connection } from '@solana/web3.js';
const connection = new Connection('https://api.mainnet-beta.solana.com');
Create and initialize the Mango object
import { createAndInitializeMango } from '@uxd-protocol/uxd-client';
const mango = createAndInitializeMango(
connection,
'mainnet' // 'devnet'
);
Instantiate a MangoDepository Object for a given UXD collateral, ie WSOL
import {
WSOL,
SOL_DECIMALS,
USDC,
USDC_DECIMALS,
MangoDepository,
} from '@uxd-protocol/uxd-client';
return new MangoDepository(
WSOL,
'SOL',
SOL_DECIMALS,
USDC, // Use mainnet mint, must be matching the program used (see USDC_DEVNET)
'USDC',
USDC_DECIMALS,
'UXD8m9cvwk4RcSxnX2HZ9VudQCEeDH6fRnB4CAP57Dr' // Mainnet program
);
Instantiate the UXD Client
import { UXDClient } from '@uxd-protocol/uxd-client';
const client = new UXDClient('UXD8m9cvwk4RcSxnX2HZ9VudQCEeDH6fRnB4CAP57Dr');
Mint 1 SOL worth of UXD on the SOL Mango Depository
import { Transaction } from '@solana/web3.js';
const transaction = new Transaction();
const mintWithMangoDepositoryIx =
client.createMintWithMangoDepositoryInstruction(
1, // UI amount of collateral to use to mint UXD
5, // 0.5% slippage in points
controller,
depository, // matching Mango Depository for the collateral
mango,
user // PublicKey of recipient
{}, // ConfirmOptions, leave empty for defaults
payer, // PublicKey of payer, optional, defaults to user
);
transaction.add(mintWithMangoDepositoryIx);
// sign, send & confirm transaction
Redeem UXD on the SOL Mango Depository
import { Transaction } from '@solana/web3.js';
const transaction = new Transaction();
const redeemFromMangoDepositoryIx =
client.createRedeemFromMangoDepositoryInstruction(
10, // UI amount of UXD to redeem (returned as the provided depository Collateral, here SOL))
5, // 0.5% slippage in points
controller,
depository, // matching Mango Depository for the collateral
mango,
user // PublicKey of recipient
{}, // ConfirmOptions, leave empty for defaults
payer, // PublicKey of payer, optional, defaults to user
);
transaction.add(redeemFromMangoDepositoryIx)
// sign, send & confirm transaction
Rebalance an UXD Mango Depository
This can be used as a Swap. Depending of the polarity of the PnL of the depository, this instruction will switch Quote->Collateral or Collateral->Quote.
For instance, when the PnL is Positive (Collateral price went up since minting), user can provide USDC. By doing so, UXDProgram will offset the PnL of an equal amount, close equivalent short position, and return the backing collateral amount.
It's a 4bps + slippage + spread swap (as we use the Perp price for all operations).
You can find detailed information about the current state of depositories on the UXD Backoffice.
import { Transaction } from '@solana/web3.js';
const unrealizedPnl = await depository.getUnrealizedPnl(mango, TXN_OPTS);
const polarity = unrealizedPnl > 0 ? PnLPolarity.Positive : PnLPolarity.Negative;
const transaction = new Transaction();
const rebalanceLiteMangoDepositoryIx =
client.createRebalanceMangoDepositoryLiteInstruction(
10, // UI amount in Quote to rebalance (Quote on mango is USDC)
5, // 0.5% slippage in points
PnLPolarity.positive, // The polarity of the PnL, the expected direction of the swap (can be enforce program side but here to be explicit)
controller,
depository, // matching Mango Depository for the collateral
mango,
user // PublicKey of recipient
{}, // ConfirmOptions, leave empty for defaults
payer, // PublicKey of payer, optional, defaults to user
);
transaction.add(redeemFromMangoDepositoryIx)
// sign, send & confirm transaction
![[Protocol] Adding generic edit instructions](https://avatars.githubusercontent.com/u/106254129?v=4)
4 May 3, 2022
14 Jan 3, 2023
50 Dec 24, 2022
30 May 21, 2022
33 Dec 27, 2022
3 Dec 3, 2022
12 Dec 16, 2022
36 Nov 10, 2022
11 Aug 18, 2022
4 Jul 10, 2022
111 Dec 15, 2022
2 Jan 2, 2022
35 Dec 11, 2022
1 Jan 22, 2022
9 May 6, 2022
30 Dec 25, 2022
27 Nov 24, 2022
2 Dec 5, 2022
25 Sep 3, 2022