diff --git a/nostr_dvm/tasks/content_discovery_currently_latest_wiki.py b/nostr_dvm/tasks/content_discovery_currently_latest_wiki.py new file mode 100644 index 0000000..4b94b7b --- /dev/null +++ b/nostr_dvm/tasks/content_discovery_currently_latest_wiki.py @@ -0,0 +1,323 @@ +import json +import os +from datetime import timedelta +from nostr_sdk import Client, Timestamp, PublicKey, Tag, Keys, Options, SecretKey, NostrSigner, NostrDatabase, \ + ClientBuilder, Filter, NegentropyOptions, NegentropyDirection, init_logger, LogLevel, Event, EventId, Kind, \ + RelayOptions, RelayLimits + +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 DicoverContentLatestWiki(DVMTaskInterface): + KIND: Kind = EventDefinitions.KIND_NIP90_CONTENT_DISCOVERY + TASK: str = "discover-content" + FIX_COST: float = 0 + dvm_config: DVMConfig + 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")) + + use_logger = False + if use_logger: + init_logger(LogLevel.DEBUG) + + 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(): + 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 scheduled update. In this case on database update. + else: + return self.result + + async def calculate_result(self, request_form): + from types import SimpleNamespace + ns = SimpleNamespace() + + options = self.set_options(request_form) + + opts = (Options().wait_for_send(False).send_timeout(timedelta(seconds=self.dvm_config.RELAY_TIMEOUT))) + sk = SecretKey.from_hex(self.dvm_config.PRIVATE_KEY) + keys = Keys.parse(sk.to_hex()) + signer = NostrSigner.keys(keys) + + database = await NostrDatabase.sqlite(self.db_name) + #print(self.db_name) + cli = ClientBuilder().database(database).signer(signer).opts(opts).build() + await cli.connect() + + # Negentropy reconciliation + # Query events from database + timestamp_hour_ago = Timestamp.now().as_secs() - self.db_since + since = Timestamp.from_secs(timestamp_hour_ago) + + filter1 = Filter().kind(definitions.EventDefinitions.KIND_WIKI).since(since) + events = await cli.database().query([filter1]) + if self.dvm_config.LOGLEVEL.value >= LogLevel.DEBUG.value: + print("[" + self.dvm_config.NIP89.NAME + "] Considering " + str(len(events)) + " Events") + ns.finallist = {} + index = options["max_results"] + for event in events: + if event.created_at().as_secs() > timestamp_hour_ago: + ns.finallist[event.id().to_hex()] = index + index = index-1 + if len(ns.finallist) == 0: + await cli.shutdown() + 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()) + await cli.shutdown() + if self.dvm_config.LOGLEVEL.value >= LogLevel.DEBUG.value: + print("[" + self.dvm_config.NIP89.NAME + "] Filtered " + str( + len(result_list)) + " fitting events.") + 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(): + 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 + + async def sync_db(self): + relaylimits = RelayLimits.disable() + opts = (Options().wait_for_send(False).send_timeout( + timedelta(seconds=self.dvm_config.RELAY_LONG_TIMEOUT))).relay_limits(relaylimits) + sk = SecretKey.from_hex(self.dvm_config.PRIVATE_KEY) + keys = Keys.parse(sk.to_hex()) + signer = NostrSigner.keys(keys) + database = await NostrDatabase.sqlite(self.db_name) + cli = ClientBuilder().signer(signer).database(database).opts(opts).build() + + for relay in self.dvm_config.RECONCILE_DB_RELAY_LIST: + await cli.add_relay(relay) + + await cli.connect() + + timestamp_since = Timestamp.now().as_secs() - self.db_since + since = Timestamp.from_secs(timestamp_since) + + filter1 = Filter().kinds([definitions.EventDefinitions.KIND_WIKI]).since(since) # 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 = NegentropyOptions().direction(NegentropyDirection.DOWN) + await cli.reconcile(filter1, dbopts) + await cli.database().delete(Filter().until(Timestamp.from_secs( + Timestamp.now().as_secs() - self.db_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..") + + +# 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/d30a75c438a8b0815b5c65b494988da26fce719f4138058929fa52d2a2dc3433.jpg", + + # Add NIP89 + nip89info = { + "name": name, + "image": image, + "picture": image, + "about": "I show the latest longform notes.", + "lud16": dvm_config.LN_ADDRESS, + "encryptionSupported": True, + "cashuAccepted": True, + "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["image"]) + nip89config.CONTENT = json.dumps(nip89info) + + # admin_config.UPDATE_PROFILE = False + + # admin_config.REBROADCAST_NIP89 = False + + return DicoverContentLatestWiki(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/d30a75c438a8b0815b5c65b494988da26fce719f4138058929fa52d2a2dc3433.jpg", + # Add NIP89 + nip89info = { + "name": name, + "image": image, + "picture": image, + "about": "I show the latest longform notes", + "lud16": dvm_config.LN_ADDRESS, + "encryptionSupported": True, + "cashuAccepted": True, + "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["image"]) + nip89config.CONTENT = json.dumps(nip89info) + + nip88config = NIP88Config() + nip88config.DTAG = check_and_set_d_tag_nip88(identifier, name, dvm_config.PRIVATE_KEY, nip89info["image"]) + nip88config.TIER_EVENT = check_and_set_tiereventid_nip88(identifier, "1") + nip89config.NAME = name + nip88config.IMAGE = nip89info["image"] + 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 DicoverContentLatestWiki(name=name, dvm_config=dvm_config, nip89config=nip89config, + nip88config=nip88config, options=options, + admin_config=admin_config) + + +if __name__ == '__main__': + process_venv(DicoverContentLatestWiki) diff --git a/nostr_dvm/utils/definitions.py b/nostr_dvm/utils/definitions.py index 5100d15..6152f61 100644 --- a/nostr_dvm/utils/definitions.py +++ b/nostr_dvm/utils/definitions.py @@ -53,8 +53,11 @@ class EventDefinitions: KIND_ZAP = Kind(9735) KIND_RELAY_ANNOUNCEMENT = Kind(10002) KIND_ANNOUNCEMENT = Kind(31990) + KIND_WIKI = Kind(30818) KIND_LONGFORM = Kind(30023) KIND_NIP88_TIER_EVENT = Kind(37001) + KIND_NUT_WALLET = Kind(37375) + ANY_RESULT = [KIND_NIP90_RESULT_EXTRACT_TEXT, KIND_NIP90_RESULT_SUMMARIZE_TEXT, diff --git a/setup.py b/setup.py index 62dc6e8..0e2ea09 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,6 @@ from setuptools import setup, find_packages -VERSION = '0.7.8' +VERSION = '0.7.9' DESCRIPTION = 'A framework to build and run Nostr NIP90 Data Vending Machines' LONG_DESCRIPTION = ('A framework to build and run Nostr NIP90 Data Vending Machines. See the github repository for more information') diff --git a/tests/discovery.py b/tests/discovery.py index d8232a3..d6352be 100644 --- a/tests/discovery.py +++ b/tests/discovery.py @@ -7,6 +7,7 @@ import dotenv from nostr_sdk import init_logger, LogLevel, Keys, NostrLibrary from nostr_dvm.tasks.content_discovery_currently_latest_longform import DicoverContentLatestLongForm +from nostr_dvm.tasks.content_discovery_currently_latest_wiki import DicoverContentLatestWiki from nostr_dvm.tasks.content_discovery_currently_popular_mostr import DicoverContentCurrentlyPopularMostr from nostr_dvm.tasks.content_discovery_currently_popular_nonfollowers import DicoverContentCurrentlyPopularNonFollowers from nostr_dvm.tasks.content_discovery_update_db_only import DicoverContentDBUpdateScheduler @@ -171,6 +172,57 @@ def build_longform(name, identifier, admin_config, options, cost=0, update_rate= admin_config=admin_config, options=options) +def build_wiki(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 + dvm_config.AVOID_PAID_OUTBOX_RELAY_LIST = AVOID_OUTBOX_RELAY_LIST + dvm_config.RECONCILE_DB_RELAY_LIST = RECONCILE_DB_RELAY_LIST + dvm_config.LOGLEVEL = LogLevel.INFO + # 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://i.nostr.build/ctfc5o47ICm56TOv.jpg" + + # Add NIP89 + nip89info = { + "name": name, + "image": image, + "picture": image, + "about": "I show the latest wikifreedia entries.", + "lud16": dvm_config.LN_ADDRESS, + "encryptionSupported": True, + "cashuAccepted": True, + "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["image"]) + nip89config.CONTENT = json.dumps(nip89info) + + # admin_config.UPDATE_PROFILE = False + + # admin_config.REBROADCAST_NIP89 = False + + return DicoverContentLatestWiki(name=name, dvm_config=dvm_config, nip89config=nip89config, + admin_config=admin_config, options=options) + + def build_example_topic(name, identifier, admin_config, options, image, description, update_rate=600, cost=0, processing_msg=None, update_db=True): dvm_config = build_default_config(identifier) @@ -520,6 +572,35 @@ def playground(): + # Latest Wiki + admin_config_wiki = AdminConfig() + admin_config_wiki.REBROADCAST_NIP89 = rebroadcast_NIP89 + admin_config_wiki.REBROADCAST_NIP65_RELAY_LIST = rebroadcast_NIP65_Relay_List + admin_config_wiki.UPDATE_PROFILE = update_profile + # admin_config_top_zaps.DELETE_NIP89 = True + # admin_config_top_zaps.PRIVKEY = "" + # admin_config_top_zaps.EVENTID = "05a6de88e15aa6c8b4c8ec54481f885f397a30761ff2799958e5c5ee9ad6917b" + # admin_config_top_zaps.POW = True + custom_processing_msg = ["Looking for latest Wiki entries", "Let's check Wiki entries.."] + update_db = True + + options_longform = { + "db_name": "db/nostr_recent_notes_longform.db", + "db_since": 60 * 60 * 24 * 21, # 3 Weeks since gmt, + } + cost = 0 + latest_wiki= build_wiki("Latest Wikifreedia Notes", + "discovery_content_wiki", + admin_config=admin_config_wiki, + options=options_longform, + cost=cost, + update_rate=global_update_rate, + processing_msg=custom_processing_msg, + update_db=update_db) + + latest_wiki.run() + + # Popular top zapped admin_config_top_zaps = AdminConfig()