Add the ability to query a Realm (#7)

Author: nramadas

migrations/1661291478011-Feed.ts

@@ -0,0 +1,43 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class Feed1661291478011 implements MigrationInterface {
+    name = 'Feed1661291478011'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`
+            CREATE TABLE "realm_feed_item" (
+                "id" SERIAL NOT NULL,
+                "data" jsonb NOT NULL,
+                "environment" character varying NOT NULL,
+                "metadata" jsonb NOT NULL,
+                "realmPublicKeyStr" character varying NOT NULL,
+                "created" TIMESTAMP NOT NULL DEFAULT now(),
+                "deleted" TIMESTAMP,
+                "updated" TIMESTAMP WITH TIME ZONE NOT NULL,
+                CONSTRAINT "PK_e24c04da3892a7573c1aa0d37ef" PRIMARY KEY ("id")
+            )
+        `);
+        await queryRunner.query(`
+            CREATE TABLE "realm_post" (
+                "id" uuid NOT NULL DEFAULT uuid_generate_v4(),
+                "data" jsonb NOT NULL,
+                "environment" character varying NOT NULL,
+                "realmPublicKeyStr" character varying NOT NULL,
+                "created" TIMESTAMP NOT NULL DEFAULT now(),
+                "deleted" TIMESTAMP,
+                "updated" TIMESTAMP NOT NULL DEFAULT now(),
+                CONSTRAINT "PK_656c881149a9a927ec98733bcc0" PRIMARY KEY ("id")
+            )
+        `);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`
+            DROP TABLE "realm_post"
+        `);
+        await queryRunner.query(`
+            DROP TABLE "realm_feed_item"
+        `);
+    }
+
+}

migrations/1661458148129-FeedVote.ts

@@ -0,0 +1,27 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class FeedVote1661458148129 implements MigrationInterface {
+    name = 'FeedVote1661458148129'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`
+            CREATE TABLE "realm_feed_item_vote" (
+                "feedItemId" integer NOT NULL,
+                "userId" uuid NOT NULL,
+                "realmPublicKeyStr" character varying NOT NULL,
+                "data" jsonb NOT NULL,
+                "created" TIMESTAMP NOT NULL DEFAULT now(),
+                "deleted" TIMESTAMP,
+                "updated" TIMESTAMP NOT NULL DEFAULT now(),
+                CONSTRAINT "PK_b38f37a82c7f2026c4615998e67" PRIMARY KEY ("feedItemId", "userId", "realmPublicKeyStr")
+            )
+        `);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`
+            DROP TABLE "realm_feed_item_vote"
+        `);
+    }
+
+}

migrations/1661530384910-RealmPostAuthor.ts

@@ -0,0 +1,26 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class RealmPostAuthor1661530384910 implements MigrationInterface {
+    name = 'RealmPostAuthor1661530384910'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`
+            ALTER TABLE "realm_post"
+            ADD "authorId" uuid NOT NULL
+        `);
+        await queryRunner.query(`
+            ALTER TABLE "realm_post"
+            ADD CONSTRAINT "FK_9d06be18d3a8c7e9aa11c983716" FOREIGN KEY ("authorId") REFERENCES "user"("id") ON DELETE NO ACTION ON UPDATE NO ACTION
+        `);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`
+            ALTER TABLE "realm_post" DROP CONSTRAINT "FK_9d06be18d3a8c7e9aa11c983716"
+        `);
+        await queryRunner.query(`
+            ALTER TABLE "realm_post" DROP COLUMN "authorId"
+        `);
+    }
+
+}

package.json

@@ -26,6 +26,7 @@
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
+    "@cardinal/namespaces": "^4.1.56",
     "@nestjs/common": "^9.0.0",
     "@nestjs/config": "^2.2.0",
     "@nestjs/core": "^9.0.0",
@@ -36,16 +37,26 @@
     "@nestjs/platform-express": "^9.0.0",
     "@nestjs/platform-fastify": "^9.0.8",
     "@nestjs/typeorm": "^9.0.0",
+    "@solana/spl-governance": "^0.3.1",
+    "@solana/spl-token-registry": "^0.2.4574",
     "@solana/web3.js": "^1.50.1",
+    "@types/graphql-type-json": "^0.3.2",
     "altair-fastify-plugin": "^4.5.3",
+    "bignumber.js": "^9.1.0",
+    "cache-manager": "^4.1.0",
     "date-fns": "^2.29.1",
     "fp-ts": "^2.12.2",
     "graphql": "^16.5.0",
+    "graphql-relay": "^0.10.0",
+    "graphql-request": "^4.3.0",
+    "graphql-type-json": "^0.3.2",
     "graphql-upload": "13.0.0",
     "io-ts": "^2.2.17",
     "io-ts-types": "^0.5.16",
     "mercurius": "^9",
     "mercurius-upload": "^5.0.0",
