Class SolanaDistributorClient

Hierarchy (View Summary)

SolanaDistributorClient
- SolanaDistributorClient

Constructors

constructor

new SolanaDistributorClient(
__namedParameters: IInitOptions,
): SolanaDistributorClient
Parameters
- __namedParameters: IInitOptions
Returns SolanaDistributorClient
Inherited from BaseDistributorClient.constructor
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:93

Properties

`Protected`commitment

commitment: Commitment | ConnectionConfig

`Protected`connection

connection: Connection

merkleDistributorProgram

merkleDistributorProgram: Program<MerkleDistributor>

`Protected`programId

programId: PublicKey

`Protected`sendThrottler

sendThrottler: PQueue

Methods

claim

claim(
data: IClaimData,
extParams: IInteractSolanaExt,
): Promise<ITransactionResult>
Parameters
- data: IClaimData
- extParams: IInteractSolanaExt
Returns Promise<ITransactionResult>
Inherited from BaseDistributorClient.claim
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:241

clawback

clawback(
data: IClawbackData,
extParams: IInteractSolanaExt,
): Promise<ITransactionResult>
Parameters
- data: IClawbackData
- extParams: IInteractSolanaExt
Returns Promise<ITransactionResult>
Inherited from BaseDistributorClient.clawback
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:483

closeClaim

closeClaim(
data: ICloseClaimData,
extParams: IInteractSolanaExt,
): Promise<ITransactionResult>
Parameters
- data: ICloseClaimData
- extParams: IInteractSolanaExt
Returns Promise<ITransactionResult>
Inherited from BaseDistributorClient.closeClaim
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:372

create

create(
data: ICreateDistributorData | ICreateAlignedDistributorData,
extParams: ICreateSolanaExt,
): Promise<ICreateDistributorResult>
Parameters
- data: ICreateDistributorData | ICreateAlignedDistributorData
- extParams: ICreateSolanaExt
Returns Promise<ICreateDistributorResult>
Inherited from BaseDistributorClient.create
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:205

getClaim

getClaim(claimStatus: string | PublicKey): Promise<null | AnyClaimStatus>
Parameters
- claimStatus: string | PublicKey
Returns Promise<null | AnyClaimStatus>
Inherited from BaseDistributorClient.getClaim
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:507

getClaims

getClaims(data: IGetClaimData[]): Promise<(null | AnyClaimStatus)[]>
Parameters
- data: IGetClaimData[]
Returns Promise<(null | AnyClaimStatus)[]>
Inherited from BaseDistributorClient.getClaims
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:511

`Protected`getClawbackInstruction

getClawbackInstruction(
accounts: ClawbackAccounts,
): Promise<TransactionInstruction>
Parameters
- accounts: ClawbackAccounts
Returns Promise<TransactionInstruction>
Overrides BaseDistributorClient.getClawbackInstruction
- Defined in packages/distributor/solana/clients/SolanaDistributorClient.ts:21

getCommitment

getCommitment(): undefined | Commitment
Returns undefined | Commitment
Inherited from BaseDistributorClient.getCommitment
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:121

getConnection

getConnection(): Connection
Returns Connection
Inherited from BaseDistributorClient.getConnection
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:117

getDistributorProgramId

getDistributorProgramId(): PublicKey
Returns PublicKey
Inherited from BaseDistributorClient.getDistributorProgramId
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:125

getDistributors

getDistributors(data: IGetDistributors): Promise<(null | MerkleDistributor)[]>
Parameters
- data: IGetDistributors
Returns Promise<(null | MerkleDistributor)[]>
Inherited from BaseDistributorClient.getDistributors
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:521

`Protected`getNewDistributorArgs

getNewDistributorArgs(data: ICreateDistributorData): NewDistributorArgs
Parameters
- data: ICreateDistributorData
Returns NewDistributorArgs
Inherited from BaseDistributorClient.getNewDistributorArgs
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:560

`Protected`getNewDistributorInstruction

getNewDistributorInstruction(
data: ICreateDistributorData,
accounts: NewDistributorAccounts,
): Promise<TransactionInstruction>
Parameters
- data: ICreateDistributorData
- accounts: NewDistributorAccounts
Returns Promise<TransactionInstruction>
Overrides BaseDistributorClient.getNewDistributorInstruction
- Defined in packages/distributor/solana/clients/SolanaDistributorClient.ts:13

`Protected`prepareClaimFeeInstruction

prepareClaimFeeInstruction(
payer: PublicKey,
fee?: bigint,
): TransactionInstruction
Parameters
- payer: PublicKey
- fee: bigint = AIRDROP_CLAIM_FEE
Returns TransactionInstruction
Inherited from BaseDistributorClient.prepareClaimFeeInstruction
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:552

prepareClaimInstructions

