feat: [sc-26070] Disable adding ".eth" suffix to suggestions #327

Byczong · 2025-01-20T18:49:01Z

Story details: https://app.shortcut.com/ps-web3/story/26070

TODO:

Disable adding .eth for Collections API
Disable adding .eth for Suggestions/Generator API
Refactor models
Implement separate response formatting functions for Collections API
Remove namehash field from CollectionLabel

lightwalker-eth

@Byczong @djstrong Hey thanks for these updates! Reviewed and shared feedback 👍

lightwalker-eth · 2025-01-23T13:40:37Z

collection_models.py



 class CollectionName(BaseModel):
-    name: str = Field(title='name with `.eth`')
+    name: str = Field(title='name from a collection')
    namehash: str = Field(title='namehash of the name')


Hmm, I'm trying to remember why we had this namehash field here?

Please note how if we are removing .eth from all name values, the related namehash value returned would also need to change.

Potentially we might change this to labelhash but not sure about the goal of this field? I think we can just remove it.

I don't know why we are returning namehashes.

If we want to remove the namehash field, should we keep this model with a single field, or should we rather keep the names as a list of str inside Collection.top_names?

Also, if the second option is chosen, should we change Collection.top_names to Collection.top_labels?

Maybe the first option. It will not need any changes in the client and in the future will be easy to include additional information about names/labels.

We can rename name to label in all places but we need to do it in namekit too.

models.py

collection_models.py

lightwalker-eth · 2025-01-23T13:49:21Z

collection_models.py

+
+class CollectionWithSuggestions(BaseModel):
+    suggestions: list[SuggestionFromCollection] = Field(title='suggestions from a collection')
+    name: str = Field(title='collection title', description='kept for backwards compatibility')  # todo:  remove field if not used


Please coordinate with @FrancoAguzzi If we need to update any code for this in the old NameHash app Instant Search feature (now at https://alpha.namekit.io). We're going to need to make some changes there no matter what based on the changes in this PR. It should be ok for us to implement those updates.

lightwalker-eth · 2025-01-23T13:49:57Z

collection_models.py

+    suggestions: list[SuggestionFromCollection] = Field(title='suggestions from a collection')
+    name: str = Field(title='collection title', description='kept for backwards compatibility')  # todo:  remove field if not used
+    type: Literal['related'] = Field('related', title='category type (always set to \'related\')', 
+                                     description='kept for backwards compatibility')  # todo: remove field if not used


Please see related comment above for us to remove this field.

collection_models.py

lightwalker-eth · 2025-01-23T13:52:34Z

web_api.py

 )


 def convert_to_suggestion_format(
        names: List[GeneratedName],
-        include_metadata: bool = True
+        include_metadata: bool = True,
+        append_eth: bool = True


Not sure if I understand this append_eth param? In my understanding it shouldn't exist inside NameGraph.

Instead the appending of root names would be left to a NameGraph client to implement.

If I'm missing something please let me know 👍

We have removed .eth. only in collection related endpoints and this code is also used for generator endpoints where we are appending eth.

@djstrong Ok perfect! That sounds great 🚀

Byczong · 2025-01-24T18:29:52Z

models.py

+                               description='label\'s status cached at the time of application startup')
+    categories: list[str] = Field(title='domain category',
+                                  description='can be either available, taken, recently released or on sale')
+    cached_interesting_score: Optional[float] = Field(title='cached interesting score',


Should we rename this field to cached_sort_score?

Byczong · 2025-01-24T18:31:48Z

collection_models.py

@@ -65,8 +65,8 @@ class BaseCollectionSearch(BaseCollectionSearchLimitOffsetSort):
                                        description='* set to null if you want to disable the penalization\n'
                                                    '* if the penalization algorithm is turned on then 3 times more results (than max_related_collections) are retrieved from Elasticsearch')
    name_diversity_ratio: Optional[float] = Field(None, examples=[0.5], ge=0.0, le=1.0,


Should we rename this field to label_diversity_ratio?

lightwalker-eth

@Byczong @djstrong Looks good! I found a few more places where it looks like we might rename from "name" to "label" or "member", but I think it's fine to action those in a separate future PR. Thanks for your efforts here. Approved 🚀

lightwalker-eth · 2025-01-26T13:09:08Z

tests/load_tests/locust_suggestions_by_category_2.py

+    }
+}
+
+input_names = ['cat', 'zeus']


