Class MergeMiner

Hierarchy

MergeMiner

Index

Constructors

constructor

new MergeMiner(mergeMine: MergeMine, pool: { data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>; key: PublicKey }, mm: { data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>; key: PublicKey }): MergeMiner
Parameters
- mergeMine: MergeMine
- pool: { data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>; key: PublicKey }
  - data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>
  - key: PublicKey
- mm: { data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>; key: PublicKey }
  - data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>
  - key: PublicKey
Returns MergeMiner
- Defined in src/wrappers/mergeMine/mergeMiner.ts:25

Properties

`Readonly` mergeMine

mergeMine: MergeMine

`Readonly` mm

mm: { data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>; key: PublicKey }

Type declaration

data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>
key: PublicKey

`Readonly` pool

pool: { data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>; key: PublicKey }

Type declaration

data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>
key: PublicKey

Accessors

commonStakeAccounts

get commonStakeAccounts(): Pick<QuarryStakeAccounts, "tokenProgram" | "pool" | "mm" | "mineProgram">
Returns Pick<QuarryStakeAccounts, "tokenProgram" | "pool" | "mm" | "mineProgram">
- Defined in src/wrappers/mergeMine/mergeMiner.ts:430

primaryMint

get primaryMint(): PublicKey
Returns PublicKey
- Defined in src/wrappers/mergeMine/mergeMiner.ts:45

program

get program(): QuarryMergeMineProgram
Returns QuarryMergeMineProgram
- Defined in src/wrappers/mergeMine/mergeMiner.ts:41

provider

get provider(): Provider
Returns Provider
- Defined in src/wrappers/mergeMine/mergeMiner.ts:37

replicaMint

get replicaMint(): PublicKey
Returns PublicKey
- Defined in src/wrappers/mergeMine/mergeMiner.ts:49

Methods

claimPrimaryRewards

claimPrimaryRewards(rewarder: PublicKey): Promise<TransactionEnvelope>
Claims rewards for a primary account.

Returns
Parameters
- rewarder: PublicKey
Returns Promise<TransactionEnvelope>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:312

claimReplicaRewards

claimReplicaRewards(rewarder: PublicKey): Promise<TransactionEnvelope>
Claims rewards for a replica account.

Returns
Parameters
- rewarder: PublicKey
Returns Promise<TransactionEnvelope>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:323

claimRewardsCommon

claimRewardsCommon(quarryMint: PublicKey, stake: QuarryStakeAccounts, mmOwner?: PublicKey): Promise<TransactionEnvelope>
Claims internal mining rewards.

Returns
Parameters
- quarryMint: PublicKey
- stake: QuarryStakeAccounts
- mmOwner: PublicKey = ...
Returns Promise<TransactionEnvelope>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:335

deposit

deposit(amount: { amount: TokenAmount; rewarder: PublicKey }): Promise<TransactionEnvelope>
Deposit primary tokens into the merge miner.

Returns
Parameters
- amount: { amount: TokenAmount; rewarder: PublicKey }
  - amount: TokenAmount
  - rewarder: PublicKey
Returns Promise<TransactionEnvelope>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:58

getPrimaryStakeAccounts

getPrimaryStakeAccounts(rewarder: PublicKey): Promise<QuarryStakeAccounts>
Parameters
- rewarder: PublicKey
Returns Promise<QuarryStakeAccounts>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:412

getReplicaStakeAccounts

getReplicaStakeAccounts(rewarder: PublicKey): Promise<QuarryStakeAccounts>
Parameters
- rewarder: PublicKey
Returns Promise<QuarryStakeAccounts>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:394

stakePrimaryMiner

stakePrimaryMiner(rewarder: PublicKey): Promise<TransactionEnvelope>
Deposits tokens into the primary quarry. (Not recommended-- you probably want deposit.)

Returns
Parameters
- rewarder: PublicKey
Returns Promise<TransactionEnvelope>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:96

stakeReplicaMiner

stakeReplicaMiner(rewarder: PublicKey): Promise<TransactionEnvelope>
Stakes replica tokens into a miner.

Returns
Parameters
- rewarder: PublicKey
Returns Promise<TransactionEnvelope>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:117

unstakeAllReplica

unstakeAllReplica(rewarder: PublicKey): Promise<TransactionEnvelope>
Unstakes all replica tokens from a quarry. You must call this function for each replica miner before unstaking the primary.

Returns
Parameters
- rewarder: PublicKey
Returns Promise<TransactionEnvelope>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:202

unstakePrimaryMiner

unstakePrimaryMiner(rewarder: PublicKey, amount: TokenAmount): Promise<TransactionEnvelope>
Withdraws primary tokens from the quarry. (Not recommended-- you probably want withdraw.)

Returns
Parameters
- rewarder: PublicKey
- amount: TokenAmount
Returns Promise<TransactionEnvelope>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:225

withdraw

withdraw(amount: { amount: TokenAmount; rewarder: PublicKey }): Promise<TransactionEnvelope>
Withdraw staked tokens from a merge miner.

Returns
Parameters
- amount: { amount: TokenAmount; rewarder: PublicKey }
  - amount: TokenAmount
  - rewarder: PublicKey
Returns Promise<TransactionEnvelope>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:180

withdrawPrimaryFromMM

withdrawPrimaryFromMM(): Promise<TransactionEnvelope>
Withdraws unstaked primary tokens from the merge miner. (Not recommended-- you probably want withdraw.)

Returns

Returns Promise<TransactionEnvelope>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:250

withdrawTokens

withdrawTokens(withdrawMint: PublicKey): Promise<TransactionEnvelope>
Withdraws a specific mint from the merge miner.

Returns
Parameters
- withdrawMint: PublicKey
Returns Promise<TransactionEnvelope>
- Defined in src/wrappers/mergeMine/mergeMiner.ts:283

Class MergeMiner

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

mergeMine: MergeMine

pool: { data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>; key: PublicKey }

data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>

key: PublicKey

mm: { data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>; key: PublicKey }

data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>

key: PublicKey

Returns MergeMiner

Properties

Readonly mergeMine

Readonly mm

Type declaration

data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>

key: PublicKey

Readonly pool

Type declaration

data: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMergeMine, Record<string, never>>>

key: PublicKey

Accessors

commonStakeAccounts

Returns Pick<QuarryStakeAccounts, "tokenProgram" | "pool" | "mm" | "mineProgram">

primaryMint

Returns PublicKey

program

Returns QuarryMergeMineProgram

provider

Returns Provider

replicaMint

Returns PublicKey

Methods

claimPrimaryRewards

Returns

Parameters

rewarder: PublicKey

Returns Promise<TransactionEnvelope>

claimReplicaRewards

Returns

Parameters

rewarder: PublicKey

Returns Promise<TransactionEnvelope>

claimRewardsCommon

Returns

Parameters

quarryMint: PublicKey

stake: QuarryStakeAccounts

mmOwner: PublicKey = ...

Returns Promise<TransactionEnvelope>

deposit

Returns

Parameters

amount: { amount: TokenAmount; rewarder: PublicKey }

amount: TokenAmount

rewarder: PublicKey

Returns Promise<TransactionEnvelope>

getPrimaryStakeAccounts

Parameters

rewarder: PublicKey

Returns Promise<QuarryStakeAccounts>

getReplicaStakeAccounts

Parameters

rewarder: PublicKey

Returns Promise<QuarryStakeAccounts>

stakePrimaryMiner

Returns

Parameters

rewarder: PublicKey

Returns Promise<TransactionEnvelope>

stakeReplicaMiner

Returns

Parameters

`Readonly` mergeMine

`Readonly` mm

`Readonly` pool