add featured pools #496

mendesfabio · 2023-10-26T13:25:17Z

hey, folks! this is my first PR to the API 🎉 I talked to @danielmkm and he suggested me to work on this, some context:

Gareth made this repository to house metadata for pools. Would be great is if the API fetched this JSON and then merged it with the actual pool data, and returned it in the same format as is returned by the poolGetPools query GqlPoolMinimal. Lastly, expose a query named poolGetFeaturedPools and return an array of featured pools.

He suggested the following model for a featured pool:

{
    "id": ID!,
    "primary": Boolean!,
    "imageUrl": String!,
    "pool": GqlPoolMinimal!
}

Happy to hear any feedback!

gmbronco · 2023-10-30T09:10:55Z

Hey! Thanks for the pull request; nice one! I would suggest caching the GitHub data in the database so that we don't depend on fetching from an external URL.

franzns

In general, the code works like this but it should be integrated in the content service that we already have. Check how we expose featured pools here:
https://github.com/beethovenxfi/beethovenx-backend/blob/v3-main/modules/pool/lib/pool-gql-loader.service.ts#L93

You should be able to extend the github content service for Balancer: https://github.com/beethovenxfi/beethovenx-backend/blob/v3-main/modules/content/github-content.service.ts#L161

You can take a look at how we did it for the featured pools for beets: https://github.com/beethovenxfi/beethovenx-backend/blob/v3-main/modules/content/github-content.service.ts#L161

You can also try and persist the data into the database as jarek suggested, but can also leave that for another day.

Let me know if you have any questions.

franzns · 2023-10-30T12:05:46Z

modules/pool/lib/pool-gql-loader.service.ts

+        const poolsMetadata = await poolMetadataService.getPoolsMetadata();
+        const poolIds = poolsMetadata.map((pool) => pool.id);
+
+        const pools = await this.getPools({ where: { idIn: poolIds } });


This fetches the pools from the subgraph but we want to avoid that. Pools are synced to the database. You can query them like this:

const pools = await prisma.prismaPool.findMany({ where: { id: { in: poolIds }, chain: networkContext.chain }, });

This returns the prismaPool object, not sure if you need additional data. Also, you need to pass it the chain you request the pools for via network context. Or better, your gql resolver should take a chain array as argument and you query the pools for those chains.

mendesfabio · 2023-11-29T12:10:45Z

modules/pool/pool.service.ts

@@ -114,7 +114,7 @@ export class PoolService {
        return this.poolSwapService.getJoinExits(args);
    }

