Interface: MerkleDistributorProgram

Merkle distributor program interface

Methods

all()

all(): Promise<MerkleDistributor[]>;

Fetch all merkle distributor accounts

Returns

Promise<MerkleDistributor[]>

---

allClaimStatus()

allClaimStatus(): Promise<ClaimStatus[]>;

Fetch all claim status accounts

Returns

Promise<ClaimStatus[]>

---

claim()

claim(params): Promise<NewClaimInstruction<Address, string, string, string, string, string, string, string, []>>;

Claim tokens from a merkle distributor.

Parameters

Parameter	Type
params	{ amountLocked: number | bigint; amountUnlocked: number | bigint; claimant?: TransactionSigner; distributor: Address; proof: ReadonlyUint8Array[]; target: ClaimTarget; }
params.amountLocked	number | bigint
params.amountUnlocked	number | bigint
params.claimant?	TransactionSigner
params.distributor	Address
params.proof	ReadonlyUint8Array[]
params.target	ClaimTarget

Returns

Promise<NewClaimInstruction<Address, string, string, string, string, string, string, string, []>>

---

clawback()

clawback(params): Promise<ClawbackInstruction<Address, string, string, string, string, string, string, []>>;

Clawback tokens from a merkle distributor.

Parameters

Parameter	Type
params	{ claimant?: TransactionSigner; distributor: Address; }
params.claimant?	TransactionSigner
params.distributor	Address

Returns

Promise<ClawbackInstruction<Address, string, string, string, string, string, string, []>>

---

get()

get(addr): Promise<MerkleDistributor>;

Fetch a merkle distributor account by address

Parameters

Parameter	Type
addr	Address

Returns

Promise<MerkleDistributor>

---

getClaimStatus()

getClaimStatus(addr): Promise<ClaimStatus>;

Fetch a claim status account by address

Parameters

Parameter	Type
addr	Address

Returns

Promise<ClaimStatus>

---

getClaimStatusForDistributor()

getClaimStatusForDistributor(distributor, claimant?): Promise<ClaimStatus | null>;

Fetch claim status for a specific distributor and optional claimant.

Parameters

Parameter	Type
distributor	Address
claimant?	Address

Returns

Promise<ClaimStatus | null>

---

getClaimStatusPda()

getClaimStatusPda(distributor, claimant?): Promise<Address>;

Derive the ClaimStatus PDA address for a given distributor and optional claimant.

Parameters

Parameter	Type
distributor	Address
claimant?	Address

Returns

Promise<Address>