fix(docs): update README and development documentation for v2 endpoints

- Updated GraphQL endpoint references from v1 to v2 in README and development documentation.
- Adjusted API routes in various controllers to reflect the new v2 structure.
- Added new response types in schema.graphql for hyperboard and section entries.
- Updated test descriptions to align with the new v2 endpoints.

Author: Jipperism

README.md

@@ -28,10 +28,10 @@ The API implements a fallback to the first available RPC. You can set the RPCs i
 
 ### Supabase
 
-* Install Docker
-* `git submodule init`
-* `git submodule update --remote`
-* `pnpm supabase:start:all`
+- Install Docker
+- `git submodule init`
+- `git submodule update --remote`
+- `pnpm supabase:start:all`
 
 This will spin up 2 Supabase instances in Docker, one for the indexer service (caching) and one for the data service (static data) which are both exposed by the API.
 
@@ -43,21 +43,21 @@ From both instances, you can get their respective keys and add them to the env v
 
 This will run a live production instance by running `swc` to compile the code and `nodemon` to restart the server on changes.
 
-You can then find the API at `localhost:4000/spec` (Swagger instance) and the GraphQL at `localhost:4000/v1/graphql`
+You can then find the API at `localhost:4000/spec` (Swagger instance) and the GraphQL at `localhost:4000/v2/graphql`
 
 ## Deployments
 
 Production: `https://api.hypercerts.org/`
 Staging: `https://staging-api.hypercerts.org`
 
 `/spec` - Swagger instance documenting the API and exposing a playground to experiment with the endpoints
-`/v1/graphql` - GraphQL API to access hypercerts data like claims, fractions, attestations, allow lists
+`/v2/graphql` - GraphQL API to access hypercerts data like claims, fractions, attestations, allow lists
 
 ## Scripts
 
 - `dev`: Starts the development server using `nodemon`, which will automatically restart the server whenever you save a file that the server uses.
 - `build`: Denerates the OpenAPI specification and routes using `tsoa`, and then compiles the TypeScript code into JavaScript using `swc`. The compiled code is output to the `dist` directory.
-- `start`: Starts the application in production mode. 
+- `start`: Starts the application in production mode.
 - `lint`: Runs `eslint` on the codebase to check for linting errors.
 - `test`: Runs tests using `vitest`
 
@@ -86,38 +86,38 @@ The API also provides an upload and validation endpoint for hypercert and allow
 graph TB
     Client[Client Applications]
     API[Hypercerts API :4000]
-    
+
     subgraph "API Endpoints"
         Swagger["/spec\nSwagger Documentation"]
-        GraphQL["/v1/graphql\nGraphQL Endpoint"]
+        GraphQL["/v2/graphql\nGraphQL Endpoint"]
         Upload["Upload & Validation\nEndpoints"]
     end
-    
+
     subgraph "Data Services"
         Static[("Static Data Service\n(Supabase DB)\n- User Data\n- Collections\n- Signed Orders")]
         Indexer[("Indexer Service\n(Supabase DB)\n- On-chain Data\n- IPFS Data")]
     end
-    
+
     subgraph "External Services"
         IPFS[(IPFS\nMetadata Storage)]
         Blockchain[(Blockchain\nSupported Chains)]
         EAS[(EAS\nAttestations)]
     end
-    
+
     Client --> API
     API --> Swagger
     API --> GraphQL
     API --> Upload
-    
+
     GraphQL --> Static
     GraphQL --> Indexer
     Upload --> IPFS
-    
+
     Indexer --> Blockchain
     Indexer --> IPFS
     Indexer --> EAS
-    
+
     class Swagger,GraphQL,Upload apiEndpoint;
     class Static,Indexer database;
     class IPFS,Blockchain,EAS external;
-```
+```

docs/DEVELOPMENT.md

@@ -165,7 +165,7 @@ For a complete example, you can look at the implementation of existing entities
 ## Testing Your Implementation
 
 1. Start the development server: `pnpm dev`
-2. Access the GraphQL playground at `http://localhost:4000/v1/graphql`
+2. Access the GraphQL playground at `http://localhost:4000/v2/graphql`
 3. Test your queries and mutations
 4. Run the test suite: `pnpm test`
 

schema.graphql

@@ -515,6 +515,11 @@ type GetFractionsResponse {
   data: [Fraction!]
 }
 
