Class Admin

Hierarchy

ClearingHouse
- Admin

Index

Constructors

constructor

Properties

Accessors

isSubscribed

Methods

Constructors

constructor

new Admin(connection: Connection, wallet: IWallet, program: Program<Idl>, accountSubscriber: ClearingHouseAccountSubscriber, txSender: TxSender, opts: ConfirmOptions): Admin

Inherited from ClearingHouse.constructor
- Defined in sdk/src/clearingHouse.ts:104
Parameters
- connection: Connection
- wallet: IWallet
- program: Program<Idl>
- accountSubscriber: ClearingHouseAccountSubscriber
- txSender: TxSender
- opts: ConfirmOptions
Returns Admin

Properties

_isSubscribed

_isSubscribed: boolean = false

accountSubscriber

accountSubscriber: ClearingHouseAccountSubscriber

connection

connection: Connection

eventEmitter

eventEmitter: StrictEventEmitter<EventEmitter, ClearingHouseAccountEvents, ClearingHouseAccountEvents, "addEventListener" | "removeEventListener", "on" | "addListener" | "removeListener" | "once" | "emit">

Optional opts

opts?: ConfirmOptions

program

program: Program<Idl>

provider

provider: default

Optional statePublicKey

statePublicKey?: PublicKey

txSender

txSender: TxSender

Optional userAccount

userAccount?: UserAccount

Optional userAccountPublicKey

userAccountPublicKey?: PublicKey

wallet

wallet: IWallet

Accessors

isSubscribed

get isSubscribed(): boolean
set isSubscribed(val: boolean): void

Inherited from ClearingHouse.isSubscribed
- Defined in sdk/src/clearingHouse.ts:73
Returns boolean
Inherited from ClearingHouse.isSubscribed
- Defined in sdk/src/clearingHouse.ts:77
Parameters
- val: boolean
Returns void

Methods

closePosition

closePosition(marketIndex: BN, discountToken?: PublicKey, referrer?: PublicKey): Promise<string>

Inherited from ClearingHouse.closePosition
- Defined in sdk/src/clearingHouse.ts:590
Close an entire position. If you want to reduce a position, use the openPosition method in the opposite direction of the current position.

Parameters
- marketIndex: BN
- Optional discountToken: PublicKey
- Optional referrer: PublicKey
Returns Promise<string>

deleteUser

deleteUser(): Promise<string>

Inherited from ClearingHouse.deleteUser
- Defined in sdk/src/clearingHouse.ts:440
Returns Promise<string>

depositCollateral

depositCollateral(amount: BN, collateralAccountPublicKey: PublicKey, userPositionsAccountPublicKey?: PublicKey): Promise<string>

Inherited from ClearingHouse.depositCollateral
- Defined in sdk/src/clearingHouse.ts:333
Parameters
- amount: BN
- collateralAccountPublicKey: PublicKey
- Optional userPositionsAccountPublicKey: PublicKey
Returns Promise<string>

disableAdminControlsPrices

disableAdminControlsPrices(): Promise<string>

- Defined in sdk/src/admin.ts:622
Returns Promise<string>

fetchAccounts

fetchAccounts(): Promise<void>

Inherited from ClearingHouse.fetchAccounts
- Defined in sdk/src/clearingHouse.ts:153
```
Forces the accountSubscriber to fetch account updates from rpc
```
Returns Promise<void>

getClosePositionIx

getClosePositionIx(marketIndex: BN, discountToken?: PublicKey, referrer?: PublicKey): Promise<TransactionInstruction>

Inherited from ClearingHouse.getClosePositionIx
- Defined in sdk/src/clearingHouse.ts:604
Parameters
- marketIndex: BN
- Optional discountToken: PublicKey
- Optional referrer: PublicKey
Returns Promise<TransactionInstruction>

getCurveHistoryAccount

getCurveHistoryAccount(): ExtendedCurveHistoryAccount

Inherited from ClearingHouse.getCurveHistoryAccount
- Defined in sdk/src/clearingHouse.ts:211
Returns ExtendedCurveHistoryAccount

getDepositCollateralInstruction

getDepositCollateralInstruction(amount: BN, collateralAccountPublicKey: PublicKey, userPositionsAccountPublicKey?: PublicKey): Promise<TransactionInstruction>

