Search
Preparing search index...
The search index is not available
@pactfi/pactsdk - v0.8.1
Options
All
Public
Public/Protected
All
Inherited
Menu
@pactfi/pactsdk - v0.8.1
Escrow
Class Escrow
Hierarchy
Escrow
Index
Constructors
constructor
Properties
_suggested
Params
address
algod
app
Id
farm
state
user
Address
Accessors
suggested
Params
Methods
build
Claim
Rewards
Tx
build
Delete
Tx
build
Exit
Tx
build
Force
Exit
Tx
build
Send
Message
Tx
build
Stake
Txs
build
Unstake
Txs
build
Withdraw
Algos
fetch
User
State
get
User
State
From
Account
Info
refresh
Suggested
Params
set
Suggested
Params
Constructors
constructor
new
Escrow
(
algod
:
default
, appId
:
number
, farm
:
Farm
, userAddress
:
string
, state
:
EscrowInternalState
)
:
Escrow
Parameters
algod:
default
appId:
number
farm:
Farm
userAddress:
string
state:
EscrowInternalState
Returns
Escrow
Properties
Private
_suggested
Params
_suggested
Params
:
null
|
SuggestedParams
= null
address
address
:
string
algod
algod
:
default
app
Id
app
Id
:
number
farm
farm
:
Farm
state
state
:
EscrowInternalState
user
Address
user
Address
:
string
Accessors
suggested
Params
get
suggestedParams
(
)
:
SuggestedParams
Returns
SuggestedParams
Methods
build
Claim
Rewards
Tx
build
Claim
Rewards
Tx
(
)
:
Transaction
Returns
Transaction
build
Delete
Tx
build
Delete
Tx
(
)
:
Transaction
Returns
Transaction
build
Exit
Tx
build
Exit
Tx
(
)
:
Transaction
Returns
Transaction
build
Force
Exit
Tx
build
Force
Exit
Tx
(
)
:
Transaction
Returns
Transaction
build
Send
Message
Tx
build
Send
Message
Tx
(
address
:
string
, message
:
string
)
:
Transaction
Parameters
address:
string
message:
string
Returns
Transaction
build
Stake
Txs
build
Stake
Txs
(
amount
:
number
)
:
Transaction
[]
Parameters
amount:
number
Returns
Transaction
[]
build
Unstake
Txs
build
Unstake
Txs
(
amount
:
number
)
:
Transaction
[]
Parameters
amount:
number
Returns
Transaction
[]
build
Withdraw
Algos
build
Withdraw
Algos
(
)
:
Transaction
Returns
Transaction
fetch
User
State
fetch
User
State
(
)
:
Promise
<
null
|
FarmUserState
>
Returns
Promise
<
null
|
FarmUserState
>
get
User
State
From
Account
Info
get
User
State
From
Account
Info
(
accountInfo
:
any
)
:
null
|
FarmUserState
Parameters
accountInfo:
any
Returns
null
|
FarmUserState
refresh
Suggested
Params
refresh
Suggested
Params
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
set
Suggested
Params
set
Suggested
Params
(
suggestedParams
:
SuggestedParams
)
:
void
Parameters
suggestedParams:
SuggestedParams
Returns
void
Exports
default
Escrow
constructor
_suggested
Params
address
algod
app
Id
farm
state
user
Address
suggested
Params
build
Claim
Rewards
Tx
build
Delete
Tx
build
Exit
Tx
build
Force
Exit
Tx
build
Send
Message
Tx
build
Stake
Txs
build
Unstake
Txs
build
Withdraw
Algos
fetch
User
State
get
User
State
From
Account
Info
refresh
Suggested
Params
set
Suggested
Params
Generated using
TypeDoc