Merge pull request #775 from decentraland/feat/tip-changes

feat: add creator_address to place attributes and update related functions

Author: AndresMorelos

README.md

@@ -56,7 +56,7 @@ See the **[OpenAPI Specification](docs/openapi.yaml)** which can be viewed with
 
 The database schema includes the following main tables:
 
-- `places` - Main table storing scene and world information
+- `places` - Main table storing scene and world information (includes creator_address for creator-based queries)
 - `users` - Registered users with permissions
 - `categories` - Place categories for organization
 - `place_categories` - Many-to-many relationship between places and categories

docs/ai-agent-context.md

@@ -61,6 +61,7 @@ The Decentraland Places service is a comprehensive API solution for discovering,
 - **Hot Scenes**: Places with active users, tracked via Catalyst realm provider with real-time user counts
 - **User Visits**: Unique users who visited a place in the last 30 days
 - **Highlighted Places**: Featured places with special promotion status
+- **Creator Address**: Ethereum address of the scene creator, extracted from scene metadata during deployment processing, indexed for efficient creator-based queries (used by tipping systems)
 
 ## API Specification
 
@@ -73,6 +74,7 @@ The service exposes a REST API under `/api` with comprehensive documentation in
 - **Interactions**: `/api/places/:id/likes`, `/api/places/:id/favorites` (authentication required)
 - **Reports**: `/api/report` (authentication required, returns S3 signed URL)
 - **Social**: `/places/place/`, `/places/world/` (metadata injection for social sharing)
+- **Creator Queries**: `/api/places?creator_address=0x...` (lookup places by scene creator for tipping integration)
 
 **Authentication**: Bearer token authentication using Decentraland wallet signatures. Admin endpoints require additional permissions.
 
@@ -91,7 +93,7 @@ The service exposes a REST API under `/api` with comprehensive documentation in
 
 **Key Tables**:
 
-- `places`: Main table with UUID, title, description, positions[], base_position, owner, content_rating, disabled, user_count, user_visits, like metrics
+- `places`: Main table with UUID, title, description, positions[], base_position, owner, creator_address, content_rating, disabled, user_count, user_visits, like metrics
 - `users`: Registered users with Ethereum addresses and permissions
 - `categories`: Place categories with name, active status, i18n translations
 - `place_categories`: Many-to-many relationships between places and categories

docs/database-schemas.md

@@ -12,6 +12,7 @@ erDiagram
         text description
         text image
         text owner
+        text creator_address
         varchar_15_array positions
         varchar_15 base_position
         text contact_name
