add base sybil contract & sybil provider simulator

Author: lachlanglen

contracts/Cargo.lock

@@ -1,2 +1,9 @@
 [workspace]
-members = ["donation", "pot", "pot_deployer", "registry"]
+members = [
+    "donation",
+    "pot",
+    "pot_deployer",
+    "registry",
+    "sybil",
+    "sybil_provider_simulator"
+]

contracts/Cargo.toml

@@ -11,6 +11,8 @@
     "build:pot": "cd pot && ./scripts/build.sh && cd ..",
     "build:potdeployer": "cd pot_deployer && ./scripts/build.sh && cd ..",
     "build:registry": "cd registry && ./scripts/build.sh && cd ..",
+    "build:sybil": "cd sybil && ./scripts/build.sh && cd ..",
+    "build:sybilprovider": "cd sybil_provider_simulator && ./scripts/build.sh && cd ..",
     "dev:deploy:donation": "cd donation && ./scripts/deploy.sh && cd .. && yarn patch:config donation",
     "dev:deploy:donation:refresh": "cd donation && rm -rf neardev && ./scripts/deploy.sh && cd .. && yarn patch:config donation",
     "test:donation": "yarn test test/donation/contract.test.ts",
@@ -32,6 +34,11 @@
     "test:registry": "yarn test test/registry/contract.test.ts",
     "works:registry": "yarn build:registry && yarn dev:deploy:registry && yarn test:registry",
     "works:registry:refresh": "yarn build:registry && yarn dev:deploy:registry:refresh && yarn test:registry",
+    "dev:deploy:sybil": "cd sybil && ./scripts/deploy.sh && cd .. && yarn patch:config sybil",
+    "dev:deploy:sybil:refresh": "cd sybil && rm -rf neardev && ./scripts/deploy.sh && cd .. && yarn patch:config sybil",
+    "test:sybil": "yarn test test/sybil/contract.test.ts",
+    "works:sybil": "yarn build:sybil && yarn dev:deploy:sybil && yarn test:sybil",
+    "works:sybil:refresh": "yarn build:sybil && yarn dev:deploy:sybil:refresh && yarn test:sybil",
     "test": "mocha --require ts-node/register --timeout 240000",
     "test:all": "yarn test test/**/contract.test.ts"
   },

contracts/package.json

@@ -0,0 +1,21 @@
+[package]
+name = "sybil"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[dependencies]
+near-sdk = "4.1.1"
+
+[profile.release]
+codegen-units = 1
+# Tell `rustc` to optimize for small code size.
+opt-level = "z"
+lto = true
+debug = false
+panic = "abort"
+# Opt into extra safety checks on arithmetic operations https://stackoverflow.com/a/64136471/249801
+overflow-checks = true

contracts/sybil/Cargo.toml

