Merge pull request #342 from bob-collective/feat/gateway-api-logo

feat: return project logo from api
bob-collective · Sep 11, 2024 · d6e91a4 · d6e91a4
2 parents b5239fc + ee4365a
commit d6e91a4
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 11 deletions.
diff --git a/sdk/package-lock.json b/sdk/package-lock.json
diff --git a/sdk/package.json b/sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gobob/bob-sdk",
-  "version": "2.2.6",
+  "version": "2.2.7",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

diff --git a/sdk/src/gateway/client.ts b/sdk/src/gateway/client.ts
@@ -272,10 +272,11 @@ export class GatewayApiClient {
 
         const strategies: GatewayStrategy[] = await response.json();
         return strategies.map((strategy) => {
+            const strategySlug = slugify(strategy.strategyName);
             const inputToken = ADDRESS_LOOKUP[strategy.inputTokenAddress];
             const outputToken = strategy.outputTokenAddress ? ADDRESS_LOOKUP[strategy.outputTokenAddress] : undefined;
             return {
-                id: "",
+                id: strategySlug,
                 type: "deposit",
                 address: strategy.strategyAddress,
                 method: "",
@@ -291,9 +292,9 @@ export class GatewayApiClient {
                 },
                 integration: {
                     type: strategy.strategyType,
-                    slug: strategy.strategyName,
+                    slug: strategySlug,
                     name: strategy.strategyName,
-                    logo: "", // TODO
+                    logo: strategy.projectLogo || outputToken?.logoURI || "",
                     monetization: false,
                 },
                 inputToken: {
@@ -378,3 +379,10 @@ function isHexPrefixed(str: string): boolean {
 function stripHexPrefix(str: string): string {
     return isHexPrefixed(str) ? str.slice(2) : str;
 }
+
+function slugify(str: string): string {
+    return str
+        .toLowerCase()
+        .replace(/ /g, "-")
+        .replace(/[^\w-]+/g, "");
+}
diff --git a/sdk/src/gateway/types.ts b/sdk/src/gateway/types.ts
@@ -75,9 +75,9 @@ type GatewayIntegrationType = "bridge" | "dex" | "staking" | "lending";
 
 interface GatewayIntegration {
     type: GatewayIntegrationType;
-    /** @example rocketpool */
+    /** @example pell-network-wbtc */
     slug: string;
-    /** @example RocketPool */
+    /** @example Pell Network (wBTC) */
     name: string;
     /** Format: uri */
     logo: string;
@@ -237,6 +237,8 @@ export interface GatewayStrategy {
     strategyAddress: string;
     strategyName: string;
     strategyType: "staking" | "lending";
+    projectName: string;
+    projectLogo?: string;
     inputTokenAddress: string;
     outputTokenAddress?: string;
 }
diff --git a/sdk/test/gateway.test.ts b/sdk/test/gateway.test.ts
@@ -172,9 +172,8 @@ describe("Gateway Tests", () => {
             .reply(200, [{
                 strategyAddress: ZeroAddress,
                 inputTokenAddress: SYMBOL_LOOKUP[ChainId.BOB]["tbtc"].address,
-                name: "",
-                slug: "",
-                type: "staking"
+                strategyName: "Pell Network (tBTC)",
+                strategyType: "staking"
             }]);
         nock(`${MAINNET_GATEWAY_BASE_URL}`)
             .get(`/quote/${SYMBOL_LOOKUP[ChainId.BOB]["tbtc"].address}?satoshis=1000&strategy=${ZeroAddress}`)
@@ -195,6 +194,7 @@ describe("Gateway Tests", () => {
         assert.lengthOf(strategies, 1);
         assert.isDefined(strategies[0].inputToken);
         assert.isNull(strategies[0].outputToken);
+        assert.equal(strategies[0].integration.slug, "pell-network-tbtc");
 
         const strategy = strategies[0];
         await gatewaySDK.getQuote({