Merge pull request #1054 from oasisprotocol/ptrus/feature/roflmarket-instances-admin

api/roflmarket_instances: Support filtering by admin

Author: ptrus

.changelog/1048.feature.md

@@ -1 +1 @@
-api/roflmarket_apps: Support filtering by admin
+api/rofl_apps: Support filtering by admin

.changelog/1054.feature.md

@@ -0,0 +1,7 @@
+api/roflmarket_instances: Support filtering by admin address
+
+- The old endpoint `/{runtime}/roflmarket_providers/{address}/instances` has
+been removed.
+
+- Clients should now use: `/{runtime}/roflmarket_instances?provider={address}`
+to filter instances by provider address.

api/spec/v1.yaml

@@ -1496,19 +1496,23 @@ paths:
                 $ref: '#/components/schemas/RoflMarketOfferList'
         <<: *common_error_responses
 
-  /{runtime}/roflmarket_providers/{address}/instances:
+  /{runtime}/roflmarket_instances:
     get:
-      summary: Returns a list of ROFL market instances for a specific provider.
+      summary: Returns a list of ROFL market instances.
       parameters:
         - *limit
         - *offset
         - *runtime
-        - in: path
-          name: address
-          required: true
+        - in: query
+          name: provider
           schema:
             allOf: [$ref: '#/components/schemas/StakingAddress']
-          description: The address of the ROFL market provider to return instances for.
+          description: A filter on the provider of the ROFL market instance.
+        - in: query
+          name: admin
+          schema:
+            allOf: [$ref: '#/components/schemas/EthOrOasisAddress']
+          description: A filter on the admin of the ROFL market instance.
       responses:
         '200':
           description: A JSON object containing a list of ROFL market instances.

api/v1/strict_server.go

@@ -617,14 +617,14 @@ func (srv *StrictServerImpl) GetRuntimeRoflmarketProvidersAddressOffers(ctx cont
 	return apiTypes.GetRuntimeRoflmarketProvidersAddressOffers200JSONResponse(*offers), nil
 }
 
-func (srv *StrictServerImpl) GetRuntimeRoflmarketProvidersAddressInstances(ctx context.Context, request apiTypes.GetRuntimeRoflmarketProvidersAddressInstancesRequestObject) (apiTypes.GetRuntimeRoflmarketProvidersAddressInstancesResponseObject, error) {
+func (srv *StrictServerImpl) GetRuntimeRoflmarketInstances(ctx context.Context, request apiTypes.GetRuntimeRoflmarketInstancesRequestObject) (apiTypes.GetRuntimeRoflmarketInstancesResponseObject, error) {
 	runtime, err := request.Runtime.Validate()
 	if err != nil {
 		return nil, err
 	}
-	instances, err := srv.dbClient.RuntimeRoflmarketInstances(ctx, runtime, request.Params, &request.Address)
+	instances, err := srv.dbClient.RuntimeRoflmarketInstances(ctx, runtime, request.Params)
 	if err != nil {
 		return nil, err
 	}
-	return apiTypes.GetRuntimeRoflmarketProvidersAddressInstances200JSONResponse(*instances), nil
+	return apiTypes.GetRuntimeRoflmarketInstances200JSONResponse(*instances), nil
 }

storage/client/client.go

@@ -2835,12 +2835,18 @@ func (c *StorageClient) RuntimeRoflmarketOffers(ctx context.Context, runtime com
 	return &offers, nil
 }
 
-func (c *StorageClient) RuntimeRoflmarketInstances(ctx context.Context, runtime common.Runtime, params apiTypes.GetRuntimeRoflmarketProvidersAddressInstancesParams, address *staking.Address) (*RoflMarketInstanceList, error) {
+func (c *StorageClient) RuntimeRoflmarketInstances(ctx context.Context, runtime common.Runtime, params apiTypes.GetRuntimeRoflmarketInstancesParams) (*RoflMarketInstanceList, error) {
+	ocAddrAdmin, err := apiTypes.UnmarshalToOcAddress(params.Admin)
+	if err != nil {
+		return nil, wrapError(err)
+	}
+
 	res, err := c.withDefaultTotalCount(
 		ctx,
 		queries.RuntimeRoflmarketProviderInstances,
 		runtime,
-		address,
+		params.Provider,
+		ocAddrAdmin,
 		params.Limit,
 		params.Offset,
 	)

storage/client/queries/queries.go

@@ -1099,11 +1099,12 @@ const (
 			removed
 		FROM chain.roflmarket_instances
 		WHERE runtime = $1::runtime AND
-			provider = $2::oasis_addr
+			($2::oasis_addr IS NULL OR provider = $2::oasis_addr) AND
+			($3::oasis_addr IS NULL OR admin = $3::oasis_addr)
 		-- TODO: Should probably sort by something else.
 		ORDER BY id DESC
-		LIMIT $3::bigint
-		OFFSET $4::bigint`
+		LIMIT $4::bigint
+		OFFSET $5::bigint`
 
 	// FineTxVolumes returns the fine-grained query for 5-minute sampled tx volume windows.
 	FineTxVolumes = `

storage/migrations/25_runtime_roflmarket.up.sql

@@ -89,6 +89,7 @@ CREATE TABLE chain.roflmarket_instances (
   removed BOOLEAN NOT NULL DEFAULT FALSE
 );
 CREATE INDEX ix_roflmarket_instances_provider ON chain.roflmarket_instances (runtime, provider);
+-- CREATE INDEX ix_roflmarket_instances_admin ON chain.roflmarket_instances (runtime, admin); -- Added in 38_runtime_roflmarket_instances_admin.up.sql.
 
 -- Grant others read-only use.
 -- (We granted already in 00_consensus.up.sql, but the grant does not apply to new tables.)

storage/migrations/38_runtime_roflmarket_instances_admin.up.sql

@@ -0,0 +1,5 @@
+BEGIN;
+
+CREATE INDEX IF NOT EXISTS ix_roflmarket_instances_admin ON chain.roflmarket_instances (runtime, admin);
+
+COMMIT;

tests/e2e_regression/common_test_cases.sh

@@ -107,4 +107,5 @@ commonSapphireTestCases=(
   'sapphire_tx_volume                 /v1/sapphire/stats/tx_volume'
   'sapphire_rofl_apps                 /v1/sapphire/rofl_apps'
   'sapphire_roflmarket_providers      /v1/sapphire/roflmarket_providers'
+  'sapphire_roflmarket_instances      /v1/sapphire/roflmarket_instances'
 )

tests/e2e_regression/eden_2025/expected/sapphire_roflmarket_instances.body

@@ -0,0 +1,5 @@
+{
+  "instances": [],
+  "is_total_count_clipped": false,
+  "total_count": 0
+}