@@ -0,0 +1,211 @@
+# PotLock Donation Contract
+
+## Purpose
+
+Provide a way to donate NEAR or FTs to any account, with a protocol fee taken out
+
+## Contract Structure
+
+### General Types
+
+```rs
+type DonationId = u64;
+type TimestampMs = u64;
+```
+
+### Contract
+
+```rs
+pub struct Contract {
+    contract_source_metadata: LazyOption<VersionedContractSourceMetadata>,
+    owner: AccountId,
+    protocol_fee_basis_points: u32,
+    referral_fee_basis_points: u32,
+    protocol_fee_recipient_account: AccountId,
+    donations_by_id: UnorderedMap<DonationId, VersionedDonation>,
+    donation_ids_by_recipient_id: LookupMap<AccountId, UnorderedSet<DonationId>>,
+    donation_ids_by_donor_id: LookupMap<AccountId, UnorderedSet<DonationId>>,
+    donation_ids_by_ft_id: LookupMap<AccountId, UnorderedSet<DonationId>>,
+}
+
+/// NOT stored in contract storage; only used for get_config response
+pub struct Config {
+    pub owner: AccountId,
+    pub protocol_fee_basis_points: u32,
+    pub referral_fee_basis_points: u32,
+    pub protocol_fee_recipient_account: AccountId,
+}
+```
+
+### Donations
+
+_NB: Projects are automatically approved by default._
+
+```rs
+pub struct Donation {
+    /// Unique identifier for the donation
+    pub id: DonationId,
+    /// ID of the donor               
+    pub donor_id: AccountId,
+    /// Amount donated         
+    pub total_amount: U128,
+    /// FT id (e.g. "near")
+    pub ft_id: AccountId,
+    /// Optional message from the donor          
+    pub message: Option<String>,
+    /// Timestamp when the donation was made
+    pub donated_at_ms: TimestampMs,
+    /// ID of the account receiving the donation  
+    pub recipient_id: AccountId,
+    /// Protocol fee
+    pub protocol_fee: U128,
+    /// Referrer ID
+    pub referrer_id: Option<AccountId>,
+    /// Referrer fee
+    pub referrer_fee: Option<U128>,
+}
+```
+
+### Contract Source Metadata
+
+_NB: Below implemented as per NEP 0330 (https://github.com/near/NEPs/blob/master/neps/nep-0330.md), with addition of `commit_hash`_
+
+```rs
+pub struct ContractSourceMetadata {
+    /// Version of source code, e.g. "v1.0.0", could correspond to Git tag
+    pub version: String,
+    /// Git commit hash of currently deployed contract code
+    pub commit_hash: String,
+    /// GitHub repo url for currently deployed contract code
+    pub link: String,
+}
+```
+
+## Methods
+
+### Write Methods
+
+```rs
+// DONATIONS
+
+#[payable]
+pub fn donate(
+    &mut self,
+    recipient_id: AccountId,
+    message: Option<String>,
+    referrer_id: Option<AccountId>,
+) -> Donation
+
+// OWNER
+
+#[payable]
+pub fn owner_change_owner(&mut self, owner: AccountId)
+
+pub fn owner_set_protocol_fee_basis_points(&mut self, protocol_fee_basis_points: u32)
+
+pub fn owner_set_referral_fee_basis_points(&mut self, referral_fee_basis_points: u32)
+
+pub fn owner_set_protocol_fee_recipient_account(&mut self, protocol_fee_recipient_account: AccountId)
+
+// SOURCE METADATA
+
+pub fn self_set_source_metadata(&mut self, source_metadata: ContractSourceMetadata) // only callable by the contract account (reasoning is that this should be able to be updated by the same account that can deploy code to the account)
+
+```
+
+### Read Methods
+
+```rs
+// CONFIG
+
+pub fn get_config(&self) -> Config
+
+// DONATIONS
+pub fn get_donations(&self, from_index: Option<u128>, limit: Option<u64>) -> Vec<Donation>
+
+pub fn get_donation_by_id(&self, donation_id: DonationId) -> Option<Donation>
+
+pub fn get_donations_for_recipient(
+        &self,
+        recipient_id: AccountId,
+        from_index: Option<u128>,
+        limit: Option<u64>,
+    ) -> Vec<Donation>
+
+pub fn get_donations_for_donor(
+    &self,
+    donor_id: AccountId,
+    from_index: Option<u128>,
+    limit: Option<u64>,
+) -> Vec<Donation>
+
+pub fn get_donations_for_ft(
+    &self,
+    ft_id: AccountId,
+    from_index: Option<u128>,
+    limit: Option<u64>,
+) -> Vec<Donation>
+
+// OWNER
+
+pub fn get_owner(&self) -> AccountId
+
+// SOURCE METADATA
+
+pub fn get_contract_source_metadata(&self) -> Option<ContractSourceMetadata>
+```
+
+## Events
+
+### `donation`
+
+Indicates that a `Donation` object has been created.
+
+**Example:**
+
+```json
+{
+    "standard": "potlock",
+    "version": "1.0.0",
+    "event": "donation",
+    "data": [
+        {
+            "donation": {
+                "donated_at_ms": 1698948121940,
+                "donor_id":"lachlan.near",
+                "ft_id":"near",
+                "id":9,
+                "message": "Go go go!",
+                "protocol_fee": "7000000000000000000000",
+                "recipient_id": "magicbuild.near",
+                "referrer_fee": "2000000000000000000000",
+                "referrer_id": "plugrel.near",
+                "total_amount": "100000000000000000000000"
+            },
+        }
+    ]
+}
+```
+
+### `set_source_metadata`
+
+Indicates that `ContractSourceMetadata` object has been set/updated.
+
+**Example:**
+
+```json
+{
+    "standard": "potlock",
+    "version": "1.0.0",
+    "event": "set_source_metadata",
+    "data": [
+        {
+            "source_metadata": {
+                "commit_hash":"ec02294253b22c2d4c50a75331df23ada9eb04db",
+                "link":"https://github.com/PotLock/core",
+                "version":"0.1.0",
+            }
+        }
+    ]
+}
+```

contracts/sybil/README.md

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+echo ">> Building Sybil contract"
+
+set -e
+
+export CARGO_TARGET_DIR=target
+RUSTFLAGS='-C link-arg=-s' cargo build --target wasm32-unknown-unknown --release
+mkdir -p ./out
+cp target/wasm32-unknown-unknown/release/*.wasm ./out/main.wasm
+echo ">> Finished Building Sybil contract"

contracts/sybil/out/main.wasm

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+if [ $? -ne 0 ]; then
+  echo ">> Error building Sybil contract"
+  exit 1
+fi
+
+echo ">> Deploying Sybil contract!"
+
+# https://docs.near.org/tools/near-cli#near-dev-deploy
+near dev-deploy --wasmFile ./out/main.wasm

contracts/sybil/scripts/build.sh

@@ -0,0 +1,44 @@
+use crate::*;
+
+/// source metadata update
+pub(crate) fn log_set_source_metadata_event(source_metadata: &ContractSourceMetadata) {
+    env::log_str(
+        format!(
+            "{}{}",
+            EVENT_JSON_PREFIX,
+            json!({
+                "standard": "potlock",
+                "version": "1.0.0",
+                "event": "set_source_metadata",
+                "data": [
+                    {
+                        "source_metadata": source_metadata,
+                    }
+                ]
+            })
+        )
+        .as_ref(),
+    );
+}
+
+/// add provider
+pub(crate) fn log_add_provider_event(provider_id: &ProviderId, provider: &Provider) {
+    env::log_str(
+        format!(
+            "{}{}",
+            EVENT_JSON_PREFIX,
+            json!({
+                "standard": "potlock",
+                "version": "1.0.0",
+                "event": "add_provider",
+                "data": [
+                    {
+                        "provider_id": provider_id,
+                        "provider": provider,
+                    }
+                ]
+            })
+        )
+        .as_ref(),
+    );
+}

contracts/sybil/scripts/deploy.sh

@@ -0,0 +1,30 @@
+use crate::*;
+
+impl Contract {
+    pub(crate) fn is_owner(&self) -> bool {
+        env::predecessor_account_id() == self.owner
+    }
+
+    pub(crate) fn is_admin(&self) -> bool {
+        self.admins.contains(&env::predecessor_account_id())
+    }
+
+    pub(crate) fn is_owner_or_admin(&self) -> bool {
+        self.is_owner() || self.is_admin()
+    }
+
+    pub(crate) fn assert_owner(&self) {
+        assert!(self.is_owner(), "Only contract owner can call this method");
+    }
+
+    pub(crate) fn assert_admin(&self) {
+        assert!(self.is_admin(), "Only contract admin can call this method");
+    }
+
+    pub(crate) fn assert_owner_or_admin(&self) {
+        assert!(
+            self.is_owner_or_admin(),
+            "Only contract owner or admin can call this method"
+        );
+    }
+}