prepareClaimInstructions(
data: IClaimData,
extParams: ITransactionSolanaExtResolved<IInteractSolanaExt>,
): Promise<TransactionInstruction[]>
Parameters
- data: IClaimData
- extParams: ITransactionSolanaExtResolved<IInteractSolanaExt>
Returns Promise<TransactionInstruction[]>
Inherited from BaseDistributorClient.prepareClaimInstructions
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:283

prepareClawbackInstructions

prepareClawbackInstructions(
data: IClawbackData,
extParams: ITransactionSolanaExtResolved<IInteractSolanaExt>,
): Promise<TransactionInstruction[]>
Parameters
- data: IClawbackData
- extParams: ITransactionSolanaExtResolved<IInteractSolanaExt>
Returns Promise<TransactionInstruction[]>
Inherited from BaseDistributorClient.prepareClawbackInstructions
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:439

prepareCloseClaimInstructions

prepareCloseClaimInstructions(
data: ICloseClaimData,
extParams: ITransactionSolanaExtResolved<IInteractSolanaExt>,
): Promise<TransactionInstruction[]>
Parameters
- data: ICloseClaimData
- extParams: ITransactionSolanaExtResolved<IInteractSolanaExt>
Returns Promise<TransactionInstruction[]>
Inherited from BaseDistributorClient.prepareCloseClaimInstructions
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:396

prepareCreateInstructions

prepareCreateInstructions(
    data: ICreateDistributorData | ICreateAlignedDistributorData,
    extParams: ITransactionSolanaExtResolved<ICreateSolanaExt>,
): Promise<
    { distributorPublicKey: PublicKey; ixs: TransactionInstruction[] },
>
Parameters
- data: ICreateDistributorData | ICreateAlignedDistributorData
- extParams: ITransactionSolanaExtResolved<ICreateSolanaExt>
Returns Promise<{ distributorPublicKey: PublicKey; ixs: TransactionInstruction[] }>
Inherited from BaseDistributorClient.prepareCreateInstructions
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:129

searchDistributors

searchDistributors(
data: ISearchDistributors,
): Promise<IProgramAccount<MerkleDistributor>[]>
Parameters
- data: ISearchDistributors
Returns Promise<IProgramAccount<MerkleDistributor>[]>
Inherited from BaseDistributorClient.searchDistributors
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:526

`Protected`unwrapExecutionParams

unwrapExecutionParams<T extends IInteractSolanaExt>(
extParams: T,
): UnwrapAutoSimulate<T>
Type Parameters
- T extends IInteractSolanaExt
Parameters
- extParams: T
Returns UnwrapAutoSimulate<T>
Inherited from BaseDistributorClient.unwrapExecutionParams
- Defined in packages/distributor/solana/clients/BaseDistributorClient.ts:585

Class SolanaDistributorClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SolanaDistributorClient

Properties

Protectedcommitment

Protectedconnection

merkleDistributorProgram

ProtectedprogramId

ProtectedsendThrottler

Methods

claim

Parameters

Returns Promise<ITransactionResult>

clawback

Parameters

Returns Promise<ITransactionResult>

closeClaim

Parameters

Returns Promise<ITransactionResult>

create

Parameters

Returns Promise<ICreateDistributorResult>

getClaim

Parameters

Returns Promise<null | AnyClaimStatus>

getClaims

Parameters

Returns Promise<(null | AnyClaimStatus)[]>

ProtectedgetClawbackInstruction

Parameters

Returns Promise<TransactionInstruction>

getCommitment

Returns undefined | Commitment

getConnection

Returns Connection

getDistributorProgramId

Returns PublicKey

getDistributors

Parameters

Returns Promise<(null | MerkleDistributor)[]>

ProtectedgetNewDistributorArgs

Parameters

Returns NewDistributorArgs

ProtectedgetNewDistributorInstruction

Parameters

Returns Promise<TransactionInstruction>

ProtectedprepareClaimFeeInstruction

Parameters

Returns TransactionInstruction

prepareClaimInstructions

Parameters

Returns Promise<TransactionInstruction[]>

prepareClawbackInstructions

Parameters

Returns Promise<TransactionInstruction[]>

prepareCloseClaimInstructions

Parameters

Returns Promise<TransactionInstruction[]>

prepareCreateInstructions

Parameters

Returns Promise<{ distributorPublicKey: PublicKey; ixs: TransactionInstruction[] }>

searchDistributors

Parameters

Returns Promise<IProgramAccount<MerkleDistributor>[]>

ProtectedunwrapExecutionParams

Type Parameters

Parameters

Returns UnwrapAutoSimulate<T>

Settings

On This Page

`Protected`commitment

`Protected`connection

`Protected`programId

`Protected`sendThrottler

`Protected`getClawbackInstruction

`Protected`getNewDistributorArgs

`Protected`getNewDistributorInstruction

`Protected`prepareClaimFeeInstruction

`Protected`unwrapExecutionParams