Coda by Ian Macalinao
Preparing search index...
@macalinao/clients-quarry
QuarryMinePluginInstructions
Interface QuarryMinePluginInstructions
interface
QuarryMinePluginInstructions
{
acceptAuthority
:
(
input
:
AcceptAuthorityInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
;
claimRewards
:
(
input
:
ClaimRewardsAsyncInput
,
)
=>
Promise
<
ClaimRewardsInstruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
;
claimRewardsV2
:
(
input
:
ClaimRewardsV2AsyncInput
,
)
=>
Promise
<
ClaimRewardsV2Instruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
;
createMiner
:
(
input
:
MakeOptional
<
CreateMinerAsyncInput
<
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
>
,
"payer"
,
>
,
)
=>
Promise
<
CreateMinerInstruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
;
createMinerV2
:
(
input
:
MakeOptional
<
CreateMinerV2AsyncInput
<
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
>
,
"payer"
,
>
,
)
=>
Promise
<
CreateMinerV2Instruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
;
createQuarry
:
(
input
:
MakeOptional
<
CreateQuarryAsyncInput
<
string
,
string
,
string
,
string
,
string
,
string
,
string
,
>
,
"payer"
,
>
,
)
=>
Promise
<
CreateQuarryInstruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
;
createQuarryV2
:
(
input
:
MakeOptional
<
CreateQuarryV2AsyncInput
<
string
,
string
,
string
,
string
,
string
,
string
,
>
,
"payer"
,
>
,
)
=>
Promise
<
CreateQuarryV2Instruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
;
extractFees
:
(
input
:
ExtractFeesInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
ReadonlyAccount
<
string
>
,
WritableAccount
<
string
>
,
WritableAccount
<
string
>
,
ReadonlyAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
;
newRewarder
:
(
input
:
MakeOptional
<
NewRewarderAsyncInput
<
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
>
,
"payer"
,
>
,
)
=>
Promise
<
NewRewarderInstruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
;
newRewarderV2
:
(
input
:
MakeOptional
<
NewRewarderV2AsyncInput
<
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
>
,
"payer"
,
>
,
)
=>
Promise
<
NewRewarderV2Instruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
;
pause
:
(
input
:
PauseInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
;
rescueTokens
:
(
input
:
RescueTokensInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
ReadonlyAccount
<
string
>
,
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
WritableAccount
<
string
>
,
ReadonlyAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
;
setAnnualRewards
:
(
input
:
SetAnnualRewardsInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
;
setFamine
:
(
input
:
SetFamineInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
ReadonlyAccount
<
string
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
;
setPauseAuthority
:
(
input
:
SetPauseAuthorityInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
ReadonlyAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
;
setRewardsShare
:
(
input
:
SetRewardsShareInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
;
stakeTokens
:
(
input
:
StakeTokensAsyncInput
,
)
=>
Promise
<
StakeTokensInstruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
;
transferAuthority
:
(
input
:
TransferAuthorityInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
;
unpause
:
(
input
:
UnpauseInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
;
updateQuarryRewards
:
(
input
:
UpdateQuarryRewardsInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
WritableAccount
<
string
>
,
ReadonlyAccount
<
string
>
]
,
>
&
SelfPlanAndSendFunctions
;
withdrawTokens
:
(
input
:
WithdrawTokensAsyncInput
,
)
=>
Promise
<
WithdrawTokensInstruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
;
}
Index
Properties
accept
Authority
claim
Rewards
claim
Rewards
V2
create
Miner
create
Miner
V2
create
Quarry
create
Quarry
V2
extract
Fees
new
Rewarder
new
Rewarder
V2
pause
rescue
Tokens
set
Annual
Rewards
set
Famine
set
Pause
Authority
set
Rewards
Share
stake
Tokens
transfer
Authority
unpause
update
Quarry
Rewards
withdraw
Tokens
Properties
accept
Authority
acceptAuthority
:
(
input
:
AcceptAuthorityInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
claim
Rewards
claimRewards
:
(
input
:
ClaimRewardsAsyncInput
,
)
=>
Promise
<
ClaimRewardsInstruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
claim
Rewards
V2
claimRewardsV2
:
(
input
:
ClaimRewardsV2AsyncInput
,
)
=>
Promise
<
ClaimRewardsV2Instruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
create
Miner
createMiner
:
(
input
:
MakeOptional
<
CreateMinerAsyncInput
<
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
>
,
"payer"
,
>
,
)
=>
Promise
<
CreateMinerInstruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
create
Miner
V2
createMinerV2
:
(
input
:
MakeOptional
<
CreateMinerV2AsyncInput
<
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
>
,
"payer"
,
>
,
)
=>
Promise
<
CreateMinerV2Instruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
create
Quarry
createQuarry
:
(
input
:
MakeOptional
<
CreateQuarryAsyncInput
<
string
,
string
,
string
,
string
,
string
,
string
,
string
,
>
,
"payer"
,
>
,
)
=>
Promise
<
CreateQuarryInstruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
create
Quarry
V2
createQuarryV2
:
(
input
:
MakeOptional
<
CreateQuarryV2AsyncInput
<
string
,
string
,
string
,
string
,
string
,
string
,
>
,
"payer"
,
>
,
)
=>
Promise
<
CreateQuarryV2Instruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
extract
Fees
extractFees
:
(
input
:
ExtractFeesInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
ReadonlyAccount
<
string
>
,
WritableAccount
<
string
>
,
WritableAccount
<
string
>
,
ReadonlyAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
new
Rewarder
newRewarder
:
(
input
:
MakeOptional
<
NewRewarderAsyncInput
<
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
>
,
"payer"
,
>
,
)
=>
Promise
<
NewRewarderInstruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
new
Rewarder
V2
newRewarderV2
:
(
input
:
MakeOptional
<
NewRewarderV2AsyncInput
<
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
>
,
"payer"
,
>
,
)
=>
Promise
<
NewRewarderV2Instruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
pause
pause
:
(
input
:
PauseInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
rescue
Tokens
rescueTokens
:
(
input
:
RescueTokensInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
ReadonlyAccount
<
string
>
,
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
WritableAccount
<
string
>
,
ReadonlyAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
set
Annual
Rewards
setAnnualRewards
:
(
input
:
SetAnnualRewardsInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
set
Famine
setFamine
:
(
input
:
SetFamineInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
ReadonlyAccount
<
string
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
set
Pause
Authority
setPauseAuthority
:
(
input
:
SetPauseAuthorityInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
ReadonlyAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
set
Rewards
Share
setRewardsShare
:
(
input
:
SetRewardsShareInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
stake
Tokens
stakeTokens
:
(
input
:
StakeTokensAsyncInput
,
)
=>
Promise
<
StakeTokensInstruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
transfer
Authority
transferAuthority
:
(
input
:
TransferAuthorityInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
unpause
unpause
:
(
input
:
UnpauseInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
AccountMeta
<
string
>
&
{
role
:
READONLY_SIGNER
}
&
AccountSignerMeta
<
string
,
TransactionSigner
<
string
>
,
>
,
WritableAccount
<
string
>
,
]
,
>
&
SelfPlanAndSendFunctions
update
Quarry
Rewards
updateQuarryRewards
:
(
input
:
UpdateQuarryRewardsInput
,
)
=>
Instruction
<
Address
,
readonly
(
AccountMeta
<
string
>
|
AccountLookupMeta
<
string
,
string
>
)
[]
,
>
&
InstructionWithData
<
ReadonlyUint8Array
<
ArrayBufferLike
>
>
&
InstructionWithAccounts
<
[
WritableAccount
<
string
>
,
ReadonlyAccount
<
string
>
]
,
>
&
SelfPlanAndSendFunctions
withdraw
Tokens
withdrawTokens
:
(
input
:
WithdrawTokensAsyncInput
,
)
=>
Promise
<
WithdrawTokensInstruction
<
Address
,
string
,
string
,
string
,
string
,
string
,
string
,
string
,
[
]
,
>
,
>
&
SelfPlanAndSendFunctions
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
accept
Authority
claim
Rewards
claim
Rewards
V2
create
Miner
create
Miner
V2
create
Quarry
create
Quarry
V2
extract
Fees
new
Rewarder
new
Rewarder
V2
pause
rescue
Tokens
set
Annual
Rewards
set
Famine
set
Pause
Authority
set
Rewards
Share
stake
Tokens
transfer
Authority
unpause
update
Quarry
Rewards
withdraw
Tokens
Coda by Ian Macalinao
Loading...