Merge pull request #137 from chiggimps/main

nattydao concept for challenge

Author: klembee

6-nfts-for-financial-applications/NattyDAO/README.md

@@ -0,0 +1,65 @@
+THIS IS TOTALLY UNFINISHED, but wanted to submit it just for the sake of 'why the hell not?'.
+
+Basically there's a relay script that checks an external API for changes, loads a file with those changes, and then mints them as NFTs using an RTM. This relay is TBD (to be decentralized).
+
+That RTM is calling into [scrypto/inatty-oracle/src/mint.rs](scrypto/inatty-oracle/src/mint.rs) in the `create_nft` method.
+
+This is not an NFT for finance use cases, but an NFT for "Regenerative Finance" use cases. 
+
+------------------
+
+## <This is all conceptual until Babylon. Please join now and help build this project with me!>
+
+See [shardeez.xyz/refi](https://shardeez.xyz/refi) for resources on Regenerative Finance (ReFi). Let's learn about ReFi and build together!
+
+## Idea for NattyDAO
+
+### Mission
+
+To support members of the Radix community to `touch grass` & `touch trash`.
+
+DAO funds small-scale environmental benefits such as: wildland trash pickups, beach cleanups, de-paving (removing concrete and replacing w/ native plants), gardening projects, pollinator homes, and more. 
+
+### Mechanism
+
+- Members propose a project, request funding from treasury.
+  
+- Holders of INATTY token vote to pass or reject proposal.
+  
+- Quadratic funding mechanism w/ a matching pool.
+  
+- Treasury funded by sale of NFTs, donations.
+
+### iNATTY Token
+
+The first token backed by relationships to nature. It's used to buy NFTs from the NattyDAO. It's also used to vote on proposals to fund environmental projects.
+
+### iNATTY NFTs (THIS PART USED FOR SUBMISSION TO SCRYPTO CHALLENGE)
+
+NFTs minted by the NattyDAO that represent a member outside experiencing nature. These NFTs are minted using data from the **iNatty Oracle**. Whenever a registered member experiences nature, an NFT is minted. This nature experience is provable because of integration with the iNaturalist API.
+
+They are then offered for sale in an NFT marketplace. They can only be purchased with INATTY, and 50% of the funds go to the NattyDAO treasury, and 50% go to the member.
+
+### iNATTY Oracle 
+
+Relays information about the member's associated iNaturalist accounts to the NattyDAO components. One part watches for new registrations of [iNaturalist.org](https://inaturalist.org) accounts and keeps track of the member's activity in a Scrypto Component. Another part watches for new observations on iNaturalist and mints NFTs for the member (metadata includes the natural experience, including image, species identified, location, and date).
+
+### NattyDAO Treasury
+
+This is used to incentivize members to participate in the NattyDAO. It is funded by the sale of iNATTY NFTs. Proposals can be made to the NattyDAO to spend funds from the treasury.
+
+### Optimistic Funding (provable cleanups idea)
+
+- Once funded the project is given 1 week to complete and prove to the community their efforts.
+  
+- If no dispute about their efforts, XRD automatically sent to their address
+  
+- Someone disputing must bond some XRD.
+  
+- Their dispute is voted on, if found out true then they get their bonded XRD back + some reward.
+  
+- If their dispute isn't corroborated by community, they lose their bond.
+
+### References
+
+- [Open Forest Protocol Whiteboard Series (YouTube)](https://www.youtube.com/watch?v=ZjFT2KoUgks&list=PLWJdg32OtDLUbxcE_Qr0GTHQ0L07mikej)

6-nfts-for-financial-applications/NattyDAO/relays/src/.env

@@ -0,0 +1 @@
+INAT_API_KEY=""

6-nfts-for-financial-applications/NattyDAO/relays/src/dao_members.txt

@@ -0,0 +1 @@
+chiggimps

6-nfts-for-financial-applications/NattyDAO/relays/src/inatty.py

@@ -0,0 +1,95 @@
+# Connect to the iNaturalist API and get the data for a given user.
+# There's a lot more we can do around metadata.
+# (e.g. extra rarity for reviewed observations...)
+import requests
+import sys
+import pandas as pd
+import numpy as np
+import os
+import json
+from dotenv import load_dotenv
+load_dotenv()
+
+# path needed for cronjob access
+script_path: str = os.path.dirname(os.path.realpath(__file__))
+
+################################
+# a class for this iNatty module instatiated per user
+class iNatty(object):
+
+    def __init__(self, user_name):
+        self.user_name = user_name
+        self.observedNew = []
+        self.observedTotal = {}
+
+    def get_obs_from_db(self) -> dict:
+        with open(os.path.join(script_path, 'observed.json'), 'r') as f:
+            observed = json.loads(f.read())
+            return observed
+    
+    def get_observations(self) -> None:
+        # Get past observations for all users
+        self.observedTotal = self.get_obs_from_db()
+
+        # Get the observations for the user
+        url = 'https://api.inaturalist.org/v1/observations'
+        params = {'user_id': self.user_name, 'per_page': 25, 'order_by': 'observed_on', 'order': 'desc'}
+        r = requests.get(url, params=params)
+
+        newOnes = False
+        for obs in r.json()['results']:
+            if str(obs['id']) not in self.observedTotal:
+                o = self.parse_observation(obs)
+                if o:
+                    self.observedNew.append(o)
+                    self.observedTotal[str(obs['id'])] = o
+                    newOnes = True
+        
+        if newOnes:
+            self.save_obs_to_db()
+            # if there's a new one, we call the Radix Transaction Manifest to mint the NFT
+
+        return None
+
+    def parse_observation(self, obs) -> dict:
+        # Parse the observations for the user
+        obs_parsed = None
+        try:
+            obs_parsed = {
+                "id": str(obs['id']),
+                "user_name": self.user_name,
+                "link": "https://www.inaturalist.org/observations/" + str(obs['id']),
+                "observed_on": obs["observed_on"],
+                "species": obs["species_guess"],
+                "imageUrlSmall": obs["photos"][0]["url"],
+                "imageUrlLarge": obs["photos"][0]["url"].replace("square", "original")
+            }
+        except Exception as e:
+            print('error parsing observation: ', e, json.dumps(obs, indent=4, sort_keys=True))
+            pass
+        return obs_parsed
+
+    def get_user_info(self) -> dict:
+        user_data = requests.get('https://api.inaturalist.org/v1/users/' + self.user_name + '?key=' + api_key).json()
+        return user_data
+
+    def save_obs_to_db(self) -> None:
+        # write over the file with the new data
+        with open(os.path.join(script_path, 'observed.json'), 'w') as f:
+            f.write(json.dumps(self.observedTotal, indent=4, sort_keys=True))
+        return None
+            
+################################
+"""
+Take a user name and return the observations for that user
+Get username as first param from command line
+"""
+def main():
+    user = sys.argv[1]
+    c = iNatty(user)
+    c.get_observations()
+    return c.observedNew
+
+################################
+if __name__ == '__main__':
+    main()

6-nfts-for-financial-applications/NattyDAO/relays/src/log.txt

@@ -0,0 +1 @@
+Running relay for chiggimps

6-nfts-for-financial-applications/NattyDAO/relays/src/mint_manifest.rtm

@@ -0,0 +1,23 @@
+# This RTM is called when a new nature experience is added to the database
+
+# Need to get the admin_badge first, so we can show a proof before calling these functions
+
+# Create a proof of a badge on your account. 
+# The "create_proof" method returns a Proof to the authzone.
+# There's an authorization zone that contains the proofs that you create.
+CALL_METHOD 
+    ComponentAddress("[your_account_address]") "create_proof" 
+    ResourceAddress("[badge_address]");
+
+CALL_FUNCTION 
+    PackageAddress("...") 
+    "INattyOracle" 
+    "create_nft" 
+    "DATA...";
+
+CALL_FUNCTION 
+    PackageAddress("...") 
+    "INattyOracle" 
+    "update_nft" 
+    "DATA...";
+

6-nfts-for-financial-applications/NattyDAO/relays/src/observed.json

@@ -0,0 +1,20 @@
+{
+    "141000772": {
+        "id": "141000772",
+        "imageUrlLarge": "https://inaturalist-open-data.s3.amazonaws.com/photos/241450468/original.jpg",
+        "imageUrlSmall": "https://inaturalist-open-data.s3.amazonaws.com/photos/241450468/square.jpg",
+        "link": "https://www.inaturalist.org/observations/141000772",
+        "observed_on": "2022-10-10",
+        "species": "Barred Owl",
+        "user_name": "chiggimps"
+    },
+    "141301002": {
+        "id": "141301002",
+        "imageUrlLarge": "https://inaturalist-open-data.s3.amazonaws.com/photos/242036633/original.jpg",
+        "imageUrlSmall": "https://inaturalist-open-data.s3.amazonaws.com/photos/242036633/square.jpg",
+        "link": "https://www.inaturalist.org/observations/141301002",
+        "observed_on": "2022-11-06",
+        "species": null,
+        "user_name": "chiggimps"
+    }
+}

6-nfts-for-financial-applications/NattyDAO/relays/src/relay.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+exec >log.txt 2>&1
+
+# Runs the relay for each registered member
+file="dao_members.txt"
+# read line by line
+while IFS= read -r line
+do
+  echo "Running relay for $line"
+  # put a sleep time here to avoid rate limiting
+  sleep 1
+  python inatty.py $line
+done < "$file"

6-nfts-for-financial-applications/NattyDAO/relays/src/requirements.txt

@@ -0,0 +1,7 @@
+certifi==2022.9.24
+charset-normalizer==2.1.1
+idna==3.4
+pymongo==4.2.0
+python-dotenv==0.21.0
+requests==2.28.1
+urllib3==1.26.12