+    "monocle-ts": "^2.3.13",
+    "newtype-ts": "^0.3.5",
     "passport": "^0.6.0",
     "passport-jwt": "^4.0.0",
     "pg": "^8.7.3",
@@ -60,6 +71,7 @@
     "@nestjs/cli": "^9.0.0",
     "@nestjs/schematics": "^9.0.0",
     "@nestjs/testing": "^9.0.0",
+    "@types/cache-manager": "^4.0.1",
     "@types/eslint": "^8.4.5",
     "@types/eslint-plugin-prettier": "^3.1.0",
     "@types/express": "^4.17.13",

src/app.module.ts

@@ -6,15 +6,26 @@ import { MercuriusDriver, MercuriusDriverConfig } from '@nestjs/mercurius';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import mercurius from 'mercurius';
 
-// import { NonceScalar } from '@lib/scalars/Nonce';
+import { BigNumberScalar } from '@lib/scalars/BigNumber';
+import { CursorScalar } from '@lib/scalars/Cursor';
 import { PublicKeyScalar } from '@lib/scalars/PublicKey';
+import { RichTextDocumentScalar } from '@lib/scalars/RichTextDocument';
 import { AppController } from '@src/app.controller';
 import { AppService } from '@src/app.service';
 import { AuthModule } from '@src/auth/auth.module';
 import { ConfigModule } from '@src/config/config.module';
 import { ConfigService } from '@src/config/config.service';
-
-import { UserModule } from './user/user.module';
+import { HolaplexModule } from '@src/holaplex/holaplex.module';
+import { OnChainModule } from '@src/on-chain/on-chain.module';
+import { RealmFeedItemModule } from '@src/realm-feed-item/realm-feed-item.module';
+import { RealmFeedModule } from '@src/realm-feed/realm-feed.module';
+import { RealmMemberModule } from '@src/realm-member/realm-member.module';
+import { RealmPostModule } from '@src/realm-post/realm-post.module';
+import { RealmProposalModule } from '@src/realm-proposal/realm-proposal.module';
+import { RealmSettingsModule } from '@src/realm-settings/realm-settings.module';
+import { RealmTreasuryModule } from '@src/realm-treasury/realm-treasury.module';
+import { RealmModule } from '@src/realm/realm.module';
+import { UserModule } from '@src/user/user.module';
 
 @Module({
   imports: [
@@ -27,8 +38,10 @@ import { UserModule } from './user/user.module';
       driver: MercuriusDriver,
       persistedQueryProvider: mercurius.persistedQueryDefaults.automatic(),
       resolvers: {
-        // Nonce: NonceScalar,
+        BigNumber: BigNumberScalar,
+        Cursor: CursorScalar,
         PublicKey: PublicKeyScalar,
+        RichTextDocument: RichTextDocumentScalar,
       },
       sortSchema: true,
     }),
@@ -49,6 +62,16 @@ import { UserModule } from './user/user.module';
     }),
     AuthModule,
     UserModule,
+    HolaplexModule,
+    RealmModule,
+    RealmMemberModule,
+    RealmProposalModule,
+    RealmFeedModule,
+    RealmFeedItemModule,
+    RealmSettingsModule,
+    RealmPostModule,
+    RealmTreasuryModule,
+    OnChainModule,
   ],
   controllers: [AppController],
   providers: [AppService],

src/auth/auth.jwt.strategy.ts

@@ -29,10 +29,8 @@ export class AuthJwtStrategy extends PassportStrategy(Strategy, 'authJwt') {
       this.userService.getUserById(payload.sub),
       TE.chainW(TE.fromOption(() => new errors.Unauthorized())),
       TE.matchW(
-        (error) => {
-          throw error;
-        },
-        (user) => ({ ...user.data, publicKey: new PublicKey(user.publicKeyStr) }),
+        () => null,
+        (user) => ({ ...user.data, id: user.id, publicKey: new PublicKey(user.publicKeyStr) }),
       ),
     )();
   }

src/auth/auth.resolver.ts