-    public async getFeaturedPoolGroups(): Promise<GqlPoolFeaturedPoolGroup[]> {
+    public async getFeaturedPoolGroups(chains: Chain[]): Promise<GqlPoolFeaturedPoolGroup[]> {
        const cached: GqlPoolFeaturedPoolGroup[] = await this.cache.get(


@franzns I'm in doubt about how to re-write this and poolGqlLoaderService.getFeaturedPoolGroups() functions given chains. Should we try to get it from cache for every network and for the ones it doesn't find we get it from poolGqlLoaderService?

It's fine to simply get rid of this cache since we are caching on Stellate. This was from a time before that.

franzns · 2023-11-30T13:00:48Z

modules/content/github-content.service.ts

@@ -159,7 +166,15 @@ export class GithubContentService implements ContentService {
    }
    async syncPoolContentData(): Promise<void> {}
    async getFeaturedPoolGroups(): Promise<HomeScreenFeaturedPoolGroup[]> {


this would need to be changed to take the chain (or chains) as an argument. Also for the sanity content service.

franzns · 2023-11-30T13:05:59Z

modules/pool/pool.resolvers.ts

-        poolGetFeaturedPoolGroups: async (parent, args, context) => {
-            return poolService.getFeaturedPoolGroups();
+        poolGetFeaturedPoolGroups: async (parent, { chains }, context) => {
+            return poolService.getFeaturedPoolGroups(chains);


here we would want to do the same that we do e.g. poolGetAllPoolsSnapshots below. We have a migration period where we still support both, the header chainId as well as the chains param

modules/content/github-content.service.ts

mendesfabio · 2023-12-20T21:16:07Z

hey I could add the filter by chains with support for param via headers. The query below seems to be returning what we needed - as specified in PR description:

{
    "id": ID!,
    "primary": Boolean!,
    "imageUrl": String!,
    "pool": GqlPoolMinimal!
}

I didn't know exactly how to test the Sanity stuff and ensure the same query works there given chains param instead of networkContext - if you want to go ahead and fix that I appreciate.

gmbronco · 2023-12-22T09:54:35Z

modules/content/github-content.service.ts

-    async getFeaturedPoolGroups(): Promise<HomeScreenFeaturedPoolGroup[]> {
-        return [];
+    async getFeaturedPoolGroups(chains: Chain[]): Promise<HomeScreenFeaturedPoolGroup[]> {
+        const { data } = await axios.get<FeaturedPoolMetadata[]>(POOLS_METADATA_URL);


we have native fetch now, how about we move away from axios?

gmbronco · 2023-12-22T09:58:29Z

modules/pool/lib/pool-gql-loader.service.ts

+    public async getFeaturedPoolGroups(chains: Chain[]): Promise<GqlPoolFeaturedPoolGroup[]> {
+        const featuredPoolGroups = [];
+        if (chains.some((chain) => BalancerChainIds.includes(chainToIdMap[chain]))) {
+            const githubContentService = new GithubContentService();
+            featuredPoolGroups.push(...(await githubContentService.getFeaturedPoolGroups(chains)));
+        } else if (chains.some((chain) => BeethovenChainIds.includes(chainToIdMap[chain]))) {
+            const sanityContentService = new SanityContentService('FANTOM');
+            featuredPoolGroups.push(...(await sanityContentService.getFeaturedPoolGroups(chains)));
+        }
        const poolIds = featuredPoolGroups


can we remove if / else and just query both? they will return empty array if there is no pools for a chain, right?

gmbronco · 2023-12-22T10:07:24Z

modules/content/github-content.service.ts

@@ -27,16 +36,14 @@ export class GithubContentService implements ContentService {
    async syncTokenContentData(): Promise<void> {


would it make sense to sync all the tokens at once without splitting per chain? i'm not sure if we aren't overcomplicating it here, since the whole list is fetched anyways.

bit lower there is upsert call, it can take chain as token.chainId instead of networkContext

gmbronco · 2023-12-22T10:17:27Z

modules/content/sanity-content.service.ts

@@ -77,12 +83,12 @@ export class SanityContentService implements ContentService {

            await prisma.prismaToken.upsert({
                where: {
-                    address_chain: { address: tokenAddress, chain: networkContext.chain },
+                    address_chain: { address: tokenAddress, chain: this.chain },


isn't the chain returned in the response? is so we could use it here instead of setting it up externally

add featured pools

bd6ae08

mendesfabio requested a review from danielmkm October 26, 2023 13:28

franzns requested changes Oct 30, 2023

View reviewed changes

mendesfabio added 6 commits November 7, 2023 09:31

integrate featured pools into content service

3e76925

use content service and load pools from db

9b5f0f6

reuse featured pool groups logic

68f8aba

fix merge conflicts

6c6db99

remove unused code

e23ec9f

add chains args to functions

f9dc003

mendesfabio commented Nov 29, 2023

View reviewed changes

franzns reviewed Nov 30, 2023

View reviewed changes

modules/content/github-content.service.ts Show resolved Hide resolved

mendesfabio added 3 commits December 20, 2023 18:00

add primary attribute and filter by chain ids

c220b51

support chain via headers

6b8215e

remove featured pools caching

f5cf53a

franzns added 4 commits December 21, 2023 16:28

add chainId

9eb22e0

Merge branch 'v3-canary' into feat/featured-pools

ea4a433

make sanity multichain

576c1bb

Merge branch 'v3-canary' into feat/featured-pools

bb88610

gmbronco reviewed Dec 22, 2023

View reviewed changes

gmbronco approved these changes Dec 22, 2023

View reviewed changes

franzns self-requested a review December 22, 2023 16:09

franzns approved these changes Dec 22, 2023

View reviewed changes

franzns merged commit 8fadbac into v3-canary Dec 22, 2023
1 check passed

franzns deleted the feat/featured-pools branch December 22, 2023 16:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add featured pools #496

add featured pools #496

mendesfabio commented Oct 26, 2023 •

edited

Loading

gmbronco commented Oct 30, 2023 •

edited

Loading

franzns left a comment

franzns Oct 30, 2023

mendesfabio Nov 7, 2023

mendesfabio Nov 29, 2023

franzns Nov 30, 2023

franzns Nov 30, 2023

franzns Nov 30, 2023

mendesfabio commented Dec 20, 2023

gmbronco Dec 22, 2023 •

edited

Loading

gmbronco Dec 22, 2023

gmbronco Dec 22, 2023

gmbronco Dec 22, 2023

gmbronco Dec 22, 2023

		@@ -27,16 +36,14 @@ export class GithubContentService implements ContentService {
		async syncTokenContentData(): Promise<void> {

add featured pools #496

add featured pools #496

Conversation

mendesfabio commented Oct 26, 2023 • edited Loading

gmbronco commented Oct 30, 2023 • edited Loading

franzns left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mendesfabio commented Dec 20, 2023

gmbronco Dec 22, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mendesfabio commented Oct 26, 2023 •

edited

Loading

gmbronco commented Oct 30, 2023 •

edited

Loading

gmbronco Dec 22, 2023 •

edited

Loading