+type GetHyperboardOwnersResponse {
+  count: Int
+  data: [HyperboardOwner!]
+}
+
 type GetHyperboardsResponse {
   count: Int
   data: [Hyperboard!]
@@ -553,6 +558,16 @@ type GetSalesResponse {
   data: [Sale!]
 }
 
+type GetSectionEntryOwnersResponse {
+  count: Int
+  data: [SectionEntryOwner!]
+}
+
+type GetSectionsResponse {
+  count: Int
+  data: [Section!]
+}
+
 type GetSignatureRequestResponse {
   count: Int
   data: [SignatureRequest!]
@@ -579,13 +594,20 @@ type Hyperboard {
 
   """Name of the hyperboard"""
   name: String!
-  owners: [HyperboardOwner!]!
-  sections: [SectionResponseType!]!
+  owners: GetHyperboardOwnersResponse!
+  sections: GetSectionsResponse!
 
   """Color of the borders of the hyperboard"""
   tile_border_color: String
 }
 
+input HyperboardCollectionWhereInput {
+  created_at: StringSearchOptions
+  description: StringSearchOptions
+  id: StringSearchOptions
+  name: StringSearchOptions
+}
+
 type HyperboardOwner {
   """The address of the user"""
   address: String!
@@ -620,6 +642,7 @@ input HyperboardUserWhereInput {
 input HyperboardWhereInput {
   admins: HyperboardUserWhereInput = {}
   chain_ids: NumberArraySearchOptions
+  collections: HyperboardCollectionWhereInput = {}
   id: StringSearchOptions
 }
 
@@ -822,9 +845,7 @@ type Metadata {
   """References additional information related to the hypercert"""
   external_url: String
   id: ID
-
-  """Base64 encoded representation of the image of the hypercert"""
-  image: String
+  image: String!
 
   """Impact scope of the hypercert"""
   impact_scope: [String!]
@@ -915,7 +936,7 @@ type Order {
   chainId: EthBigInt!
   collection: String!
   collectionType: Float!
-  createdAt: String!
+  createdAt: Float!
   currency: String!
   endTime: Float!
   globalNonce: String!
@@ -936,7 +957,7 @@ type Order {
   startTime: Float!
   strategyId: Float!
   subsetNonce: Float!
-  validator_codes: [String!]
+  validator_codes: [Int!]
 }
 
 input OrderHypercertWhereInput {
@@ -1102,12 +1123,12 @@ input SaleWhereInput {
   transaction_hash: StringSearchOptions
 }
 
-"""Section representing a collection within a hyperboard"""
+"""Section representing one or more collectionswithin a hyperboard"""
 type Section {
-  collection: Collection!
+  collections: [Collection!]!
   entries: [SectionEntry!]!
   label: String!
-  owners: [HyperboardOwner!]!
+  owners: GetHyperboardOwnersResponse!
 }
 
 """Entry representing a hypercert or blueprint within a section"""
@@ -1120,9 +1141,9 @@ type SectionEntry {
 
   """Name of the hypercert or blueprint"""
   name: String
-  owners: [SectionEntryOwner!]!
+  owners: GetSectionEntryOwnersResponse!
   percentage_of_section: Float!
-  total_units: BigInt
+  total_units: EthBigInt
 }
 
 type SectionEntryOwner {
@@ -1142,12 +1163,7 @@ type SectionEntryOwner {
 
   """Pending signature requests for the user"""
   signature_requests: GetSignatureRequestResponse
-  units: BigInt
-}
-
-type SectionResponseType {
-  count: Float!
-  data: [Section!]!
+  units: EthBigInt
 }
 
 """Pending signature request for a user"""

src/client/graphql.ts

@@ -53,7 +53,7 @@ export const yoga = createYoga({
   cors: {
     methods: ["POST"],
   },
-  graphqlEndpoint: "/v1/graphql",
+  graphqlEndpoint: "/v2/graphql",
   plugins: [
     useResponseCache({
       // global cache
@@ -76,6 +76,6 @@ export const yoga = createYoga({
 });
 
 export const urqlClient = new Client({
-  url: `${CONSTANTS.ENDPOINTS[indexerEnvironment as "production" | "test"]}/v1/graphql`,
+  url: `${CONSTANTS.ENDPOINTS[indexerEnvironment as "production" | "test"]}/v2/graphql`,
   exchanges: [cacheExchange, fetchExchange],
 });

src/controllers/AllowListController.ts

@@ -17,7 +17,7 @@ import type {
 } from "../types/api.js";
 import { jsonToBlob } from "../utils/jsonToBlob.js";
 
-@Route("v1/allowlists")
+@Route("v2/allowlists")
 @Tags("Allowlists")
 export class AllowListController extends Controller {
   /**

src/controllers/BlueprintController.ts

@@ -26,7 +26,7 @@ import { verifyAuthSignedData } from "../utils/verifyAuthSignedData.js";
 import { waitForTxThenMintBlueprint } from "../utils/waitForTxThenMintBlueprint.js";
 
 @injectable()
-@Route("v1/blueprints")
+@Route("v2/blueprints")
 @Tags("Blueprints")
 export class BlueprintController extends Controller {
   constructor(

src/controllers/HyperboardController.ts

@@ -33,7 +33,7 @@ const allChains = Object.keys(CONSTANTS.DEPLOYMENTS).map((chain) =>
 );
 
 @injectable()
-@Route("v1/hyperboards")
+@Route("v2/hyperboards")
 @Tags("Hyperboards")
 export class HyperboardController extends Controller {
   constructor(

src/controllers/MarketplaceController.ts

@@ -26,7 +26,7 @@ import { FractionService } from "../services/database/entities/FractionEntitySer
 import { MarketplaceOrdersService } from "../services/database/entities/MarketplaceOrdersEntityService.js";
 
 @injectable()
-@Route("v1/marketplace")
+@Route("v2/marketplace")
 @Tags("Marketplace")
 export class MarketplaceController extends Controller {
   constructor(

src/controllers/MetadataController.ts

@@ -21,7 +21,7 @@ import { jsonToBlob } from "../utils/jsonToBlob.js";
 import { validateMetadataAndClaimdata } from "../utils/validateMetadataAndClaimdata.js";
 import { validateRemoteAllowList } from "../utils/validateRemoteAllowList.js";
 
-@Route("v1/metadata")
+@Route("v2/metadata")
 @Tags("Metadata")
 export class MetadataController extends Controller {
   /**

src/controllers/SignatureRequestController.ts

@@ -21,7 +21,7 @@ interface CancelSignatureRequest {
 }
 
 @injectable()
-@Route("v1/signature-requests")
+@Route("v2/signature-requests")
 @Tags("SignatureRequests")
 export class SignatureRequestController extends Controller {
   constructor(