Inherited from ClearingHouse.getDepositCollateralInstruction
- Defined in sdk/src/clearingHouse.ts:349
Parameters
- amount: BN
- collateralAccountPublicKey: PublicKey
- Optional userPositionsAccountPublicKey: PublicKey
Returns Promise<TransactionInstruction>

getDepositHistoryAccount

getDepositHistoryAccount(): DepositHistoryAccount

Inherited from ClearingHouse.getDepositHistoryAccount
- Defined in sdk/src/clearingHouse.ts:207
Returns DepositHistoryAccount

getFundingPaymentHistoryAccount

getFundingPaymentHistoryAccount(): FundingPaymentHistoryAccount

Inherited from ClearingHouse.getFundingPaymentHistoryAccount
- Defined in sdk/src/clearingHouse.ts:191
Returns FundingPaymentHistoryAccount

getFundingRateHistoryAccount

getFundingRateHistoryAccount(): FundingRateHistoryAccount

Inherited from ClearingHouse.getFundingRateHistoryAccount
- Defined in sdk/src/clearingHouse.ts:195
Returns FundingRateHistoryAccount

getInitializeUserInstructions

getInitializeUserInstructions(): Promise<[Keypair, PublicKey, TransactionInstruction]>

Inherited from ClearingHouse.getInitializeUserInstructions
- Defined in sdk/src/clearingHouse.ts:254
Returns Promise<[Keypair, PublicKey, TransactionInstruction]>

getLiquidateIx

getLiquidateIx(liquidateeUserAccountPublicKey: PublicKey): Promise<TransactionInstruction>

Inherited from ClearingHouse.getLiquidateIx
- Defined in sdk/src/clearingHouse.ts:668
Parameters
- liquidateeUserAccountPublicKey: PublicKey
Returns Promise<TransactionInstruction>

getLiquidationHistoryAccount

getLiquidationHistoryAccount(): LiquidationHistoryAccount

Inherited from ClearingHouse.getLiquidationHistoryAccount
- Defined in sdk/src/clearingHouse.ts:203
Returns LiquidationHistoryAccount

getMarket

getMarket(marketIndex: number | BN): Market

Inherited from ClearingHouse.getMarket
- Defined in sdk/src/clearingHouse.ts:184
Parameters
- marketIndex: number | BN
Returns Market

getMarketsAccount

getMarketsAccount(): MarketsAccount

Inherited from ClearingHouse.getMarketsAccount
- Defined in sdk/src/clearingHouse.ts:180
Returns MarketsAccount

getOpenPositionIx

getOpenPositionIx(direction: PositionDirection, amount: BN, marketIndex: BN, limitPrice?: BN, discountToken?: PublicKey, referrer?: PublicKey): Promise<TransactionInstruction>

Inherited from ClearingHouse.getOpenPositionIx
- Defined in sdk/src/clearingHouse.ts:519
Parameters
- direction: PositionDirection
- amount: BN
- marketIndex: BN
- Optional limitPrice: BN
- Optional discountToken: PublicKey
- Optional referrer: PublicKey
Returns Promise<TransactionInstruction>

getSettleFundingPaymentIx

getSettleFundingPaymentIx(userAccount: PublicKey, userPositionsAccount: PublicKey): Promise<TransactionInstruction>

Inherited from ClearingHouse.getSettleFundingPaymentIx
- Defined in sdk/src/clearingHouse.ts:755
Parameters
- userAccount: PublicKey
- userPositionsAccount: PublicKey
Returns Promise<TransactionInstruction>

getStateAccount

getStateAccount(): StateAccount

Inherited from ClearingHouse.getStateAccount
- Defined in sdk/src/clearingHouse.ts:176
Returns StateAccount

getStatePublicKey

getStatePublicKey(): Promise<PublicKey>

Inherited from ClearingHouse.getStatePublicKey
- Defined in sdk/src/clearingHouse.ts:166
Returns Promise<PublicKey>

getTradeHistoryAccount

getTradeHistoryAccount(): TradeHistoryAccount

Inherited from ClearingHouse.getTradeHistoryAccount
- Defined in sdk/src/clearingHouse.ts:199
Returns TradeHistoryAccount

getUpdateFundingRateIx

getUpdateFundingRateIx(oracle: PublicKey, marketIndex: BN): Promise<TransactionInstruction>

Inherited from ClearingHouse.getUpdateFundingRateIx
- Defined in sdk/src/clearingHouse.ts:727
Parameters
- oracle: PublicKey
- marketIndex: BN
Returns Promise<TransactionInstruction>

