Index

Constructors

• constructor

Properties

• address
• coinType
• provider
• switchboardAddress

Methods

• addJob
• addJobTx
• crankPushTx
• extend
• extendTx
• fastSaveResult
• isOnCrank
• latestValue
• loadData
• loadJobs
• openInterval
• openIntervalTx
• removeJobTx
• saveResult
• saveResultTx
• setAuthorityTx
• setConfig
• setConfigTx
• withdraw
• withdrawTx
• init
• shouldReportValue
• watch

Constructors

constructor

• new AggregatorAccount(provider: JsonRpcProvider, address: string, switchboardAddress: string, coinType?: string): AggregatorAccount

• Parameters

  • provider: JsonRpcProvider

  • address: string

  • switchboardAddress: string

  • coinType: string = "0x2::sui::SUI"

  Returns AggregatorAccount

Properties

readonlyaddress

address: string

readonlycoinType

coinType: string = "0x2::sui::SUI"

readonlyprovider

provider: JsonRpcProvider

readonlyswitchboardAddress

switchboardAddress: string

Methods

addJob

• addJob(signer: Keypair, params: AggregatorAddJobParams): Promise<SuiTransactionBlockResponse>

• Parameters

  • signer: Keypair

  • params: AggregatorAddJobParams

  Returns Promise<SuiTransactionBlockResponse>

addJobTx

• addJobTx(params: Omit<AggregatorAddJobParams & JobInitParams, job>, txb?: TransactionBlock): TransactionBlock

• Parameters

  • params: Omit<AggregatorAddJobParams & JobInitParams, job>

  • optionaltxb: TransactionBlock

  Returns TransactionBlock

crankPushTx

• crankPushTx(): Promise<TransactionBlock>

• Push feed to the crank

  ---

  Returns Promise<TransactionBlock>

extend

• extend(signer: Keypair, params: LeaseExtendParams): Promise<SuiTransactionBlockResponse>

• Extend a lease

  ---

  Parameters

  • signer: Keypair

  • params: LeaseExtendParams

    LeaseExtendParams

  Returns Promise<SuiTransactionBlockResponse>

extendTx

• extendTx(params: LeaseExtendParams, txb?: TransactionBlock): Promise<TransactionBlock>

• Extend a lease tx

  ---

  Parameters

  • params: LeaseExtendParams

    LeaseExtendParams

  • optionaltxb: TransactionBlock

  Returns Promise<TransactionBlock>

fastSaveResult

• fastSaveResult(signer: Keypair, params: AggregatorFastResultParams): Promise<SuiTransactionBlockResponse>

• Parameters

  • signer: Keypair

  • params: AggregatorFastResultParams

  Returns Promise<SuiTransactionBlockResponse>

isOnCrank

• isOnCrank(): Promise<boolean>

• check that a feed is on the crank

  ---

  Returns Promise<boolean>

latestValue

• latestValue(): Promise<number>

• Returns Promise<number>

loadData

• loadData(): Promise<any>

• Returns Promise<any>

loadJobs

• loadJobs(): Promise<OracleJob[]>

• Returns Promise<OracleJob[]>

openInterval

• openInterval(signer: Keypair, reward: number): Promise<SuiTransactionBlockResponse>

• Parameters

  • signer: Keypair

  • reward: number

  Returns Promise<SuiTransactionBlockResponse>

openIntervalTx

• openIntervalTx(loadCoin: SuiObject, txb?: TransactionBlock): Promise<TransactionBlock>

• Parameters

  • loadCoin: SuiObject

  • optionaltxb: TransactionBlock

  Returns Promise<TransactionBlock>

removeJobTx

• removeJobTx(params: AggregatorAddJobParams, txb?: TransactionBlock): TransactionBlock

• Parameters

  • params: AggregatorAddJobParams

  • optionaltxb: TransactionBlock

  Returns TransactionBlock

saveResult

• saveResult(signer: Keypair, params: AggregatorSaveResultParams, txb?: TransactionBlock): Promise<SuiTransactionBlockResponse>

• Parameters

  • signer: Keypair

  • params: AggregatorSaveResultParams

  • optionaltxb: TransactionBlock

  Returns Promise<SuiTransactionBlockResponse>

saveResultTx

• saveResultTx(params: AggregatorSaveResultParams, txb?: TransactionBlock): TransactionBlock

• Parameters

  • params: AggregatorSaveResultParams

  • optionaltxb: TransactionBlock

  Returns TransactionBlock

setAuthorityTx

• setAuthorityTx(authority: string, txb?: TransactionBlock): Promise<TransactionBlock>

• Parameters

  • authority: string

  • optionaltxb: TransactionBlock

  Returns Promise<TransactionBlock>

setConfig

• setConfig(signer: Keypair, params: AggregatorSetConfigParams): Promise<SuiTransactionBlockResponse>

• Parameters

  • signer: Keypair

  • params: AggregatorSetConfigParams

  Returns Promise<SuiTransactionBlockResponse>

setConfigTx

• setConfigTx(params: AggregatorSetConfigParams, txb?: TransactionBlock): Promise<TransactionBlock>

• Parameters

  • params: AggregatorSetConfigParams

  • optionaltxb: TransactionBlock

  Returns Promise<TransactionBlock>

withdraw

• withdraw(signer: Keypair, params: LeaseWithdrawParams): Promise<SuiTransactionBlockResponse>

• Parameters

  • signer: Keypair

  • params: LeaseWithdrawParams

  Returns Promise<SuiTransactionBlockResponse>

withdrawTx

• withdrawTx(params: LeaseWithdrawParams, txb?: TransactionBlock): Promise<TransactionBlock>

• withdraw a lease tx

  ---

  Parameters

  • params: LeaseWithdrawParams

    LeaseWithdrawParams

  • optionaltxb: TransactionBlock

  Returns Promise<TransactionBlock>

staticinit

• init(provider: JsonRpcProvider, signer: Keypair, params: AggregatorInitParams, switchboardAddress: string): Promise<[AggregatorAccount, SuiTransactionBlockResponse]>

• Initialize an Aggregator

  ---

  Parameters

  • provider: JsonRpcProvider

  • signer: Keypair

  • params: AggregatorInitParams

    AggregatorInitParams initialization params

  • switchboardAddress: string

  Returns Promise<[AggregatorAccount, SuiTransactionBlockResponse]>

staticshouldReportValue

• shouldReportValue(value: Big, aggregator: any): Promise<boolean>

• Parameters

  • value: Big

  • aggregator: any

  Returns Promise<boolean>

staticwatch

• watch(provider: JsonRpcProvider, switchboardAddress: string, callback: EventCallback): SuiEvent

• Parameters

  • provider: JsonRpcProvider

  • switchboardAddress: string

  • callback: EventCallback

  Returns SuiEvent