Merge pull request #54 from Zoints/documentation

Adding additional comments for open sourcing

Author: WhoSoup

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2021 Zoints
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,28 +1,7 @@
+# Zoints Staking
 
-## Running Tests
+Layout of this repository:
 
-Install JavaScript dependencies:
-
-```bash
-cd js
-npm i
-npm run build
-cd ../test_server
-npm i
-```
-
-Build Solana program:
-
-```bash
-cd ../program
-cargo build-bpf
-```
-
-Start Solana node and interactive web server:
-
-```bash
-cd ../test_server
-docker-compose up -d
-
-npm run start
-```
+* [/program](/program) The code for the Solana staking program used by Zoints
+* [/js](/js) The code for the [@zoints/staking](https://www.npmjs.com/package/@zoints/staking) library published on npmjs
+* [/test_server](/test_server) A developer test environment to allow quick simulations of the code and test features

program/src/account.rs

@@ -168,7 +168,7 @@ impl Settings {
     }
 }
 
-/// The PDA that owns the pool associated accounts
+/// The PDA that owns the reward pool associated account
 #[derive(Debug, PartialEq, Clone, Copy, Eq)]
 pub struct PoolAuthority {}
 impl PoolAuthority {
@@ -204,7 +204,10 @@ impl RewardPool {
     }
 }
 
-/// The way that the "Authority" address should be interpreted.
+/// The way that the "Authority" address of a Stake should be interpreted.
+/// A "Basic" authority is a direct ownership of the stake by a wallet address.
+/// An "NFT" authority is a delegated ownership, where the current holder of the
+/// NFT is considered the owner.
 #[derive(Debug, PartialEq, Eq, Clone, Copy, BorshDeserialize, BorshSerialize)]
 pub enum Authority {
     /// A regular Solana address that can sign instructions
@@ -214,6 +217,7 @@ pub enum Authority {
 }
 
 impl Authority {
+    /// Verifies that an account matches the authority's type
     pub fn verify(&self, account: &AccountInfo) -> Result<(), ProgramError> {
         match self {
             Authority::Basic(pubkey) => {
@@ -242,6 +246,9 @@ impl Authority {
         }
     }
 
+    /// Verifies that the owner and signer accounts provided a valid signature for the authority type.
+    /// For a basic authority, the owner and signer are the same account.
+    /// For an NFT authority, the owner is the associated SPL token accont, the signer is the associated account's owner
     pub fn has_signed(&self, owner: &AccountInfo, signer: &AccountInfo) -> bool {
         match self {
             Authority::Basic(key) => {
@@ -358,7 +365,7 @@ impl Beneficiary {
     }
 }
 
-/// The account that initiated a stake
+/// The account that holds the data for a staker staking with a specific Endpoint.
 #[derive(Debug, PartialEq, BorshDeserialize, BorshSerialize, Clone, Copy, Eq)]
 pub struct Stake {
     /// Time the account was initiated