getUserAccount

getUserAccount(): Promise<UserAccount>

Inherited from ClearingHouse.getUserAccount
- Defined in sdk/src/clearingHouse.ts:322
Returns Promise<UserAccount>

getUserAccountPublicKey

getUserAccountPublicKey(): Promise<PublicKey>

Inherited from ClearingHouse.getUserAccountPublicKey
- Defined in sdk/src/clearingHouse.ts:309
Get the address for the Clearing House User's account. NOT the user's wallet address.

Returns Promise<PublicKey>

getWithdrawCollateralIx

getWithdrawCollateralIx(amount: BN, collateralAccountPublicKey: PublicKey): Promise<TransactionInstruction>

Inherited from ClearingHouse.getWithdrawCollateralIx
- Defined in sdk/src/clearingHouse.ts:466
Parameters
- amount: BN
- collateralAccountPublicKey: PublicKey
Returns Promise<TransactionInstruction>

initialize

initialize(usdcMint: PublicKey, adminControlsPrices: boolean): Promise<[string, string]>

- Defined in sdk/src/admin.ts:38
Parameters
- usdcMint: PublicKey
- adminControlsPrices: boolean
Returns Promise<[string, string]>

initializeMarket

initializeMarket(marketIndex: BN, priceOracle: PublicKey, baseAssetReserve: BN, quoteAssetReserve: BN, periodicity: BN, pegMultiplier?: BN): Promise<string>

- Defined in sdk/src/admin.ts:168
Parameters
- marketIndex: BN
- priceOracle: PublicKey
- baseAssetReserve: BN
- quoteAssetReserve: BN
- periodicity: BN
- pegMultiplier: BN = PEG_PRECISION
Returns Promise<string>

initializeUserAccount

initializeUserAccount(): Promise<[string, PublicKey]>

Inherited from ClearingHouse.initializeUserAccount
- Defined in sdk/src/clearingHouse.ts:236
Returns Promise<[string, PublicKey]>

initializeUserAccountAndDepositCollateral

initializeUserAccountAndDepositCollateral(amount: BN, collateralAccountPublicKey: PublicKey): Promise<[string, PublicKey]>

Inherited from ClearingHouse.initializeUserAccountAndDepositCollateral
- Defined in sdk/src/clearingHouse.ts:382
Creates the Clearing House User account for a user, and deposits some initial collateral

Parameters
- amount: BN
- collateralAccountPublicKey: PublicKey
Returns Promise<[string, PublicKey]>

initializeUserAccountForDevnet

initializeUserAccountForDevnet(mockUSDCFaucet: MockUSDCFaucet, amount: BN): Promise<[string, PublicKey]>

Inherited from ClearingHouse.initializeUserAccountForDevnet
- Defined in sdk/src/clearingHouse.ts:407
Parameters
- mockUSDCFaucet: MockUSDCFaucet
- amount: BN
Returns Promise<[string, PublicKey]>

liquidate

liquidate(liquidateeUserAccountPublicKey: PublicKey): Promise<string>

Inherited from ClearingHouse.liquidate
- Defined in sdk/src/clearingHouse.ts:658
Parameters
- liquidateeUserAccountPublicKey: PublicKey
Returns Promise<string>

moveAmmPrice

moveAmmPrice(baseAssetReserve: BN, quoteAssetReserve: BN, marketIndex: BN): Promise<string>

- Defined in sdk/src/admin.ts:198
Parameters
- baseAssetReserve: BN
- quoteAssetReserve: BN
- marketIndex: BN
Returns Promise<string>

moveAmmToPrice

moveAmmToPrice(marketIndex: BN, targetPrice: BN): Promise<string>

- Defined in sdk/src/admin.ts:258
Parameters
- marketIndex: BN
- targetPrice: BN
Returns Promise<string>

openPosition

openPosition(direction: PositionDirection, amount: BN, marketIndex: BN, limitPrice?: BN, discountToken?: PublicKey, referrer?: PublicKey): Promise<string>

Inherited from ClearingHouse.openPosition
- Defined in sdk/src/clearingHouse.ts:495
Parameters
- direction: PositionDirection
- amount: BN
- marketIndex: BN
- Optional limitPrice: BN
- Optional discountToken: PublicKey
- Optional referrer: PublicKey
Returns Promise<string>

repegAmmCurve