@@ -14,7 +14,10 @@ import { AuthClaim } from './dto/AuthClaim';
 export class AuthResolver {
   constructor(private readonly authService: AuthService) {}
 
-  @Mutation(() => AuthClaim)
+  @Mutation(() => AuthClaim, {
+    description:
+      'Generate an authentication claim that a wallet can sign and trade for an auth token',
+  })
   @EitherResolver()
   createAuthenticationClaim(
     @Args('publicKey', {
@@ -26,7 +29,9 @@ export class AuthResolver {
     return this.authService.generateClaim(publicKey);
   }
 
-  @Mutation(() => String)
+  @Mutation(() => String, {
+    description: 'Trade a signed authentication claim for an auth token',
+  })
   @EitherResolver()
   createAuthenticationToken(
     @Args('claim', {

src/auth/auth.service.ts

@@ -72,6 +72,9 @@ export class AuthService {
   extractClaimFromClaimStr(claimStr: string) {
     return FN.pipe(
       claimStr,
+      // The claim contains a bunch of filler text in the front to make it read
+      // well when being signed by the wallet. The claim string will be at the
+      // end.
       (str) => str.split(' '),
       AR.last,
       EI.fromOption(() => new errors.MalformedData()),

src/config/config.module.ts

@@ -20,7 +20,7 @@ import { ConfigService } from './config.service';
             },
             database: {
               host: process.env.DATABASE_HOST || '',
-              name: process.env.DATABASE_NAME,
+              name: process.env.DATABASE_NAME || '',
               password: process.env.DATABASE_PASSWORD,
               port: dbPort,
               username: process.env.DATABASE_USERNAME,

src/holaplex/holaplex.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+
+import { HolaplexService } from './holaplex.service';
+
+@Module({
+  providers: [HolaplexService],
+  exports: [HolaplexService],
+})
+export class HolaplexModule {}

src/holaplex/holaplex.service.spec.ts

@@ -0,0 +1,19 @@
+import { Test, TestingModule } from '@nestjs/testing';
+
+import { HolaplexService } from './holaplex.service';
+
+describe('HolaplexService', () => {
+  let service: HolaplexService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [HolaplexService],
+    }).compile();
+
+    service = module.get<HolaplexService>(HolaplexService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

src/holaplex/holaplex.service.ts

@@ -0,0 +1,29 @@
+import { Injectable } from '@nestjs/common';
+import * as FN from 'fp-ts/function';
+import * as TE from 'fp-ts/TaskEither';
+import { request, RequestDocument } from 'graphql-request';
+import * as IT from 'io-ts';
+
+import * as errors from '@lib/errors/gql';
+
+@Injectable()
+export class HolaplexService {
+  /**
+   * Make a GQL request to Holaplex's v1 indexer API
+   */
+  requestV1<Variables = any, A = any, O = any, I = any>(
+    req: {
+      query: RequestDocument;
+      variables?: Variables;
+    },
+    res: IT.Type<A, O, I>,
+  ) {
+    return FN.pipe(
+      TE.tryCatch(
+        () => request('https://graph.holaplex.com/v1', req.query, req.variables),
+        (e) => new errors.Exception(e),
+      ),
+      TE.chainW((result) => TE.fromEither(res.decode(result))),
+    );
+  }
+}

src/lib/decorators/CurrentEnvironment.ts

@@ -0,0 +1,23 @@
+import type { ExecutionContext } from '@nestjs/common';
+import { createParamDecorator } from '@nestjs/common';
+import { GqlExecutionContext } from '@nestjs/graphql';
+
+import { Environment } from '@lib/types/Environment';
+
+/**
+ * Get the current environment for the request, either `'mainnet'` or `'devnet'`.
+ */
+export const CurrentEnvironment = createParamDecorator(
+  (data: unknown, context: ExecutionContext) => {
+    const ctx = GqlExecutionContext.create(context);
+    const environment = ctx.getContext().req?.headers?.['x-environment'];
+
+    if (environment === 'devnet') {
+      return 'devnet';
+    }
+
+    return 'mainnet';
+  },
+);
+
+export { Environment }

src/lib/decorators/CurrentUser.ts

@@ -1,10 +1,22 @@
 import type { ExecutionContext } from '@nestjs/common';
 import { createParamDecorator } from '@nestjs/common';
 import { GqlExecutionContext } from '@nestjs/graphql';
+import type { PublicKey } from '@solana/web3.js';
 
+import { Data } from '@src/user/entities/User.entity';
+
+export interface User extends Data {
+  id: string;
+  publicKey: PublicKey;
+}
+
+/**
+ * Get the current user making the request
+ */
 export const CurrentUser = createParamDecorator(
   (data: unknown, context: ExecutionContext) => {
     const ctx = GqlExecutionContext.create(context);
-    return ctx.getContext().req.user;
+    return ctx.getContext().req.user as User;
   },
 );
+

src/lib/decorators/EitherResolver.ts

@@ -1,19 +1,13 @@
-import type { Either } from 'fp-ts/Either';
 import { isLeft } from 'fp-ts/Either';
-import type { TaskEither } from 'fp-ts/TaskEither';
-
-interface EitherFunction {
-  (...args: any[]):
-    | Either<any, any>
-    | Promise<Either<any, any>>
-    | TaskEither<any, any>;
-}
 
+/**
+ * Handle resolvers that return a `TaskEither`
+ */
 export function EitherResolver() {
   return (
     target: any,
     key: string,
-    descriptor: TypedPropertyDescriptor<EitherFunction>,
+    descriptor: TypedPropertyDescriptor<any>,
   ) => {
     if (!descriptor.value) {
       throw new Error('Missing a description for the EitherResolver');