Merge pull request #85 from hypercerts-org/develop

Develop

schema.graphql

@@ -101,6 +101,12 @@ input BasicAttestationWhereInput {
   uid: StringSearchOptions
 }
 
+input BasicCollectionWhereInput {
+  admin_id: StringSearchOptions
+  chain_id: NumberSearchOptions
+  id: IdSearchOptions
+}
+
 input BasicContractWhereInput {
   chain_id: NumberSearchOptions
   contract_address: StringSearchOptions
@@ -122,7 +128,6 @@ input BasicHypercertWhereInput {
   creator_address: StringSearchOptions
   hypercert_id: StringSearchOptions
   id: IdSearchOptions
-  owner_address: StringSearchOptions
   token_id: NumberSearchOptions
   uri: StringSearchOptions
 }
@@ -158,10 +163,30 @@ input BooleanSearchOptions {
   eq: Boolean
 }
 
+type Collection {
+  admin_address: String!
+  background_image: String!
+  chain_id: BigInt
+  grayscale_image: Boolean!
+  id: ID!
+  name: String!
+  tile_border_color: String!
+}
+
+input CollectionFetchInput {
+  by: ContractSortOptions
+}
+
+"""Pointer to a contract deployed on a chain"""
 type Contract {
+  """The ID of the chain on which the contract is deployed"""
   chain_id: BigInt
+
+  """The address of the contract"""
   contract_address: String
   id: ID!
+
+  """The block number at which the contract was deployed"""
   start_block: BigInt
 }
 
@@ -190,14 +215,25 @@ enum CountKeys {
 scalar EthBigInt
 
 type Fraction {
-  claims_id: String
   creation_block_timestamp: BigInt
-  hypercert_id: ID
+
+  """
+  The ID of the fraction concatenated from the chain ID, contract address, and token ID
+  """
+  fraction_id: ID
   id: ID!
   last_block_update_timestamp: BigInt
+
+  """The metadata for the fraction"""
   metadata: Metadata
+
+  """Marketplace orders related to this fraction"""
   orders: GetOrdersResponse
+
+  """Address of the owner of the fractions"""
   owner_address: String
+
+  """Units held by the fraction"""
   units: EthBigInt
 }
 
@@ -234,6 +270,11 @@ type GetAttestationsSchemaResponse {
   data: [AttestationSchema!]!
 }
 
+type GetCollectionsResponse {
+  count: Int
+  data: [Collection!]
+}
+
 type GetContractsResponse {
   count: Int
   data: [Contract!]
@@ -257,23 +298,49 @@ type GetMetadataResponse {
 type GetOrdersResponse {
   count: Int
   data: [Order!]
+  lowestAvailablePrice: BigInt
+  totalUnitsForSale: BigInt
 }
 
 type Hypercert {
+  """Attestations for the hypercert or parts of its data"""
   attestations: GetAttestationsResponse
+
+  """The block number at which the hypercert was stored on chain"""
   block_number: BigInt
+
+  """The contract that the hypercert is associated with"""
   contract: Contract
+
+  """The UUID of the contract as stored in the database"""
   contracts_id: ID
+
+  """The address of the creator of the hypercert"""
   creator_address: String
+
+  """Transferable fractions representing partial ownership of the hypercert"""
   fractions: GetFractionsResponse
+
+  """
+  Concatenation of [chainID]-[contractAddress]-[tokenID] to discern hypercerts across chains
+  """
   hypercert_id: ID
   id: ID!
   last_block_update_timestamp: BigInt
+
+  """The metadata for the hypercert as referenced by the uri"""
   metadata: Metadata
+
+  """Marketplace orders related to this hypercert"""
   orders: GetOrdersResponse
-  owner_address: String
+
+  """The token ID of the hypercert"""
   token_id: EthBigInt
+
+  """The total units held by the hypercert"""
   units: EthBigInt
+
+  """References the metadata for this claim"""
   uri: String
 }
 
@@ -301,7 +368,6 @@ input HypercertsWhereInput {
   hypercert_id: StringSearchOptions
   id: IdSearchOptions
   metadata: BasicMetadataWhereInput
-  owner_address: StringSearchOptions
   token_id: NumberSearchOptions
   uri: StringSearchOptions
 }
@@ -402,6 +468,7 @@ input OrderFetchInput {
 type Query {
   attestationSchemas(count: CountKeys, first: Int, offset: Int, sort: AttestationSchemaFetchInput, where: AttestationSchemaWhereInput): GetAttestationsSchemaResponse!
   attestations(count: CountKeys, first: Int, offset: Int, sort: AttestationFetchInput, where: AttestationWhereInput): GetAttestationsResponse!
+  collections(count: CountKeys, first: Int, offset: Int, sort: CollectionFetchInput, where: BasicCollectionWhereInput): GetCollectionsResponse!
   contracts(count: CountKeys, first: Int, offset: Int, sort: ContractFetchInput, where: BasicContractWhereInput): GetContractsResponse!
   fractions(count: CountKeys, first: Int, offset: Int, sort: FractionFetchInput, where: FractionWhereInput): GetFractionsResponse!
   hypercerts(count: CountKeys, first: Int, offset: Int, sort: HypercertFetchInput, where: HypercertsWhereInput): GetHypercertsResponse!

src/graphql/schemas/args/collectionArgs.ts

@@ -0,0 +1,17 @@
+import { ArgsType, Field } from "type-graphql";
+import { PaginationArgs } from "./paginationArgs.js";
+import {BasicCollectionWhereInput, CollectionFetchInput} from "../inputs/collectionInput.js";
+
+@ArgsType()
+export class GetCollectionArgs extends PaginationArgs {
+  @Field({ nullable: true })
+  where?: BasicCollectionWhereInput;
+  @Field({ nullable: true })
+  sort?: CollectionFetchInput;
+}
+
+@ArgsType()
+export class GetCollectionByIdArgs {
+  @Field({ nullable: true })
+  id?: string;
+}

src/graphql/schemas/inputs/collectionInput.ts

@@ -0,0 +1,22 @@
+import { Field, InputType } from "type-graphql";
+import type { WhereOptions } from "./whereOptions.js";
+import {IdSearchOptions, NumberSearchOptions, StringSearchOptions} from "./searchOptions.js";
+import { ContractSortOptions } from "./sortOptions.js";
+import {Collection} from "../typeDefs/collectionTypeDefs.js";
+import {CollectionOptions} from "./collectionOptions.js";
+
+@InputType()
+export class BasicCollectionWhereInput implements WhereOptions<Collection> {
+  @Field((_) => IdSearchOptions, { nullable: true })
+  id?: IdSearchOptions | null;
+  @Field((_) => NumberSearchOptions, { nullable: true })
+  chain_id?: NumberSearchOptions | null;
+  @Field((_) => StringSearchOptions, { nullable: true })
+  admin_id?: StringSearchOptions | null;
+}
+
+@InputType()
+export class CollectionFetchInput implements CollectionOptions<Collection> {
+  @Field((_) => ContractSortOptions, { nullable: true })
+  by?: ContractSortOptions;
+}

src/graphql/schemas/inputs/collectionOptions.ts

@@ -0,0 +1,13 @@
+import {
+    AttestationSchemaSortOptions,
+    AttestationSortOptions,
+    ContractSortOptions, FractionSortOptions,
+    HypercertSortOptions,
+    MetadataSortOptions
+} from "./sortOptions.js";
+
+
+export type CollectionOptions<T extends object> = {
+    by?: HypercertSortOptions | ContractSortOptions | MetadataSortOptions | AttestationSortOptions | AttestationSchemaSortOptions | FractionSortOptions | null;
+}
+

src/graphql/schemas/inputs/hypercertsInput.ts

@@ -14,8 +14,6 @@ export class BasicHypercertWhereInput implements WhereOptions<Hypercert> {
     @Field(_ => NumberSearchOptions, {nullable: true})
     token_id?: NumberSearchOptions;
     @Field(_ => StringSearchOptions, {nullable: true})
-    owner_address?: StringSearchOptions;
-    @Field(_ => StringSearchOptions, {nullable: true})
     creator_address?: StringSearchOptions;
     @Field(_ => StringSearchOptions, {nullable: true})
     uri?: StringSearchOptions;

src/graphql/schemas/resolvers/collectionResolver.ts

@@ -0,0 +1,50 @@
+import { Args, Field, Int, ObjectType, Query, Resolver } from "type-graphql";
+import { inject, injectable } from "tsyringe";
+import { Order } from "../typeDefs/orderTypeDefs.js";
+import { SupabaseDataService } from "../../../services/SupabaseDataService.js";
+import {Collection} from "../typeDefs/collectionTypeDefs.js";
+import {GetCollectionArgs} from "../args/collectionArgs.js";
+
+@ObjectType()
+export default class GetCollectionsResponse {
+  @Field(() => [Collection], { nullable: true })
+  data?: Collection[];
+
+  @Field(() => Int, { nullable: true })
+  count?: number;
+}
+
+@injectable()
+@Resolver((_) => Order)
+class CollectionResolver {
+  constructor(
+    @inject(SupabaseDataService)
+    private readonly supabaseService: SupabaseDataService,
+  ) {}
+
+  @Query((_) => GetCollectionsResponse)
+  async collections(@Args() args: GetCollectionArgs) {
+    try {
+      const res = await this.supabaseService.getCollections(args)
+
+      const { data, error, count } = res;
+
+      if (error) {
+        console.warn(
+          `[CollectionResolver::collections] Error fetching collections: `,
+          error,
+        );
+        return { data };
+      }
+
+      return { data, count: count ? count : data?.length };
+    } catch (e) {
+      throw new Error(
+        `[CollectionResolver::collections] Error fetching collections: ${(e as Error).message}`,
+      );
+    }
+  }
+
+}
+
+export { CollectionResolver };

src/graphql/schemas/resolvers/composed.ts

@@ -5,6 +5,7 @@ import { FractionResolver } from "./fractionResolver.js";
 import { AttestationResolver } from "./attestationResolver.js";
 import { AttestationSchemaResolver } from "./attestationSchemaResolver.js";
 import { OrderResolver } from "./orderResolver.js";
+import { CollectionResolver } from "./collectionResolver.js";
 
 export const resolvers = [
   ContractResolver,
@@ -14,4 +15,5 @@ export const resolvers = [
   AttestationResolver,
   AttestationSchemaResolver,
   OrderResolver,
+  CollectionResolver
 ] as const;

src/graphql/schemas/resolvers/hypercertResolver.ts

@@ -14,6 +14,7 @@ import { SupabaseCachingService } from "../../../services/SupabaseCachingService
 import { GetHypercertArgs } from "../args/hypercertsArgs.js";
 import { SupabaseDataService } from "../../../services/SupabaseDataService.js";
 import { parseClaimOrFractionId } from "@hypercerts-org/sdk";
+import {decodeAbiParameters, parseAbiParameters} from "viem";
 
 @ObjectType()
 export default class GetHypercertsResponse {
@@ -294,7 +295,37 @@ class HypercertResolver {
         return { data: [], count: 0 };
       }
 
+      // For each fraction, find all orders and find the max units for sale for that fraction
+      const totalUnitsForSale = fractionsData.map((fraction) => {
+        const ordersForFraction = ordersData.filter(
+          (order) =>
+            parseClaimOrFractionId(fraction.hypercert_id).id.toString() ===
+            order.itemIds[0],
+        );
+
+        const unitsPerOrder = ordersForFraction.map((order) => {
+          const decodedParams = decodeAbiParameters(
+            parseAbiParameters("uint256 minUnitAmount, uint256 maxUnitAmount, uint256 minUnitsToKeep, bool sellLeftOverFraction"),
+            order.additionalParameters as `0x{string}`,
+          );
+          const unitsToKeep = decodedParams[2];
+          const units = BigInt(fraction.units);
+          return units - unitsToKeep;
+        });
+
+        // Find max units per order
+        return unitsPerOrder.reduce((acc, val) => {
+            return val > acc ? val : acc;
+          }, BigInt(0));
+      }).reduce((acc, val) => acc + val, BigInt(0));
+
+      const lowestAvailablePrice = ordersData.reduce((acc, val) => {
+        return BigInt(val.price) < acc ? BigInt(val.price) : acc;
+      }, BigInt(ordersData[0]?.price || 0));
+
       return {
+        totalUnitsForSale,
+        lowestAvailablePrice,
         data: ordersData || [],
         count: ordersCount || 0,
       };

src/graphql/schemas/resolvers/orderResolver.ts

@@ -4,6 +4,7 @@ import { Order } from "../typeDefs/orderTypeDefs.js";
 import { SupabaseDataService } from "../../../services/SupabaseDataService.js";
 import { GetOrdersArgs } from "../args/orderArgs.js";
 import { SupabaseCachingService } from "../../../services/SupabaseCachingService.js";
+import {GraphQLBigInt} from "graphql-scalars";
 
 @ObjectType()
 export default class GetOrdersResponse {
@@ -12,6 +13,13 @@ export default class GetOrdersResponse {
 
   @Field(() => Int, { nullable: true })
   count?: number;
+
+  @Field(() => GraphQLBigInt, { nullable: true })
+  totalUnitsForSale?: bigint;
+
+  @Field(() => GraphQLBigInt, { nullable: true })
+  lowestAvailablePrice?: bigint;
+
 }
 
 @injectable()

src/graphql/schemas/typeDefs/collectionTypeDefs.ts

@@ -0,0 +1,21 @@
+import { Field, ObjectType } from "type-graphql";
+import { BasicTypeDef } from "./basicTypeDef.js";
+import {GraphQLBigInt} from "graphql-scalars";
+
+@ObjectType()
+class Collection extends BasicTypeDef {
+  @Field()
+  name?: string;
+  @Field({name: "admin_address"})
+  admin_id?: string;
+  @Field(() => GraphQLBigInt, {nullable: true})
+  chain_id?: number;
+  @Field()
+  background_image?: string;
+  @Field()
+  grayscale_image?: boolean;
+  @Field()
+  tile_border_color?: string;
+}
+
+export { Collection };

src/graphql/schemas/typeDefs/contractTypeDefs.ts

@@ -2,13 +2,13 @@ import {Field, ObjectType} from "type-graphql";
 import {GraphQLBigInt} from 'graphql-scalars';
 import {BasicTypeDef} from "./basicTypeDef.js";
 
-@ObjectType()
+@ObjectType({description: "Pointer to a contract deployed on a chain"})
 class Contract extends BasicTypeDef {
-    @Field(_ => GraphQLBigInt, {nullable: true})
+    @Field(_ => GraphQLBigInt, {nullable: true, description: "The ID of the chain on which the contract is deployed"})
     chain_id?: bigint | number | string;
-    @Field({nullable: true})
+    @Field({nullable: true, description: "The address of the contract"})
     contract_address?: string;
-    @Field(_ => GraphQLBigInt, {nullable: true})
+    @Field(_ => GraphQLBigInt, {nullable: true, description: "The block number at which the contract was deployed"})
     start_block?: bigint | number | null;
 }