repegAmmCurve(newPeg: BN, marketIndex: BN): Promise<string>

- Defined in sdk/src/admin.ts:292
Parameters
- newPeg: BN
- marketIndex: BN
Returns Promise<string>

resetAmmOracleTwap

resetAmmOracleTwap(marketIndex: BN): Promise<string>

- Defined in sdk/src/admin.ts:331
Parameters
- marketIndex: BN
Returns Promise<string>

settleFundingPayment

settleFundingPayment(userAccount: PublicKey, userPositionsAccount: PublicKey): Promise<string>

Inherited from ClearingHouse.settleFundingPayment
- Defined in sdk/src/clearingHouse.ts:742
Parameters
- userAccount: PublicKey
- userPositionsAccount: PublicKey
Returns Promise<string>

subscribe

subscribe(optionalSubscriptions?: ClearingHouseAccountTypes[]): Promise<boolean>

Inherited from ClearingHouse.subscribe
- Defined in sdk/src/clearingHouse.ts:126
Parameters
- Optional optionalSubscriptions: ClearingHouseAccountTypes[]
  
  Optional extra accounts to subcribe to. Always subscribes to base clearing house state and market account state by default. You should only subscribe to optional extra accounts if required, to avoid overloading your RPC.
Returns Promise<boolean>
Promise : SubscriptionSuccess

subscribeToAll

subscribeToAll(): Promise<boolean>

Inherited from ClearingHouse.subscribeToAll
- Defined in sdk/src/clearingHouse.ts:139
Shorthand function to subscribe to all available Clearing House State Accounts

Returns Promise<boolean>
Promise : SubscriptionSuccess

triggerEvent

triggerEvent(eventName: keyof ClearingHouseAccountEvents, data?: any): void

Inherited from ClearingHouse.triggerEvent
- Defined in sdk/src/clearingHouse.ts:771
Parameters
- eventName: keyof ClearingHouseAccountEvents
- Optional data: any
Returns void

unsubscribe

unsubscribe(): Promise<void>

Inherited from ClearingHouse.unsubscribe
- Defined in sdk/src/clearingHouse.ts:160
Unsubscribe from all currently subscribed state accounts

Returns Promise<void>

updateAdmin

updateAdmin(admin: PublicKey): Promise<string>

- Defined in sdk/src/admin.ts:408
Parameters
- admin: PublicKey
Returns Promise<string>

updateAmmOracleTwap

updateAmmOracleTwap(marketIndex: BN): Promise<string>

- Defined in sdk/src/admin.ts:312
Parameters
- marketIndex: BN
Returns Promise<string>

updateCurveHistory

updateCurveHistory(): Promise<string>

- Defined in sdk/src/admin.ts:238
Returns Promise<string>

updateDiscountMint

updateDiscountMint(discountMint: PublicKey): Promise<string>

- Defined in sdk/src/admin.ts:580
Parameters
- discountMint: PublicKey
Returns Promise<string>

updateExchangePaused

updateExchangePaused(exchangePaused: boolean): Promise<string>

- Defined in sdk/src/admin.ts:611
Parameters
- exchangePaused: boolean
Returns Promise<string>

updateFee

updateFee(fees: FeeStructure): Promise<string>

- Defined in sdk/src/admin.ts:511
Parameters
- fees: FeeStructure
Returns Promise<string>

updateFullLiquidationPenaltyPercentage

updateFullLiquidationPenaltyPercentage(numerator: BN, denominator: BN): Promise<string>

- Defined in sdk/src/admin.ts:467
Parameters
- numerator: BN
- denominator: BN
Returns Promise<string>

updateFullLiquidationShareDenominator

updateFullLiquidationShareDenominator(denominator: BN): Promise<string>

- Defined in sdk/src/admin.ts:497
Parameters
- denominator: BN
Returns Promise<string>

updateFundingPaused

updateFundingPaused(fundingPaused: boolean): Promise<string>

- Defined in sdk/src/admin.ts:600
Parameters
- fundingPaused: boolean
Returns Promise<string>

updateFundingRate

updateFundingRate(oracle: PublicKey, marketIndex: BN): Promise<string>

Inherited from ClearingHouse.updateFundingRate
- Defined in sdk/src/clearingHouse.ts:716
Parameters
- oracle: PublicKey
- marketIndex: BN
Returns Promise<string>

updateK

updateK(sqrtK: BN, marketIndex: BN): Promise<string>