Suggested change

input_names = ['cat', 'zeus']

input_labels = ['cat', 'zeus']

lightwalker-eth · 2025-01-26T13:09:25Z

tests/load_tests/locust_suggestions_by_category_2.py

+
+input_names = ['cat', 'zeus']
+
+CAT = set(


Should each of these be labels without ".eth"?

lightwalker-eth · 2025-01-26T13:30:55Z

tests/load_tests/locust_suggestions_by_category_2.py

+    "categories": {
+        "related": {
+            "enable_learning_to_rank": True,
+            "max_names_per_related_collection": 10,


Suggested change

"max_names_per_related_collection": 10,

"max_labels_per_related_collection": 10,

lightwalker-eth · 2025-01-26T13:31:39Z

tests/load_tests/locust_suggestions_by_category_2.py

+        r = self.client.post(self.URL, name='suggestions_by_category', json=json)
+        # print(r.json())
+        response = r.json()
+        names = []


Suggested change

names = []

labels = []

djstrong · 2025-01-26T17:20:58Z

Ok, I will return to this tomorrow.

Byczong marked this pull request as ready for review January 21, 2025 16:25

djstrong approved these changes Jan 23, 2025

View reviewed changes

lightwalker-eth requested changes Jan 23, 2025

View reviewed changes

Byczong changed the title ~~feat: [sc-26070] Disable adding ".eth" suffix for Collections API~~ feat: [sc-26070] Disable adding ".eth" suffix to suggestions Jan 23, 2025

Byczong commented Jan 24, 2025

View reviewed changes

Byczong added 9 commits January 24, 2025 21:36

remove adding .eth suffix for collection API

2904294

refactor models; add separate suggestion type for collection endpoints

d568bf5

disable appending .eth for all endpoints

571df93

refactor order; make separate request formatter

b431edd

delete duplicated fields

c77cd08

fix .eth-related tests

7d43749

fix deprecation warning

c43bac7

fix test

f884c98

rename fields and classes in (collection_)models.py; adjust tests

dc258b3

djstrong force-pushed the byczong/sc-26070/support-other-root-names branch from 08bc309 to dc258b3 Compare January 24, 2025 20:37

rename

30a480e

lightwalker-eth approved these changes Jan 26, 2025

View reviewed changes

djstrong merged commit a9bd549 into master Jan 26, 2025
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [sc-26070] Disable adding ".eth" suffix to suggestions #327

feat: [sc-26070] Disable adding ".eth" suffix to suggestions #327

Byczong commented Jan 20, 2025 •

edited

Loading

lightwalker-eth left a comment

lightwalker-eth Jan 23, 2025

djstrong Jan 23, 2025

Byczong Jan 24, 2025 •

edited

Loading

djstrong Jan 24, 2025

lightwalker-eth Jan 23, 2025

lightwalker-eth Jan 23, 2025

lightwalker-eth Jan 23, 2025

djstrong Jan 23, 2025

lightwalker-eth Jan 23, 2025

Byczong Jan 24, 2025 •

edited

Loading

djstrong Jan 24, 2025

Byczong Jan 24, 2025 •

edited

Loading

djstrong Jan 24, 2025

lightwalker-eth left a comment

lightwalker-eth Jan 26, 2025

lightwalker-eth Jan 26, 2025

lightwalker-eth Jan 26, 2025

lightwalker-eth Jan 26, 2025

djstrong commented Jan 26, 2025

	"max_names_per_related_collection": 10,
	"max_labels_per_related_collection": 10,

feat: [sc-26070] Disable adding ".eth" suffix to suggestions #327

feat: [sc-26070] Disable adding ".eth" suffix to suggestions #327

Conversation

Byczong commented Jan 20, 2025 • edited Loading

lightwalker-eth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Byczong Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Byczong Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Byczong Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lightwalker-eth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

djstrong commented Jan 26, 2025

Byczong commented Jan 20, 2025 •

edited

Loading

Byczong Jan 24, 2025 •

edited

Loading

Byczong Jan 24, 2025 •

edited

Loading

Byczong Jan 24, 2025 •

edited

Loading