staking.md

Staking contract

Create staking

JNTR-b-token/contracts/Staking.sol

Lines 195 to 198 in fa5f736

	// Create new staking by user with selected option
	// optionId - staking option ID
	// amount - amount of tokens that user wants to stake
	function createOrder(uint256 optionId, uint256 amount) external returns(bool) {

Withdraw tokens + reward from staking

JNTR-b-token/contracts/Staking.sol

Lines 211 to 212 in fa5f736

	// withdraw staking amount + rewards for selected order by user
	function withdraw(uint256 id) external returns(bool) {

Withdraw tokens from staking without reward

JNTR-b-token/contracts/Staking.sol

Lines 225 to 226 in fa5f736

	// in case of empty rewards Pool user can withdraw tokens without reward
	function withdrawWithoutReward(uint256 id) external returns(bool) {

Change staking option to another with longer staking period

JNTR-b-token/contracts/Staking.sol

Lines 238 to 241 in fa5f736

	// user may change staking option to another with longer staking period
	// id - staking order id that user wants to upgrade
	// optionId - new option than user wants to use for his staking order
	function upgradeOrder(uint256 id, uint256 optionId) external returns(bool) {

Add more tokens to existing staking

JNTR-b-token/contracts/Staking.sol

Lines 258 to 261 in fa5f736

	// user can add more tokens to existing staking order
	// id - staking order where user wants to add token
	// amount - amount of tokens user wants to add
	function addToOrder(uint256 id, uint256 amount) external returns(bool) {

View functions

Get number of staking orders of user

JNTR-b-token/contracts/Staking.sol

Lines 173 to 174 in fa5f736

	// returns number of staking by user
	function getNumberOrders(address user) external view returns(uint256 number) {

Get all staking orders of user

JNTR-b-token/contracts/Staking.sol

Lines 178 to 179 in fa5f736

	// returns staking orders by user
	function getOrders(address user) external view returns(Order[] memory order) {

Get selected staking order of user

JNTR-b-token/contracts/Staking.sol

Lines 183 to 184 in fa5f736

	// returns selected staking order by user
	function getOrder(address user, uint256 id) external view returns(Order memory order) {

Get rewards earne by user in selected staking order

JNTR-b-token/contracts/Staking.sol

Lines 188 to 191 in fa5f736

	// returns amount of reward earned by user in selected staking order
	//user - address of user wallet
	//id - order id of user
	function calculateReward(address user, uint256 id) external view returns(uint256 reward) {

Get available staking options

JNTR-b-token/contracts/Staking.sol

Lines 126 to 127 in fa5f736

	// returns all options
	function getOptions() external view returns(Option[] memory) {

Get selected staking option

JNTR-b-token/contracts/Staking.sol

Lines 131 to 132 in fa5f736

	// returns selected option
	function getOption(uint256 id) external view returns(Option memory option) {