SolanaDistributorClient
SolanaDistributorClient
Defined in: distributor/solana/clients/SolanaDistributorClient.ts:7
Extends
default
Constructors
Constructor
new SolanaDistributorClient(__namedParameters): SolanaDistributorClient;Defined in: distributor/solana/clients/BaseDistributorClient.ts:105
Parameters
| Parameter | Type |
|---|---|
__namedParameters | IInitOptions |
Returns
SolanaDistributorClient
Inherited from
BaseDistributorClient.constructorProperties
| Property | Modifier | Type | Inherited from | Defined in |
|---|---|---|---|---|
apiKey? | protected | string | BaseDistributorClient.apiKey | distributor/solana/clients/BaseDistributorClient.ts:103 |
apiUrl | protected | string | BaseDistributorClient.apiUrl | distributor/solana/clients/BaseDistributorClient.ts:101 |
cluster | protected | ICluster | BaseDistributorClient.cluster | distributor/solana/clients/BaseDistributorClient.ts:99 |
commitment | protected | Commitment | ConnectionConfig | SolanaAlignedDistributorClient.commitment | distributor/solana/clients/BaseDistributorClient.ts:93 |
connection | protected | Connection | BaseDistributorClient.connection | distributor/solana/clients/BaseDistributorClient.ts:83 |
feeConfigPublicKey | protected | PublicKey | BaseDistributorClient.feeConfigPublicKey | distributor/solana/clients/BaseDistributorClient.ts:91 |
merkleDistributorProgram | public | Program<MerkleDistributor> | BaseDistributorClient.merkleDistributorProgram | distributor/solana/clients/BaseDistributorClient.ts:97 |
partnerOracle | protected | Program<PartnerOracle> | BaseDistributorClient.partnerOracle | distributor/solana/clients/BaseDistributorClient.ts:89 |
partnerOracleProgramId | protected | PublicKey | BaseDistributorClient.partnerOracleProgramId | distributor/solana/clients/BaseDistributorClient.ts:87 |
programId | protected | PublicKey | BaseDistributorClient.programId | distributor/solana/clients/BaseDistributorClient.ts:85 |
sendThrottler | protected | PQueue | BaseDistributorClient.sendThrottler | distributor/solana/clients/BaseDistributorClient.ts:95 |
Methods
claim()
claim(data, extParams): Promise<ITransactionResult>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:257
Parameters
| Parameter | Type |
|---|---|
data | IClaimData |
extParams | IInteractExt |
Returns
Promise<ITransactionResult>
Inherited from
BaseDistributorClient.claimclawback()
clawback(data, extParams): Promise<ITransactionResult>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:536
Parameters
| Parameter | Type |
|---|---|
data | IClawbackData |
extParams | IInteractExt |
Returns
Promise<ITransactionResult>
Inherited from
BaseDistributorClient.clawbackcloseClaim()
closeClaim(data, extParams): Promise<ITransactionResult>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:429
Parameters
| Parameter | Type |
|---|---|
data | ICloseClaimData |
extParams | IInteractExt |
Returns
Promise<ITransactionResult>
Inherited from
BaseDistributorClient.closeClaimcreate()
create(data, extParams): Promise<ICreateDistributorResult>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:221
Parameters
| Parameter | Type |
|---|---|
data | | ICreateDistributorData | ICreateAlignedDistributorData |
extParams | ICreateExt |
Returns
Promise<ICreateDistributorResult>
Inherited from
BaseDistributorClient.creategetClaim()
getClaim(claimStatus): Promise<AnyClaimStatus>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:560
Parameters
| Parameter | Type |
|---|---|
claimStatus | string | PublicKey |
Returns
Promise<AnyClaimStatus>
Inherited from
BaseDistributorClient.getClaimgetClaims()
getClaims(data): Promise<AnyClaimStatus[]>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:564
Parameters
| Parameter | Type |
|---|---|
data | IGetClaimData[] |
Returns
Promise<AnyClaimStatus[]>
Inherited from
BaseDistributorClient.getClaimsgetClawbackInstruction()
protected getClawbackInstruction(accounts): Promise<TransactionInstruction>;Defined in: distributor/solana/clients/SolanaDistributorClient.ts:35
Parameters
| Parameter | Type |
|---|---|
accounts | ResolvedAccounts |
Returns
Promise<TransactionInstruction>
Overrides
BaseDistributorClient.getClawbackInstructiongetCommitment()
getCommitment(): Commitment;Defined in: distributor/solana/clients/BaseDistributorClient.ts:141
Returns
Commitment
Inherited from
BaseDistributorClient.getCommitmentgetConnection()
getConnection(): Connection;Defined in: distributor/solana/clients/BaseDistributorClient.ts:137
Returns
Connection
Inherited from
BaseDistributorClient.getConnectiongetDefaultFees()
getDefaultFees(): Promise<{
allocationFactor: number;
claimMaxFee: number;
claimMinFee: number;
clawbackTokenFeePercent: number;
creationFee: number;
priceOracleFee: number;
pubkey: PublicKey;
}>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:614
Get all defaults fees applied by the protocol.
Returns
Promise<{
allocationFactor: number;
claimMaxFee: number;
claimMinFee: number;
clawbackTokenFeePercent: number;
creationFee: number;
priceOracleFee: number;
pubkey: PublicKey;
}>
Inherited from
BaseDistributorClient.getDefaultFeesgetDistributorProgramId()
getDistributorProgramId(): PublicKey;Defined in: distributor/solana/clients/BaseDistributorClient.ts:145
Returns
PublicKey
Inherited from
BaseDistributorClient.getDistributorProgramIdgetDistributors()
getDistributors(data): Promise<object[]>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:574
Parameters
| Parameter | Type |
|---|---|
data | IGetDistributors |
Returns
Promise<object[]>
Inherited from
BaseDistributorClient.getDistributorsgetFeeConfig()
getFeeConfig(): Promise<{
allocationFactor: number;
buffer: number[];
claimMaxFee: number;
claimMinFee: number;
clawbackTokenFeePercent: number;
creationFee: number;
partners: object[];
priceOracleFee: number;
solanaPrice: BN;
usdMultiplier: number;
version: number;
}>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:603
Fetch Fee Config for the Airdrop protocol from Partner Oracle.
Returns
Promise<{
allocationFactor: number;
buffer: number[];
claimMaxFee: number;
claimMinFee: number;
clawbackTokenFeePercent: number;
creationFee: number;
partners: object[];
priceOracleFee: number;
solanaPrice: BN;
usdMultiplier: number;
version: number;
}>
Inherited from
BaseDistributorClient.getFeeConfiggetFees()
getFees(pubkey): Promise<{
allocationFactor: number;
claimMaxFee: number;
claimMinFee: number;
clawbackTokenFeePercent: number;
creationFee: number;
priceOracleFee: number;
pubkey: PublicKey;
}>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:632
Get fees for a given wallet.
Parameters
| Parameter | Type | Description |
|---|---|---|
pubkey | PublicKey | partner to search fees for |
Returns
Promise<{
allocationFactor: number;
claimMaxFee: number;
claimMinFee: number;
clawbackTokenFeePercent: number;
creationFee: number;
priceOracleFee: number;
pubkey: PublicKey;
}>
Inherited from
BaseDistributorClient.getFeesgetNewDistributorInstruction()
protected getNewDistributorInstruction(data, accounts): Promise<TransactionInstruction>;Defined in: distributor/solana/clients/SolanaDistributorClient.ts:8
Parameters
| Parameter | Type |
|---|---|
data | ICreateDistributorData |
accounts | Required<NewDistributorAccounts> |
Returns
Promise<TransactionInstruction>
Overrides
BaseDistributorClient.getNewDistributorInstructionprepareClaimFeeInstruction()
protected prepareClaimFeeInstruction(payer, fee?): TransactionInstruction;Defined in: distributor/solana/clients/BaseDistributorClient.ts:644
Parameters
| Parameter | Type | Default value |
|---|---|---|
payer | PublicKey | undefined |
fee | bigint | AIRDROP_CLAIM_FEE |
Returns
TransactionInstruction
Inherited from
BaseDistributorClient.prepareClaimFeeInstructionprepareClaimInstructions()
prepareClaimInstructions(data, extParams): Promise<TransactionInstruction[]>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:299
Parameters
| Parameter | Type |
|---|---|
data | IClaimData |
extParams | ITransactionExtResolved<IInteractExt> |
Returns
Promise<TransactionInstruction[]>
Inherited from
BaseDistributorClient.prepareClaimInstructionsprepareClawbackInstructions()
prepareClawbackInstructions(data, extParams): Promise<TransactionInstruction[]>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:492
Parameters
| Parameter | Type |
|---|---|
data | IClawbackData |
extParams | ITransactionExtResolved<IInteractExt> |
Returns
Promise<TransactionInstruction[]>
Inherited from
BaseDistributorClient.prepareClawbackInstructionsprepareCloseClaimInstructions()
prepareCloseClaimInstructions(data, extParams): Promise<TransactionInstruction[]>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:453
Parameters
| Parameter | Type |
|---|---|
data | ICloseClaimData |
extParams | ITransactionExtResolved<IInteractExt> |
Returns
Promise<TransactionInstruction[]>
Inherited from
BaseDistributorClient.prepareCloseClaimInstructionsprepareCreateInstructions()
prepareCreateInstructions(data, extParams): Promise<{
distributorPublicKey: PublicKey;
ixs: TransactionInstruction[];
}>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:149
Parameters
| Parameter | Type |
|---|---|
data | | ICreateDistributorData | ICreateAlignedDistributorData |
extParams | ITransactionExtResolved<ICreateExt> |
Returns
Promise<{
distributorPublicKey: PublicKey;
ixs: TransactionInstruction[];
}>
Inherited from
BaseDistributorClient.prepareCreateInstructionssearchDistributors()
searchDistributors(data): Promise<IProgramAccount<{
admin: PublicKey;
allocationFactor: number;
buffer: number[];
bump: number;
canUpdateDuration: boolean;
claimFeeClaimed: boolean;
claimMaxFee: number;
claimMinFee: number;
claimsClosableByAdmin: boolean;
claimsClosableByClaimant: boolean;
claimsLimit: number;
clawbackFeeClaimed: boolean;
clawbackReceiver: PublicKey;
clawbackStartTs: BN;
clawbackTokenFeePercent: number;
clawedBack: boolean;
clawedBackTs: BN;
creationFee: number;
creationFeeClaimed: boolean;
endTs: BN;
lastDurationUpdateTs: BN;
maxNumNodes: BN;
maxTotalClaim: BN;
mint: PublicKey;
numNodesClaimed: BN;
programVersion: number;
root: number[];
startTs: BN;
tokenPriceLamports: BN;
tokenVault: PublicKey;
totalAmountClaimed: BN;
totalAmountLocked: BN;
totalAmountUnlocked: BN;
totalClaimablePreUpdate: BN;
unlockPeriod: BN;
version: BN;
}>[]>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:579
Parameters
| Parameter | Type |
|---|---|
data | ISearchDistributors |
Returns
Promise<IProgramAccount<{
admin: PublicKey;
allocationFactor: number;
buffer: number[];
bump: number;
canUpdateDuration: boolean;
claimFeeClaimed: boolean;
claimMaxFee: number;
claimMinFee: number;
claimsClosableByAdmin: boolean;
claimsClosableByClaimant: boolean;
claimsLimit: number;
clawbackFeeClaimed: boolean;
clawbackReceiver: PublicKey;
clawbackStartTs: BN;
clawbackTokenFeePercent: number;
clawedBack: boolean;
clawedBackTs: BN;
creationFee: number;
creationFeeClaimed: boolean;
endTs: BN;
lastDurationUpdateTs: BN;
maxNumNodes: BN;
maxTotalClaim: BN;
mint: PublicKey;
numNodesClaimed: BN;
programVersion: number;
root: number[];
startTs: BN;
tokenPriceLamports: BN;
tokenVault: PublicKey;
totalAmountClaimed: BN;
totalAmountLocked: BN;
totalAmountUnlocked: BN;
totalClaimablePreUpdate: BN;
unlockPeriod: BN;
version: BN;
}>[]>
Inherited from
BaseDistributorClient.searchDistributorsunwrapExecutionParams()
protected unwrapExecutionParams<T>(extParams): UnwrapAutoSimulate<T>;Defined in: distributor/solana/clients/BaseDistributorClient.ts:661
Type Parameters
| Type Parameter |
|---|
T extends IInteractExt |
Parameters
| Parameter | Type |
|---|---|
extParams | T |
Returns
UnwrapAutoSimulate<T>
Inherited from
BaseDistributorClient.unwrapExecutionParamsvalidateDistributorArgs()
protected validateDistributorArgs(data): void;Defined in: distributor/solana/clients/BaseDistributorClient.ts:652
Parameters
| Parameter | Type |
|---|---|
data | ICreateDistributorData |
Returns
void
Inherited from
BaseDistributorClient.validateDistributorArgs