diff --git a/nostr_dvm/tasks/content_discovery_on_this_day.py b/nostr_dvm/tasks/content_discovery_on_this_day.py new file mode 100644 index 0000000..5588d1d --- /dev/null +++ b/nostr_dvm/tasks/content_discovery_on_this_day.py @@ -0,0 +1,329 @@ +import json +import os + +from nostr_sdk import Timestamp, Tag, Keys, Options, SecretKey, NostrSigner, NostrDatabase, \ + ClientBuilder, Filter, SyncOptions, SyncDirection, LogLevel, Kind, EventId + +from nostr_dvm.interfaces.dvmtaskinterface import DVMTaskInterface, process_venv +from nostr_dvm.utils import definitions +from nostr_dvm.utils.admin_utils import AdminConfig +from nostr_dvm.utils.definitions import EventDefinitions +from nostr_dvm.utils.dvmconfig import DVMConfig, build_default_config +from nostr_dvm.utils.nip88_utils import NIP88Config, check_and_set_d_tag_nip88, check_and_set_tiereventid_nip88 +from nostr_dvm.utils.nip89_utils import NIP89Config, check_and_set_d_tag, create_amount_tag +from nostr_dvm.utils.output_utils import post_process_list_to_events + +""" +This File contains a Module to discover popular notes +Accepted Inputs: none +Outputs: A list of events +Params: None +""" + + +class DicoverContentOnThisDay(DVMTaskInterface): + KIND: Kind = EventDefinitions.KIND_NIP90_CONTENT_DISCOVERY + TASK: str = "discover-content" + FIX_COST: float = 0 + dvm_config: DVMConfig + request_form = None + last_schedule: int + db_since = 3600 + db_name = "db/nostr_recent_notes.db" + min_reactions = 2 + personalized = False + result = "" + + async def init_dvm(self, name, dvm_config: DVMConfig, nip89config: NIP89Config, nip88config: NIP88Config = None, + admin_config: AdminConfig = None, options=None): + + dvm_config.SCRIPT = os.path.abspath(__file__) + self.request_form = {"jobID": "generic"} + opts = { + "max_results": 200, + } + self.request_form['options'] = json.dumps(opts) + + self.last_schedule = Timestamp.now().as_secs() + + if self.options.get("db_name"): + self.db_name = self.options.get("db_name") + if self.options.get("db_since"): + self.db_since = int(self.options.get("db_since")) + + + if self.dvm_config.UPDATE_DATABASE: + await self.sync_db() + if not self.personalized: + self.result = await self.calculate_result(self.request_form) + + + async def is_input_supported(self, tags, client=None, dvm_config=None): + for tag in tags: + if tag.as_vec()[0] == 'i': + input_value = tag.as_vec()[1] + input_type = tag.as_vec()[2] + if input_type != "text": + return False + return True + + async def create_request_from_nostr_event(self, event, client=None, dvm_config=None): + self.dvm_config = dvm_config + + request_form = {"jobID": event.id().to_hex()} + + # default values + search = "" + max_results = 200 + + for tag in event.tags().to_vec(): + if tag.as_vec()[0] == 'i': + input_type = tag.as_vec()[2] + elif tag.as_vec()[0] == 'param': + param = tag.as_vec()[1] + if param == "max_results": # check for param type + max_results = int(tag.as_vec()[2]) + + options = { + "max_results": max_results, + } + request_form['options'] = json.dumps(options) + return request_form + + async def process(self, request_form): + # if the dvm supports individual results, recalculate it every time for the request + if self.personalized: + return await self.calculate_result(request_form) + # else return the result that gets updated once every schenduled update. In this case on database update. + else: + return self.result + + async def calculate_result(self, request_form): + from nostr_sdk import Filter + from types import SimpleNamespace + ns = SimpleNamespace() + + options = self.set_options(request_form) + database = NostrDatabase.lmdb(self.db_name) + + timestamp_since = Timestamp.now().as_secs() - self.db_since + timestamp_until = Timestamp.now().as_secs() - (self.db_since - (60+60*24)) + since = Timestamp.from_secs(timestamp_since) + until = Timestamp.from_secs(timestamp_until) + + filter1 = Filter().kind(definitions.EventDefinitions.KIND_NOTE).since(since).until(until) + + events = await database.query([filter1]) + print(len(events.to_vec())) + if self.dvm_config.LOGLEVEL.value >= LogLevel.DEBUG.value: + print("[" + self.dvm_config.NIP89.NAME + "] Considering " + str(len(events.to_vec())) + " Events") + ns.finallist = {} + for event in events.to_vec(): + if event.created_at().as_secs() > timestamp_since: + filt = Filter().kinds([definitions.EventDefinitions.KIND_ZAP, definitions.EventDefinitions.KIND_REPOST, + definitions.EventDefinitions.KIND_REACTION, + definitions.EventDefinitions.KIND_NOTE]).event(event.id()).since(since) + reactions = await database.query([filt]) + + if len(reactions.to_vec()) >= self.min_reactions: + ns.finallist[event.id().to_hex()] = len(reactions.to_vec()) + if len(ns.finallist) == 0: + return self.result + + result_list = [] + finallist_sorted = sorted(ns.finallist.items(), key=lambda x: x[1], reverse=True)[:int(options["max_results"])] + for entry in finallist_sorted: + # print(EventId.parse(entry[0]).to_bech32() + "/" + EventId.parse(entry[0]).to_hex() + ": " + str(entry[1])) + e_tag = Tag.parse(["e", entry[0]]) + result_list.append(e_tag.as_vec()) + #if self.dvm_config.LOGLEVEL.value >= LogLevel.DEBUG.value: + print("[" + self.dvm_config.NIP89.NAME + "] Filtered " + str( + len(result_list)) + " fitting events.") + # await cli.shutdown() + + #for entry in result_list: + # try: + # print(EventId.parse(entry[1]).to_bech32()) + # except: + # print(entry[1]) + + return json.dumps(result_list) + + async def post_process(self, result, event): + """Overwrite the interface function to return a social client readable format, if requested""" + for tag in event.tags().to_vec(): + if tag.as_vec()[0] == 'output': + format = tag.as_vec()[1] + if format == "text/plain": # check for output type + result = post_process_list_to_events(result) + + # if not text/plain, don't post-process + return result + + async def schedule(self, dvm_config): + if dvm_config.SCHEDULE_UPDATES_SECONDS == 0: + return 0 + else: + if Timestamp.now().as_secs() >= self.last_schedule + dvm_config.SCHEDULE_UPDATES_SECONDS: + if self.dvm_config.UPDATE_DATABASE: + await self.sync_db() + self.last_schedule = Timestamp.now().as_secs() + self.result = await self.calculate_result(self.request_form) + return 1 + else: + return 0 + + async def sync_db(self): + try: + sk = SecretKey.from_hex(self.dvm_config.PRIVATE_KEY) + keys = Keys.parse(sk.to_hex()) + + database = NostrDatabase.lmdb(self.db_name) + cli = ClientBuilder().signer(NostrSigner.keys(keys)).database(database).build() + + for relay in self.dvm_config.SYNC_DB_RELAY_LIST: + await cli.add_relay(relay) + + await cli.connect() + + timestamp_since = Timestamp.now().as_secs() - self.db_since + print(timestamp_since) + timestamp_until = Timestamp.now().as_secs() - (self.db_since - (60 + 60 * 24)) + print(timestamp_until) + since = Timestamp.from_secs(timestamp_since) + until = Timestamp.from_secs(timestamp_until) + + filter1 = Filter().kinds( + [definitions.EventDefinitions.KIND_NOTE, definitions.EventDefinitions.KIND_REACTION, + definitions.EventDefinitions.KIND_ZAP]).since(since).until(until) # Notes, reactions, zaps + + # filter = Filter().author(keys.public_key()) + if self.dvm_config.LOGLEVEL.value >= LogLevel.DEBUG.value: + print("[" + self.dvm_config.NIP89.NAME + "] Syncing notes of the last " + str( + self.db_since) + " seconds.. this might take a while..") + dbopts = SyncOptions().direction(SyncDirection.DOWN) + await cli.sync(filter1, dbopts) + await cli.database().delete(Filter().until(since)) # Clear old events so db doesn't get too full. + await cli.shutdown() + if self.dvm_config.LOGLEVEL.value >= LogLevel.DEBUG.value: + print( + "[" + self.dvm_config.NIP89.NAME + "] Done Syncing Notes of the last " + str( + self.db_since) + " seconds..") + except Exception as e: + print(e) + + +# We build an example here that we can call by either calling this file directly from the main directory, +# or by adding it to our playground. You can call the example and adjust it to your needs or redefine it in the +# playground or elsewhere +def build_example(name, identifier, admin_config, options, cost=0, update_rate=180, processing_msg=None, + update_db=True): + dvm_config = build_default_config(identifier) + dvm_config.USE_OWN_VENV = False + dvm_config.SHOWLOG = True + dvm_config.SCHEDULE_UPDATES_SECONDS = update_rate # Every 10 minutes + dvm_config.UPDATE_DATABASE = update_db + # Activate these to use a subscription based model instead + # dvm_config.SUBSCRIPTION_REQUIRED = True + # dvm_config.SUBSCRIPTION_DAILY_COST = 1 + dvm_config.FIX_COST = cost + dvm_config.CUSTOM_PROCESSING_MESSAGE = processing_msg + admin_config.LUD16 = dvm_config.LN_ADDRESS + + image = "https://image.nostr.build/b29b6ec4bf9b6184f69d33cb44862db0d90a2dd9a506532e7ba5698af7d36210.jpg", + + # Add NIP89 + nip89info = { + "name": name, + "picture": image, + "about": "I show notes that were popular one year ago", + "lud16": dvm_config.LN_ADDRESS, + "supportsEncryption": True, + "acceptsNutZaps": False, + "personalized": False, + "amount": create_amount_tag(cost), + "nip90Params": { + "max_results": { + "required": False, + "values": [], + "description": "The number of maximum results to return (default currently 100)" + } + } + } + + nip89config = NIP89Config() + nip89config.DTAG = check_and_set_d_tag(identifier, name, dvm_config.PRIVATE_KEY, nip89info["picture"]) + nip89config.CONTENT = json.dumps(nip89info) + + # admin_config.UPDATE_PROFILE = False + # admin_config.REBROADCAST_NIP89 = False + + return DicoverContentOnThisDay(name=name, dvm_config=dvm_config, nip89config=nip89config, + admin_config=admin_config, options=options) + + +def build_example_subscription(name, identifier, admin_config, options, update_rate=180, processing_msg=None, + update_db=True): + dvm_config = build_default_config(identifier) + dvm_config.USE_OWN_VENV = False + dvm_config.SHOWLOG = True + dvm_config.SCHEDULE_UPDATES_SECONDS = update_rate # Every 3 minutes + dvm_config.UPDATE_DATABASE = update_db + # Activate these to use a subscription based model instead + # dvm_config.SUBSCRIPTION_DAILY_COST = 1 + dvm_config.FIX_COST = 0 + dvm_config.CUSTOM_PROCESSING_MESSAGE = processing_msg + admin_config.LUD16 = dvm_config.LN_ADDRESS + + image = "https://image.nostr.build/b29b6ec4bf9b6184f69d33cb44862db0d90a2dd9a506532e7ba5698af7d36210.jpg", + # Add NIP89 + nip89info = { + "name": name, + "picture": image, + "about": "I show notes that were currently popular all over Nostr. I'm also used for testing subscriptions.", + "lud16": dvm_config.LN_ADDRESS, + "supportsEncryption": True, + "acceptsNutZaps": False, + "subscription": True, + "personalized": False, + "nip90Params": { + "max_results": { + "required": False, + "values": [], + "description": "The number of maximum results to return (default currently 100)" + } + } + } + + nip89config = NIP89Config() + nip89config.DTAG = check_and_set_d_tag(identifier, name, dvm_config.PRIVATE_KEY, nip89info["picture"]) + nip89config.CONTENT = json.dumps(nip89info) + + nip88config = NIP88Config() + nip88config.DTAG = check_and_set_d_tag_nip88(identifier, name, dvm_config.PRIVATE_KEY, nip89info["picture"]) + nip88config.TIER_EVENT = check_and_set_tiereventid_nip88(identifier, "1") + nip89config.NAME = name + nip88config.IMAGE = nip89info["picture"] + nip88config.TITLE = name + nip88config.AMOUNT_DAILY = 100 + nip88config.AMOUNT_MONTHLY = 2000 + nip88config.CONTENT = "Subscribe to the DVM for unlimited use during your subscription" + nip88config.PERK1DESC = "Unlimited requests" + nip88config.PERK2DESC = "Support NostrDVM & NostrSDK development" + nip88config.PAYMENT_VERIFIER_PUBKEY = "5b5c045ecdf66fb540bdf2049fe0ef7f1a566fa427a4fe50d400a011b65a3a7e" + + # admin_config.UPDATE_PROFILE = False + # admin_config.REBROADCAST_NIP89 = False + # admin_config.REBROADCAST_NIP88 = False + + # admin_config.FETCH_NIP88 = True + # admin_config.EVENTID = "" + # admin_config.PRIVKEY = dvm_config.PRIVATE_KEY + + return DicoverContentOnThisDay(name=name, dvm_config=dvm_config, nip89config=nip89config, + nip88config=nip88config, options=options, + admin_config=admin_config) + + +if __name__ == '__main__': + process_venv(DicoverContentOnThisDay) diff --git a/tests/discovery_on_this_day.py b/tests/discovery_on_this_day.py new file mode 100644 index 0000000..724fb21 --- /dev/null +++ b/tests/discovery_on_this_day.py @@ -0,0 +1,141 @@ +import asyncio +import datetime +import json +from pathlib import Path + +import dotenv +from nostr_sdk import init_logger, LogLevel + +# os.environ["RUST_BACKTRACE"] = "full" +from nostr_dvm.tasks.content_discovery_on_this_day import DicoverContentOnThisDay +from nostr_dvm.utils.admin_utils import AdminConfig +from nostr_dvm.utils.database_utils import init_db +from nostr_dvm.utils.dvmconfig import build_default_config +from nostr_dvm.utils.nip89_utils import create_amount_tag, NIP89Config, check_and_set_d_tag +from nostr_dvm.utils.outbox_utils import AVOID_OUTBOX_RELAY_LIST + +rebroadcast_NIP89 = True # Announce NIP89 on startup Only do this if you know what you're doing. +rebroadcast_NIP65_Relay_List = True +update_profile = True + +global_update_rate = 60*60 # set this high on first sync so db can fully sync before another process trys to. +use_logger = True +log_level = LogLevel.ERROR +max_sync_duration_in_h = 24 + +if use_logger: + init_logger(log_level) + + +RELAY_LIST = ["wss://nostr.mom", + "wss://relay.primal.net", + "wss://nostr.oxtr.dev", + ] + +SYNC_DB_RELAY_LIST = ["wss://relay.damus.io", + "wss://relay.primal.net", + "wss://nostr.oxtr.dev" + ] + + + +def build_example_on_this_day(name, identifier, admin_config, options, image, description, update_rate=600, cost=0, + processing_msg=None, update_db=True, database=None): + dvm_config = build_default_config(identifier) + dvm_config.USE_OWN_VENV = False + dvm_config.SHOWLOG = True + dvm_config.SCHEDULE_UPDATES_SECONDS = update_rate # Every 10 minutes + dvm_config.UPDATE_DATABASE = update_db + dvm_config.FIX_COST = cost + dvm_config.LOGLEVEL = LogLevel.INFO + dvm_config.CUSTOM_PROCESSING_MESSAGE = processing_msg + dvm_config.AVOID_OUTBOX_RELAY_LIST = AVOID_OUTBOX_RELAY_LIST + dvm_config.SYNC_DB_RELAY_LIST = SYNC_DB_RELAY_LIST + dvm_config.RELAY_LIST = RELAY_LIST + dvm_config.DATABASE = database + dvm_config.SEND_FEEDBACK_EVENTS = False + admin_config.LUD16 = dvm_config.LN_ADDRESS + + # Add NIP89 + nip89info = { + "name": name, + "picture": image, + "about": description, + "lud16": dvm_config.LN_ADDRESS, + "supportsEncryption": True, + "acceptsNutZaps": dvm_config.ENABLE_NUTZAP, + "personalized": False, + "amount": create_amount_tag(cost), + "nip90Params": { + "max_results": { + "required": False, + "values": [], + "description": "The number of maximum results to return (default currently 100)" + } + } + } + + nip89config = NIP89Config() + nip89config.DTAG = check_and_set_d_tag(identifier, name, dvm_config.PRIVATE_KEY, nip89info["picture"]) + nip89config.CONTENT = json.dumps(nip89info) + + return DicoverContentOnThisDay(name=name, dvm_config=dvm_config, nip89config=nip89config, + admin_config=admin_config, options=options) + + +def playground(): + main_db = "db/nostr_on_this_day.db" + main_db_limit = 1024 # in mb + + database = asyncio.run(init_db(main_db, wipe=True, limit=main_db_limit, print_filesize=True)) + last_year = datetime.date.today().year - 1 + + if last_year % 4 == 0 and (last_year % 100 != 0 or last_year % 400 == 0): + days = 366 + else: + days = 365 + + # Popular Tweets + admin_config = AdminConfig() + admin_config.REBROADCAST_NIP89 = rebroadcast_NIP89 + admin_config.REBROADCAST_NIP65_RELAY_LIST = rebroadcast_NIP65_Relay_List + admin_config.UPDATE_PROFILE = update_profile + + options = { + "db_name": main_db, + "db_since": 24 * 60 * 60 * (days+1), + "personalized": False, + "logger": False} + + image = "https://i.nostr.build/TxRou5DdFhxVqtHa.png" + description = "I show popular notes on this day one year ago" + + custom_processing_msg = ["Let's see"] + cost = 0 + update_db = True # we use the DB scheduler above for a shared database. Or don't use it and let the DVM manage it + discovery_onthisday= build_example_on_this_day("On This Day", + "discovery_content_on_this_day", + admin_config, options, + image=image, + description=description, + update_rate=global_update_rate, + cost=cost, + processing_msg=custom_processing_msg, + update_db=update_db, + database=database) + + discovery_onthisday.run() + + +if __name__ == '__main__': + env_path = Path('.env') + if not env_path.is_file(): + with open('.env', 'w') as f: + print("Writing new .env file") + f.write('') + if env_path.is_file(): + print(f'loading environment from {env_path.resolve()}') + dotenv.load_dotenv(env_path, verbose=True, override=True) + else: + raise FileNotFoundError(f'.env file not found at {env_path} ') + playground() diff --git a/tests/test_dvm_client.py b/tests/test_dvm_client.py index fb077ca..674b2fa 100644 --- a/tests/test_dvm_client.py +++ b/tests/test_dvm_client.py @@ -428,8 +428,8 @@ async def nostr_client(): # await nostr_client_test_search_profile("dontbelieve") #wot = ["99bb5591c9116600f845107d31f9b59e2f7c7e09a1ff802e84f1d43da557ca64"] - #await nostr_client_test_discovery("99bb5591c9116600f845107d31f9b59e2f7c7e09a1ff802e84f1d43da557ca64", "ab6cdf12ca3ae5109416295b8cd8a53fdec3a9d54beb7a9aee0ebfb67cb4edf7") - await nostr_client_test_discovery_gallery("99bb5591c9116600f845107d31f9b59e2f7c7e09a1ff802e84f1d43da557ca64", "4add3944eb596a27a650f9b954f5ed8dfefeec6ca50473605b0fbb058dd11306") + await nostr_client_test_discovery("99bb5591c9116600f845107d31f9b59e2f7c7e09a1ff802e84f1d43da557ca64", "9e09a914f41db178ba442b7372944b021135c08439516464a9bd436588af0b58") + #await nostr_client_test_discovery_gallery("99bb5591c9116600f845107d31f9b59e2f7c7e09a1ff802e84f1d43da557ca64", "4add3944eb596a27a650f9b954f5ed8dfefeec6ca50473605b0fbb058dd11306") #await nostr_client_test_discovery("99bb5591c9116600f845107d31f9b59e2f7c7e09a1ff802e84f1d43da557ca64", # "7a63849b684d90c0de983492578b12e147e56f5d79ed6585cc64e5aa8a122744")