Skip to content
This repository was archived by the owner on Aug 12, 2023. It is now read-only.

Commit 563448d

Browse files
cboviscbovis
authored
Improve metadata in app definitions (#452)
* Improve metadata in app definitions * Fix tests
1 parent ea792f3 commit 563448d

14 files changed

+54
-18
lines changed

‎src/apps/definitions/0x-api.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"id": "052b4862-2142-4532-bdc0-416814b0a5fe",
33
"name": "0x API",
4-
"logoUrl": "https://resources.0xtracker.com/logos/0x.png",
4+
"description": "Built by the 0x core team – 0x API makes accessing DEX liquidity easy through the use of smart order routing which aggregates liquidity from 0x Mesh, Kyber, Uniswap, and more.",
5+
"logo": "0x-api.png",
56
"urlSlug": "0x-api",
67
"websiteUrl": "https://0x.org/api",
78
"mappings": [

‎src/apps/definitions/1inch-exchange.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"id": "8fc6beb5-3019-45f7-a55a-9a4c6b4b6513",
33
"name": "1inch Exchange",
4-
"logoUrl": "https://resources.0xtracker.com/logos/1inch-exchange.png",
4+
"description": "1inch Exchange is a popular DEX aggregator which sources liquidity from 0x protocol in addition to relaying limit orders.",
5+
"logo": "1inch-exchange.png",
56
"urlSlug": "1inch-exchange",
67
"websiteUrl": "https://1inch.exchange",
78
"mappings": [

‎src/apps/definitions/defi-saver.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"id": "b986d2ba-77bf-420b-99e3-28e592d476e2",
33
"name": "DeFi Saver",
4-
"logoUrl": "https://resources.0xtracker.com/logos/defi-saver.png",
4+
"description": "DeFi Saver is a crypto-portfolio manager which sources liquidity from the 0x ecosystem.",
5+
"logo": "defi-saver.png",
56
"urlSlug": "defi-saver",
67
"websiteUrl": "https://defisaver.com/",
78
"mappings": [

‎src/apps/definitions/matcha.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"id": "5067df8b-f9cd-4a34-aee1-38d607100145",
33
"name": "Matcha",
4-
"logoUrl": "https://resources.0xtracker.com/logos/matcha.png",
4+
"description": "Built by the 0x core team – Matcha is a DEX aggregator built on top of 0x API which allows users to easily swap tokens and place limit orders.",
5+
"logo": "matcha.png",
56
"urlSlug": "matcha",
67
"websiteUrl": "https://matcha.xyz",
78
"mappings": [

‎src/apps/definitions/paraswap.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"id": "4c3854b7-95c3-4714-83ab-a8ed53d2967e",
33
"name": "Paraswap",
4-
"logoUrl": "https://resources.0xtracker.com/logos/paraswap.png",
4+
"description": "Paraswap is a DEX aggregator which sources liquidity from various DEX protocols (including 0x) to offer users better prices.",
5+
"logo": "paraswap.png",
56
"urlSlug": "paraswap",
67
"websiteUrl": "https://paraswap.io",
78
"mappings": [

‎src/apps/logos/0x-api.png

10.4 KB
Loading

‎src/apps/logos/1inch-exchange.png

101 KB
Loading

‎src/apps/logos/defi-saver.png

57.8 KB
Loading

‎src/apps/logos/matcha.png

29.5 KB
Loading

‎src/apps/logos/paraswap.png

3.61 KB
Loading

‎src/apps/sync-app-definitions.js

+6-2
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,9 @@ const transformMappings = mappings =>
3131
const createApp = async definition => {
3232
const App = getModel('App');
3333
const app = {
34-
..._.omit(definition, 'id', 'mappings'),
34+
..._.omit(definition, 'id', 'mappings', 'logo'),
3535
_id: definition.id,
36+
logoUrl: `https://cdn.staticaly.com/gh/0xTracker/0x-tracker-worker/master/src/apps/logos/${definition.logo}`,
3637
mappings: transformMappings(definition.mappings),
3738
};
3839

@@ -53,7 +54,10 @@ const compareMappings = (currentMappings, definitionMappings) => {
5354
};
5455

5556
const updateApp = async (app, definition) => {
56-
const metadata = _.omit(definition, 'id', 'mappings');
57+
const metadata = {
58+
..._.omit(definition, 'id', 'mappings', 'logo'),
59+
logoUrl: `https://cdn.staticaly.com/gh/0xTracker/0x-tracker-worker/master/src/apps/logos/${definition.logo}`,
60+
};
5761

5862
Object.keys(metadata).forEach(metadataKey => {
5963
app.set(metadataKey, metadata[metadataKey]);

‎src/apps/sync-app-definitions.test.js

+35-10
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ describe('apps/syncAppDefinitions', () => {
3838
expect(matcha).toMatchObject({
3939
_id: '5067df8b-f9cd-4a34-aee1-38d607100145',
4040
categories: ['dex-aggregator', 'exchange'],
41-
logoUrl: 'https://resources.0xtracker.com/logos/matcha.png',
41+
logoUrl:
42+
'https://cdn.staticaly.com/gh/0xTracker/0x-tracker-worker/master/src/apps/logos/matcha.png',
4243
mappings: [
4344
{
4445
type: 0,
@@ -60,7 +61,9 @@ describe('apps/syncAppDefinitions', () => {
6061
{
6162
id: '5067df8b-f9cd-4a34-aee1-38d607100145',
6263
name: 'Matcha',
63-
logoUrl: 'https://resources.0xtracker.com/logos/matcha.png',
64+
description:
65+
'Built by the 0x core team – Matcha is a DEX aggregator built on top of 0x API which allows users to easily swap tokens and place limit orders.',
66+
logo: 'matcha.png',
6467
urlSlug: 'matcha',
6568
websiteUrl: 'https://matcha.xyz',
6669
mappings: [
@@ -80,7 +83,10 @@ describe('apps/syncAppDefinitions', () => {
8083
await getModel('App').create({
8184
_id: '5067df8b-f9cd-4a34-aee1-38d607100145',
8285
categories: ['asset-swapper'],
83-
logoUrl: 'https://resources.0xtracker.com/logos/matcha-xyz.png',
86+
description:
87+
'Built by the 0x core team – Matcha is a DEX aggregator built on top of 0x API which allows users to easily swap tokens and place limit orders.',
88+
logoUrl:
89+
'https://cdn.staticaly.com/gh/0xTracker/0x-tracker-worker/master/src/apps/logos/matcha-xyz.png',
8490
mappings: [
8591
{
8692
type: 1,
@@ -105,7 +111,10 @@ describe('apps/syncAppDefinitions', () => {
105111
expect(matcha).toMatchObject({
106112
_id: '5067df8b-f9cd-4a34-aee1-38d607100145',
107113
categories: ['dex-aggregator', 'exchange'],
108-
logoUrl: 'https://resources.0xtracker.com/logos/matcha.png',
114+
description:
115+
'Built by the 0x core team – Matcha is a DEX aggregator built on top of 0x API which allows users to easily swap tokens and place limit orders.',
116+
logoUrl:
117+
'https://cdn.staticaly.com/gh/0xTracker/0x-tracker-worker/master/src/apps/logos/matcha.png',
109118
mappings: [
110119
{
111120
type: 1,
@@ -127,7 +136,9 @@ describe('apps/syncAppDefinitions', () => {
127136
{
128137
id: '5067df8b-f9cd-4a34-aee1-38d607100145',
129138
name: 'Matcha',
130-
logoUrl: 'https://resources.0xtracker.com/logos/matcha.png',
139+
description:
140+
'Built by the 0x core team – Matcha is a DEX aggregator built on top of 0x API which allows users to easily swap tokens and place limit orders.',
141+
logo: 'matcha.png',
131142
urlSlug: 'matcha',
132143
websiteUrl: 'https://matcha.xyz',
133144
mappings: [
@@ -147,7 +158,10 @@ describe('apps/syncAppDefinitions', () => {
147158
await getModel('App').create({
148159
_id: '5067df8b-f9cd-4a34-aee1-38d607100145',
149160
categories: ['dex-aggregator', 'exchange'],
150-
logoUrl: 'https://resources.0xtracker.com/logos/matcha.png',
161+
description:
162+
'Built by the 0x core team – Matcha is a DEX aggregator built on top of 0x API which allows users to easily swap tokens and place limit orders.',
163+
logoUrl:
164+
'https://cdn.staticaly.com/gh/0xTracker/0x-tracker-worker/master/src/apps/logos/matcha.png',
151165
mappings: [
152166
{
153167
type: 1,
@@ -172,7 +186,10 @@ describe('apps/syncAppDefinitions', () => {
172186
expect(matcha).toMatchObject({
173187
_id: '5067df8b-f9cd-4a34-aee1-38d607100145',
174188
categories: ['dex-aggregator', 'exchange'],
175-
logoUrl: 'https://resources.0xtracker.com/logos/matcha.png',
189+
description:
190+
'Built by the 0x core team – Matcha is a DEX aggregator built on top of 0x API which allows users to easily swap tokens and place limit orders.',
191+
logoUrl:
192+
'https://cdn.staticaly.com/gh/0xTracker/0x-tracker-worker/master/src/apps/logos/matcha.png',
176193
mappings: [
177194
{
178195
type: 1,
@@ -194,7 +211,9 @@ describe('apps/syncAppDefinitions', () => {
194211
{
195212
id: '5067df8b-f9cd-4a34-aee1-38d607100145',
196213
name: 'Matcha',
197-
logoUrl: 'https://resources.0xtracker.com/logos/matcha.png',
214+
description:
215+
'Built by the 0x core team – Matcha is a DEX aggregator built on top of 0x API which allows users to easily swap tokens and place limit orders.',
216+
logo: 'matcha.png',
198217
urlSlug: 'matcha',
199218
websiteUrl: 'https://matcha.xyz',
200219
mappings: [
@@ -214,7 +233,10 @@ describe('apps/syncAppDefinitions', () => {
214233
await getModel('App').create({
215234
_id: '5067df8b-f9cd-4a34-aee1-38d607100145',
216235
categories: ['dex-aggregator', 'exchange'],
217-
logoUrl: 'https://resources.0xtracker.com/logos/matcha.png',
236+
description:
237+
'Built by the 0x core team – Matcha is a DEX aggregator built on top of 0x API which allows users to easily swap tokens and place limit orders.',
238+
logoUrl:
239+
'https://cdn.staticaly.com/gh/0xTracker/0x-tracker-worker/master/src/apps/logos/matcha.png',
218240
mappings: [
219241
{
220242
type: 1,
@@ -239,7 +261,10 @@ describe('apps/syncAppDefinitions', () => {
239261
expect(matcha).toMatchObject({
240262
_id: '5067df8b-f9cd-4a34-aee1-38d607100145',
241263
categories: ['dex-aggregator', 'exchange'],
242-
logoUrl: 'https://resources.0xtracker.com/logos/matcha.png',
264+
description:
265+
'Built by the 0x core team – Matcha is a DEX aggregator built on top of 0x API which allows users to easily swap tokens and place limit orders.',
266+
logoUrl:
267+
'https://cdn.staticaly.com/gh/0xTracker/0x-tracker-worker/master/src/apps/logos/matcha.png',
243268
mappings: [
244269
{
245270
type: 1,

‎src/apps/validate-app-definition.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,12 @@ const schema = Joi.object({
1616
)
1717
.unique()
1818
.required(),
19+
description: Joi.string().required(),
1920
id: Joi.string()
2021
.uuid({ version: ['uuidv4'] })
2122
.id()
2223
.required(),
23-
logoUrl: Joi.string().uri({ scheme: 'https' }),
24+
logo: Joi.string().required(),
2425
mappings: Joi.array()
2526
.items(
2627
Joi.object({

‎src/model/app.js

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ const mongoose = require('mongoose');
33
const schema = mongoose.Schema({
44
_id: { required: true, type: String },
55
categories: [{ required: true, type: String }],
6+
description: { required: true, type: String },
67
logoUrl: { required: true, type: String },
78
mappings: [
89
{

0 commit comments

Comments
 (0)