Class MineWrapper

Hierarchy

MineWrapper

Index

Constructors

constructor

new MineWrapper(sdk: QuarrySDK): MineWrapper
Parameters
- sdk: QuarrySDK
Returns MineWrapper
- Defined in src/wrappers/mine/mine.ts:20

Properties

`Readonly` sdk

sdk: QuarrySDK

Accessors

program

get program(): MineProgram
Returns MineProgram
- Defined in src/wrappers/mine/mine.ts:26

provider

get provider(): AugmentedProvider
Returns AugmentedProvider
- Defined in src/wrappers/mine/mine.ts:22

Methods

createRewarder

createRewarder(param0: { authority?: PublicKey; baseKP?: Signer; mintWrapper: PublicKey }): Promise<{ key: PublicKey; tx: TransactionEnvelope }>
Creates a new Rewarder.

Returns
Parameters
- param0: { authority?: PublicKey; baseKP?: Signer; mintWrapper: PublicKey }
  - Optional authority?: PublicKey
  - Optional baseKP?: Signer
  - mintWrapper: PublicKey
Returns Promise<{ key: PublicKey; tx: TransactionEnvelope }>
- Defined in src/wrappers/mine/mine.ts:100

createRewarderV1

createRewarderV1(param0: { authority?: PublicKey; baseKP?: Signer; mintWrapper: PublicKey }): Promise<{ key: PublicKey; tx: TransactionEnvelope }>
Deprecated
Use createRewarder.

Returns
Parameters
- param0: { authority?: PublicKey; baseKP?: Signer; mintWrapper: PublicKey }
  - Optional authority?: PublicKey
  - Optional baseKP?: Signer
  - mintWrapper: PublicKey
Returns Promise<{ key: PublicKey; tx: TransactionEnvelope }>
- Defined in src/wrappers/mine/mine.ts:36

loadRewarderWrapper

loadRewarderWrapper(rewarder: PublicKey): Promise<RewarderWrapper>
Loads the rewarder wrapper.

Returns
Parameters
- rewarder: PublicKey
Returns Promise<RewarderWrapper>
- Defined in src/wrappers/mine/mine.ts:164

rescueTokens

rescueTokens(__namedParameters: { miner: PublicKey; minerTokenAccount: PublicKey; mint: PublicKey; owner?: PublicKey }): Promise<TransactionEnvelope>
Rescue stuck tokens in a miner.

Returns
Parameters
- __namedParameters: { miner: PublicKey; minerTokenAccount: PublicKey; mint: PublicKey; owner?: PublicKey }
  - miner: PublicKey
  - minerTokenAccount: PublicKey
  - mint: PublicKey
  - Optional owner?: PublicKey
Returns Promise<TransactionEnvelope>
- Defined in src/wrappers/mine/mine.ts:173

Class MineWrapper

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

sdk: QuarrySDK

Returns MineWrapper

Properties

Readonly sdk

Accessors

program

Returns MineProgram

provider

Returns AugmentedProvider

Methods

createRewarder

Returns

Parameters

param0: { authority?: PublicKey; baseKP?: Signer; mintWrapper: PublicKey }

Optional authority?: PublicKey

Optional baseKP?: Signer

mintWrapper: PublicKey

Returns Promise<{ key: PublicKey; tx: TransactionEnvelope }>

createRewarderV1

Deprecated

Returns

Parameters

param0: { authority?: PublicKey; baseKP?: Signer; mintWrapper: PublicKey }

Optional authority?: PublicKey

Optional baseKP?: Signer

mintWrapper: PublicKey

Returns Promise<{ key: PublicKey; tx: TransactionEnvelope }>

loadRewarderWrapper

Returns

Parameters

rewarder: PublicKey

Returns Promise<RewarderWrapper>

rescueTokens

Returns

Parameters

__namedParameters: { miner: PublicKey; minerTokenAccount: PublicKey; mint: PublicKey; owner?: PublicKey }

miner: PublicKey

minerTokenAccount: PublicKey

mint: PublicKey

Optional owner?: PublicKey

Returns Promise<TransactionEnvelope>

Settings

Member Visibility

Theme

`Readonly` sdk

`Optional` authority?: PublicKey

`Optional` baseKP?: Signer

`Optional` authority?: PublicKey

`Optional` baseKP?: Signer

`Optional` owner?: PublicKey