Class QuarrySDK

Quarry SDK.

Hierarchy

QuarrySDK

Index

Constructors

Properties

programs provider

Accessors

mergeMine mine mintWrapper programList registry

Methods

createOperator createRedeemer loadOperator loadRedeemer newTx withSigner load

Constructors

constructor

new QuarrySDK(provider: AugmentedProvider, programs: Programs): QuarrySDK
Parameters
- provider: AugmentedProvider
- programs: Programs
Returns QuarrySDK
- Defined in src/sdk.ts:32

Properties

`Readonly` programs

programs: Programs

`Readonly` provider

provider: AugmentedProvider

Accessors

mergeMine

get mergeMine(): MergeMine
Returns MergeMine
- Defined in src/sdk.ts:62

mine

get mine(): MineWrapper
Returns MineWrapper
- Defined in src/sdk.ts:54

mintWrapper

get mintWrapper(): MintWrapper
Returns MintWrapper
- Defined in src/sdk.ts:50

programList

get programList(): Program<Idl>[]
Returns Program<Idl>[]
- Defined in src/sdk.ts:46

registry

get registry(): QuarryRegistry
Returns QuarryRegistry
- Defined in src/sdk.ts:58

Methods

createOperator

createOperator(__namedParameters: { admin?: PublicKey; baseKP?: Signer; payer?: PublicKey; rewarder: PublicKey }): Promise<{ key: PublicKey; tx: TransactionEnvelope }>
Creates an Operator.

Returns
Parameters
- __namedParameters: { admin?: PublicKey; baseKP?: Signer; payer?: PublicKey; rewarder: PublicKey }
  - Optional admin?: PublicKey
  - Optional baseKP?: Signer
  - Optional payer?: PublicKey
  - rewarder: PublicKey
Returns Promise<{ key: PublicKey; tx: TransactionEnvelope }>
- Defined in src/sdk.ts:141

createRedeemer

createRedeemer(__namedParameters: { iouMint: PublicKey; redemptionMint: PublicKey }): Promise<PendingRedeemer>
Parameters
- __namedParameters: { iouMint: PublicKey; redemptionMint: PublicKey }
  - iouMint: PublicKey
  - redemptionMint: PublicKey
Returns Promise<PendingRedeemer>
- Defined in src/sdk.ts:111

loadOperator

loadOperator(key: PublicKey): Promise<null | Operator>
Loads an operator.

Returns
Parameters
- key: PublicKey
Returns Promise<null | Operator>
- Defined in src/sdk.ts:130

loadRedeemer

loadRedeemer(__namedParameters: { iouMint: PublicKey; redemptionMint: PublicKey }): Promise<RedeemerWrapper>
Parameters
- __namedParameters: { iouMint: PublicKey; redemptionMint: PublicKey }
  - iouMint: PublicKey
  - redemptionMint: PublicKey
Returns Promise<RedeemerWrapper>
- Defined in src/sdk.ts:101

newTx

newTx(instructions: TransactionInstruction[], signers?: Signer[]): TransactionEnvelope
Constructs a new transaction envelope.

Returns
Parameters
- instructions: TransactionInstruction[]
- Optional signers: Signer[]
Returns TransactionEnvelope
- Defined in src/sdk.ts:72

withSigner

withSigner(signer: Signer): QuarrySDK
Creates a new instance of the SDK with the given keypair.
Parameters
- signer: Signer
Returns QuarrySDK
- Defined in src/sdk.ts:40

`Static` load

load(__namedParameters: { addresses?: { MergeMine?: PublicKey; Mine?: PublicKey; MintWrapper?: PublicKey; Operator?: PublicKey; Redeemer?: PublicKey; Registry?: PublicKey }; provider: Provider }): QuarrySDK
Loads the SDK.

Returns
Parameters
- __namedParameters: { addresses?: { MergeMine?: PublicKey; Mine?: PublicKey; MintWrapper?: PublicKey; Operator?: PublicKey; Redeemer?: PublicKey; Registry?: PublicKey }; provider: Provider }
  - Optional addresses?: { MergeMine?: PublicKey; Mine?: PublicKey; MintWrapper?: PublicKey; Operator?: PublicKey; Redeemer?: PublicKey; Registry?: PublicKey }
    - Optional MergeMine?: PublicKey
    - Optional Mine?: PublicKey
    - Optional MintWrapper?: PublicKey
    - Optional Operator?: PublicKey
    - Optional Redeemer?: PublicKey
    - Optional Registry?: PublicKey
  - provider: Provider
Returns QuarrySDK
- Defined in src/sdk.ts:83

Generated using TypeDoc