Class ReferralAPI

Represents a class for handling operations related to making analytics queries from the voidnode server.

Hierarchy

BaseAPI
- ReferralAPI

Index

Constructors

Properties

premia streamIndex

Methods

cancelAllStreams encodeClaimRebate encodeClaimRebateSync getRebates

Constructors

constructor

new ReferralAPI(premia): ReferralAPI
Construct a new BaseAPI object.
Parameters
- premia: Premia
  
  An instance of the Premia SDK.
Returns ReferralAPI
Inherited from BaseAPI.constructor
- Defined in src/api/baseAPI.ts:25

Properties

`Readonly` premia

premia: Premia

The Premia SDK instance.

`Protected` streamIndex

streamIndex: number = 0

The current index of quote streams. Used to cancel stale streams.

Methods

cancelAllStreams

cancelAllStreams(): Promise<void>
Cancels all ongoing streams.

Returns Promise<void>
Inherited from BaseAPI.cancelAllStreams
- Defined in src/api/baseAPI.ts:34

encodeClaimRebate

encodeClaimRebate(tokens, provider?): Promise<ContractTransaction>
Encodes the claimRebate parameters into a transaction that can be broadcasted to the provider network.
Parameters
- tokens: string[]
  
  array of addresses of tokens to claim.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<ContractTransaction>
A promise that resolves to a contract transaction for the claimRebate operation.
- Defined in src/api/referralAPI.ts:35

encodeClaimRebateSync

encodeClaimRebateSync(tokens, provider?): TransactionData
Encodes the claimRebate parameters into a transaction that can be broadcasted to the provider network.
Parameters
- tokens: string[]
  
  array of addresses of tokens to claim.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns TransactionData
The encoded transaction data.
- Defined in src/api/referralAPI.ts:50

getRebates

getRebates(referrer, provider?): Promise<[string[], bigint[]] & {
rebates: bigint[];
tokens: string[];
}>
Returns a promise containing the array of tokens and amounts for referral fees.
Parameters
- referrer: string
  
  {string} The address of the referrer.
- Optional provider: Provider
  
  The custom provider to use for this call.
Returns Promise<[string[], bigint[]] & {
rebates: bigint[];
tokens: string[];
}>
Promise the array of tokens and amounts for referral fees.
- Defined in src/api/referralAPI.ts:18

Generated using TypeDoc