Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/step-finance/step-staking


https://github.com/step-finance/step-staking

Last synced: 24 days ago
JSON representation

Lists

README 

        


  


   step logo

  





# Step Staking



Program for single token staking and receiving rewards. Ala xSushi.



## Design Overview



![account design diagram](https://github.com/step-finance/step-staking/blob/main/account-design.png?raw=true)



*draw.io editable account design diagram*



## Note



- **This code is unaudited. Use at your own risk.**



## Developing



[Anchor](https://github.com/project-serum/anchor) is used for developoment, and it's

recommended workflow is used here. To get started, see the [guide](https://project-serum.github.io/anchor/getting-started/introduction.html).



### Build



```

anchor build --verifiable

```



The `--verifiable` flag should be used before deploying so that your build artifacts

can be deterministically generated with docker.



### Test



When testing locally, be sure to build with feature "local-testing" to enable the testing IDs.  You can do this by editing `programs/step-staking/Cargo.toml` and uncommenting the default feature set line.



```

anchor test

```



### Verify



To verify the program deployed on Solana matches your local source code, change directory

into the program you want to verify, e.g., `cd program`, and run



```bash

anchor verify 

```



A list of build artifacts can be found under [releases](https://github.com/step-finance/reward-pool/releases).



### Deploy



To deploy the program, configure your CLI to the desired network/wallet and run 



```bash

solana program deploy --program-id  target/verifiable/step_staking.so

```



I would not suggest using anchor deploy at this time; it wouldn't/couldn't really add much value.  Be sure to use `--programid ` to deploy to the correct address.



Note: By default, programs are deployed to accounts that are twice the size of the original deployment. Doing so leaves room for program growth in future redeployments. For this program, I beleive that's proper - I wouldn't want to limit it, nor do I see growth beyond double.



### Initial Migration



After deployment for the first time, you must point your `Anchor.toml` file to the network you've deployed to and run 



```bash

anchor migrate

```



This will call the `initialize` method to create the token vault. No specific calling key is needed - it can be called by anyone, and is a once only operation for PDA vault creation.  Subsequent runs will fail.



Any problems in this process can be triaged in the `migrations/deploy.js` file, which is what `anchor migrate` executes.



#### Set Mint Authority



The mint authority of the xSTEP token must be set to the PDA vault address `ANYxxG365hutGYaTdtUQG8u2hC4dFX9mFHKuzy9ABQJi`



## FAQ



---



> For single token staking, how do we calculate the APR in % that the users would receive? 



This has to be calculated using historical deposit data, through whatever means you are making deposits.  I would like to enhance this contract to use farm type distribution-over-time logic, but we kept this simple for now.



---



> what's the purpose of the emit_price handler?

 

A client can use a simulate call in anchor to get back the token ratio.  Just another way of doing things - it's similar to a solidity view.



---



## Additional Info



**Also, be sure to check out and maybe use instead the `generic` branch**.  It handles the xToken mint creation and ownership for you using a PDA.  We used what's in the `master` branch because we wanted to use a specific mint that we generated as the xToken.