- Defined in sdk/src/admin.ts:218
Parameters
- sqrtK: BN
- marketIndex: BN
Returns Promise<string>

updateMarginRatio

updateMarginRatio(marginRatioInitial: BN, marginRatioPartial: BN, marginRatioMaintenance: BN): Promise<string>

- Defined in sdk/src/admin.ts:417
Parameters
- marginRatioInitial: BN
- marginRatioPartial: BN
- marginRatioMaintenance: BN
Returns Promise<string>

updateMarketMinimumTradeSize

updateMarketMinimumTradeSize(marketIndex: BN, minimumTradeSize: BN): Promise<string>

- Defined in sdk/src/admin.ts:551
Parameters
- marketIndex: BN
- minimumTradeSize: BN
Returns Promise<string>

updateMarketOracle

updateMarketOracle(marketIndex: BN, oracle: PublicKey, oracleSource: OracleSource): Promise<string>

- Defined in sdk/src/admin.ts:531
Parameters
- marketIndex: BN
- oracle: PublicKey
- oracleSource: OracleSource
Returns Promise<string>

updateMaxDeposit

updateMaxDeposit(maxDeposit: BN): Promise<string>

- Defined in sdk/src/admin.ts:591
Parameters
- maxDeposit: BN
Returns Promise<string>

updateOracleGuardRails

updateOracleGuardRails(oracleGuardRails: OracleGuardRails): Promise<string>

- Defined in sdk/src/admin.ts:520
Parameters
- oracleGuardRails: OracleGuardRails
Returns Promise<string>

updatePartialLiquidationClosePercentage

updatePartialLiquidationClosePercentage(numerator: BN, denominator: BN): Promise<string>

- Defined in sdk/src/admin.ts:435
Parameters
- numerator: BN
- denominator: BN
Returns Promise<string>

updatePartialLiquidationPenaltyPercentage

updatePartialLiquidationPenaltyPercentage(numerator: BN, denominator: BN): Promise<string>

- Defined in sdk/src/admin.ts:451
Parameters
- numerator: BN
- denominator: BN
Returns Promise<string>

updatePartialLiquidationShareDenominator

updatePartialLiquidationShareDenominator(denominator: BN): Promise<string>

- Defined in sdk/src/admin.ts:483
Parameters
- denominator: BN
Returns Promise<string>

updateWallet

updateWallet(newWallet: IWallet): void

Inherited from ClearingHouse.updateWallet
- Defined in sdk/src/clearingHouse.ts:219
Update the wallet to use for clearing house transactions and linked user account

Parameters
- newWallet: IWallet
Returns void

updateWhitelistMint

updateWhitelistMint(whitelistMint?: PublicKey): Promise<string>

- Defined in sdk/src/admin.ts:569
Parameters
- Optional whitelistMint: PublicKey
Returns Promise<string>

withdrawCollateral

withdrawCollateral(amount: BN, collateralAccountPublicKey: PublicKey): Promise<string>

Inherited from ClearingHouse.withdrawCollateral
- Defined in sdk/src/clearingHouse.ts:453
Parameters
- amount: BN
- collateralAccountPublicKey: PublicKey
Returns Promise<string>

withdrawFees

withdrawFees(marketIndex: BN, amount: BN, recipient: PublicKey): Promise<string>

- Defined in sdk/src/admin.ts:367
Parameters
- marketIndex: BN
- amount: BN
- recipient: PublicKey
Returns Promise<string>

withdrawFromInsuranceVault

withdrawFromInsuranceVault(amount: BN, recipient: PublicKey): Promise<string>

- Defined in sdk/src/admin.ts:350
Parameters
- amount: BN
- recipient: PublicKey
Returns Promise<string>

withdrawFromInsuranceVaultToMarket

withdrawFromInsuranceVaultToMarket(marketIndex: BN, amount: BN): Promise<string>

- Defined in sdk/src/admin.ts:386
Parameters
- marketIndex: BN
- amount: BN
Returns Promise<string>

Static from

from(connection: Connection, wallet: IWallet, clearingHouseProgramId: PublicKey, opts?: ConfirmOptions): Admin

Overrides ClearingHouse.from
- Defined in sdk/src/admin.ts:23
Parameters
- connection: Connection
- wallet: IWallet
- clearingHouseProgramId: PublicKey
- opts: ConfirmOptions = ...
Returns Admin

Generated using TypeDoc