@@ -119,6 +120,7 @@ Main table containing all places (scenes in Genesis City and Decentraland Worlds
 | image             | TEXT          | YES      | NULL    | Place thumbnail image URL from navmapThumbnail                         |
 | highlighted_image | TEXT          | YES      | NULL    | Special featured image for highlighted/promoted places                 |
 | owner             | TEXT          | YES      | NULL    | Ethereum address of the place owner (0x...)                            |
+| creator_address   | TEXT          | YES      | NULL    | Ethereum address of the scene creator (0x...), extracted from metadata |
 | positions         | VARCHAR(15)[] | NO       | {}      | Array of parcel coordinates (e.g., ['52,12', '52,13'])                 |
 | base_position     | VARCHAR(15)   | NO       | -       | Primary parcel coordinate (spawn point, key for UUID persistence)      |
 | contact_name      | TEXT          | YES      | NULL    | Contact person name                                                    |
@@ -152,6 +154,7 @@ Main table containing all places (scenes in Genesis City and Decentraland Worlds
 - `(base_position)` WHERE disabled is false and world is false - Fast position lookups for scenes
 - `(updated_at)` WHERE disabled is false and world is false - Recently updated places
 - `(like_rate)` WHERE disabled is false and world is false - Popular places ranking
+- `(creator_address)` - Fast lookups by scene creator for tipping and creator queries
 
 ### Constraints
 
@@ -167,6 +170,7 @@ Main table containing all places (scenes in Genesis City and Decentraland Worlds
 - **Full-Text Search**: `textsearch` column is automatically updated via triggers on title, description, and owner changes
 - **Categories Denormalization**: The `categories` array is denormalized from `place_categories` for query performance
 - **World vs Scene**: `world=true` places use `world_name` for identification, `world=false` places use `positions` and `base_position`
+- **Creator Address**: Extracted from scene metadata during deployment processing, used for creator-based queries (e.g., tipping system integration)
 
 ---
 

src/__data__/allPlacesWithAggregatedAttributes.ts

@@ -105,6 +105,7 @@ export const allPlacesWithAggregatedAttributes: AggregatePlaceAttributes[] = [
     world_name: null,
     deployed_at: new Date("2022-11-14T17:22:05.307Z"),
     textsearch: undefined,
+    creator_address: null,
   },
   {
     id: "a7ce87fa-df3c-4a2f-bca6-bd2fe794d51a",
@@ -136,5 +137,6 @@ export const allPlacesWithAggregatedAttributes: AggregatePlaceAttributes[] = [
     world_name: "test.dcl.eth",
     deployed_at: new Date("2022-11-14T17:22:05.307Z"),
     textsearch: undefined,
+    creator_address: null,
   },
 ]

src/__data__/placeGenesisPlaza.ts

@@ -101,4 +101,5 @@ export const placeGenesisPlaza: PlaceAttributes = {
   deployed_at: new Date("2022-11-14T17:22:05.307Z"),
   textsearch: undefined,
   categories: [],
+  creator_address: null,
 }

src/__data__/placeGenesisPlazaWithAggregatedAttributes.ts

@@ -415,4 +415,5 @@ export const placeGenesisPlazaWithAggregatedAttributes: AggregatePlaceAttributes
     world_name: null,
     deployed_at: new Date("2022-11-14T17:22:05.307Z"),
     textsearch: undefined,
+    creator_address: null,
   }

src/__data__/placeRoad.ts

@@ -29,4 +29,5 @@ export const placeRoad: PlaceAttributes = {
   deployed_at: new Date("2022-11-14T17:22:05.307Z"),
   textsearch: undefined,
   categories: [],
+  creator_address: null,
 }

src/__data__/world.ts

@@ -38,6 +38,7 @@ export const worldPlaceParalax: PlaceAttributes = {
   deployed_at: new Date("2023-03-28T13:05:45.437Z"),
   textsearch: undefined,
   categories: [],
+  creator_address: null,
 }
 
 export const worldPlaceParalaxWithAggregated: AggregatePlaceAttributes = {
@@ -71,6 +72,7 @@ export const worldPlaceParalaxWithAggregated: AggregatePlaceAttributes = {
   user_dislike: false,
   textsearch: undefined,
   categories: [],
+  creator_address: null,
 }
 
 export const worldContentEntitySceneParalax: ContentEntityScene = {
@@ -277,4 +279,5 @@ export const worldPlaceTemplegame: AggregatePlaceAttributes = {
   user_count: 3,
   textsearch: undefined,
   categories: [],
+  creator_address: null,
 }

src/entities/CheckScenes/task/extractCreatorAddress.ts

@@ -0,0 +1,48 @@
+import { ContentEntityScene } from "decentraland-gatsby/dist/utils/api/Catalyst.types"
+import fetch from "node-fetch"
+
+type SceneJson = {
+  creator?: string
+}
+
+/**
+ * Extracts the creator address from the scene.json file in the content entity
+ * @param contentEntityScene - The content entity scene from Catalyst
+ * @param contentServerUrl - The content server URL
+ * @returns The creator address or null if not found
+ */
+export async function extractCreatorAddress(
+  contentEntityScene: ContentEntityScene,
+  contentServerUrl: string
+): Promise<string | null> {
+  try {
+    // Find scene.json in the content files
+    const sceneJsonContent = contentEntityScene.content.find(
+      (content) => content.file === "scene.json"
+    )
+
+    if (!sceneJsonContent) {
+      return null
+    }
+
+    // Construct the URL to fetch the scene.json file
+    const contentUrl = `${contentServerUrl.replace(/\/+$/, "")}/contents/${
+      sceneJsonContent.hash
+    }`
+
+    // Fetch the scene.json file
+    const response = await fetch(contentUrl)
+
+    if (!response.ok) {
+      return null
+    }
+
+    const sceneJson: SceneJson = await response.json()
+
+    // Return the creator address if it exists
+    return sceneJson.creator || null
+  } catch (error) {
+    // If there's any error fetching or parsing, return null
+    return null
+  }
+}

src/entities/CheckScenes/task/processContentEntityScene.ts

@@ -85,7 +85,7 @@ export function processContentEntityScene(
 export function createPlaceFromContentEntityScene(
   contentEntityScene: ContentEntityScene,
   data: Partial<Omit<PlaceAttributes, "id">> = {},
-  options: { url?: string } = {}
+  options: { url?: string; creator?: string | null } = {}
 ) {
   const now = new Date()
   const title = contentEntityScene?.metadata?.display?.title || null
@@ -160,6 +160,7 @@ export function createPlaceFromContentEntityScene(
       !!data.disabled && !data.disabled_at ? now : data.disabled_at || null,
     textsearch: undefined,
     categories: [],
+    creator_address: options.creator || null,
   }
 
   placeParsed.textsearch = PlaceModel.textsearch(placeParsed)