Search
Preparing search index...
The search index is not available
Mirror.js
Options
All
Public
Public/Protected
All
Inherited
Menu
Mirror.js
contracts/MirrorGov
MirrorGov
Class MirrorGov
Hierarchy
ContractClient
MirrorGov
Index
Constructors
constructor
Properties
codeID
contract
Address
key
lcd
Accessors
wallet
Methods
cast
Vote
create
Poll
end
Poll
execute
Poll
expire
Poll
get
Config
get
Poll
get
Polls
get
Staker
get
State
get
Voters
init
stake
Voting
Tokens
update
Config
withdraw
Voting
Tokens
Constructors
constructor
new
Mirror
Gov
(
options
:
Partial
<
{
codeID
:
number
;
contractAddress
:
string
;
key
:
Key
;
lcd
:
LCDClient
}
>
)
:
MirrorGov
Parameters
options:
Partial
<
{
codeID
:
number
;
contractAddress
:
string
;
key
:
Key
;
lcd
:
LCDClient
}
>
Returns
MirrorGov
Properties
Optional
codeID
codeID
:
undefined
|
number
Optional
contract
Address
contract
Address
:
undefined
|
string
key
key
:
Key
Optional
lcd
lcd
:
undefined
|
LCDClient
Accessors
wallet
get
wallet
(
)
:
Wallet
Returns
Wallet
Methods
cast
Vote
cast
Vote
(
poll_id
:
number
, vote
:
VoteOption
, amount
:
Value
)
:
MsgExecuteContract
Parameters
poll_id:
number
vote:
VoteOption
amount:
Value
Returns
MsgExecuteContract
create
Poll
create
Poll
(
terraswap_token
:
TerraswapToken
, deposit_amount
:
Value
, title
:
string
, description
:
string
, link
?:
string
, execute_msg
?:
ExecuteMsg
)
:
MsgExecuteContract
Parameters
terraswap_token:
TerraswapToken
deposit_amount:
Value
title:
string
description:
string
Optional
link:
string
Optional
execute_msg:
ExecuteMsg
Returns
MsgExecuteContract
end
Poll
end
Poll
(
poll_id
:
number
)
:
MsgExecuteContract
Parameters
poll_id:
number
Returns
MsgExecuteContract
execute
Poll
execute
Poll
(
poll_id
:
number
)
:
MsgExecuteContract
Parameters
poll_id:
number
Returns
MsgExecuteContract
expire
Poll
expire
Poll
(
poll_id
:
number
)
:
MsgExecuteContract
Parameters
poll_id:
number
Returns
MsgExecuteContract
get
Config
get
Config
(
)
:
Promise
<
ConfigResponse
>
Returns
Promise
<
ConfigResponse
>
get
Poll
get
Poll
(
poll_id
:
number
)
:
Promise
<
PollResponse
>
Parameters
poll_id:
number
Returns
Promise
<
PollResponse
>
get
Polls
get
Polls
(
filter
?:
"in_progress"
|
"passed"
|
"rejected"
|
"executed"
, start_after
?:
number
, limit
?:
number
)
:
Promise
<
PollsResponse
>
Parameters
Optional
filter:
"in_progress"
|
"passed"
|
"rejected"
|
"executed"
Optional
start_after:
number
Optional
limit:
number
Returns
Promise
<
PollsResponse
>
get
Staker
get
Staker
(
address
:
string
)
:
Promise
<
StakerResponse
>
Parameters
address:
string
Returns
Promise
<
StakerResponse
>
get
State
get
State
(
)
:
Promise
<
StateResponse
>
Returns
Promise
<
StateResponse
>
get
Voters
get
Voters
(
poll_id
:
number
, start_after
?:
string
, limit
?:
number
)
:
Promise
<
VotersResponse
>
Parameters
poll_id:
number
Optional
start_after:
string
Optional
limit:
number
Returns
Promise
<
VotersResponse
>
init
init
(
init_msg
:
InitMsg
, migratable
:
boolean
)
:
MsgInstantiateContract
Parameters
init_msg:
InitMsg
migratable:
boolean
Returns
MsgInstantiateContract
stake
Voting
Tokens
stake
Voting
Tokens
(
terraswap_token
:
TerraswapToken
, amount
:
Value
)
:
MsgExecuteContract
Parameters
terraswap_token:
TerraswapToken
amount:
Value
Returns
MsgExecuteContract
update
Config
update
Config
(
config
:
{
effective_delay
?:
undefined
|
number
;
expiration_period
?:
undefined
|
number
;
owner
?:
undefined
|
string
;
proposal_deposit
?:
undefined
|
string
;
quorum
?:
undefined
|
string
;
threshold
?:
undefined
|
string
;
voting_period
?:
undefined
|
number
}
)
:
MsgExecuteContract
Parameters
config:
{
effective_delay
?:
undefined
|
number
;
expiration_period
?:
undefined
|
number
;
owner
?:
undefined
|
string
;
proposal_deposit
?:
undefined
|
string
;
quorum
?:
undefined
|
string
;
threshold
?:
undefined
|
string
;
voting_period
?:
undefined
|
number
}
Optional
effective_
delay
?:
undefined
|
number
Optional
expiration_
period
?:
undefined
|
number
Optional
owner
?:
undefined
|
string
Optional
proposal_
deposit
?:
undefined
|
string
Optional
quorum
?:
undefined
|
string
Optional
threshold
?:
undefined
|
string
Optional
voting_
period
?:
undefined
|
number
Returns
MsgExecuteContract
withdraw
Voting
Tokens
withdraw
Voting
Tokens
(
amount
?:
string
|
number
|
Decimal
)
:
MsgExecuteContract
Parameters
Optional
amount:
string
|
number
|
Decimal
Returns
MsgExecuteContract
Exports
client/
Mirror
contracts/
Contract
Client
contracts/
Mirror
Airdrop
contracts/
Mirror
Collector
contracts/
Mirror
Community
contracts/
Mirror
Factory
contracts/
Mirror
Gov
Mirror
Gov
contracts/
Mirror
Mint
contracts/
Mirror
Oracle
contracts/
Mirror
Staking
contracts/
Terraswap
Factory
contracts/
Terraswap
Pair
contracts/
Terraswap
Token
utils/
Asset
utils/
Empty
Key
utils/
Empty
Object
Mirror
Gov
constructor
codeID
contract
Address
key
lcd
wallet
cast
Vote
create
Poll
end
Poll
execute
Poll
expire
Poll
get
Config
get
Poll
get
Polls
get
Staker
get
State
get
Voters
init
stake
Voting
Tokens
update
Config
withdraw
Voting
Tokens