@subwallet/extension-base 1.1.17-0 → 1.1.18-1

package/services/campaign-service/index.js

@@ -0,0 +1,134 @@
+// Copyright 2019-2022 @subwallet/extension-base authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { CampaignDataType } from '@subwallet/extension-base/background/KoniTypes';
+import { MARKETING_CAMPAIGN_URL } from '@subwallet/extension-base/constants';
+import { TARGET_ENV } from '@subwallet/extension-base/utils';
+import axios from 'axios';
+import { runCampaign } from "./helpers.js";
+export default class CampaignService {
+  #state;
+  constructor(state) {
+    this.#state = state;
+    this.fetchCampaign().catch(e => {
+      console.error('Error on fetch campaigns', e);
+    });
+    this.runCampaign().catch(e => {
+      console.error('Error on run campaigns', e);
+    });
+  }
+  async fetchCampaign() {
+    const response = await axios.request({
+      method: 'GET',
+      url: MARKETING_CAMPAIGN_URL
+    });
+    const respData = response.data;
+    const campaigns = [];
+    for (const data of respData) {
+      // eslint-disable-next-line camelcase
+      const {
+        condition,
+        end_time,
+        id: campaignId,
+        start_time
+      } = data;
+      const endTime = new Date(end_time).getTime();
+      const startTime = new Date(start_time).getTime();
+      for (const banner of data.banners) {
+        const {
+          buttons,
+          id,
+          ...baseData
+        } = banner;
+        const slug = `${campaignId}-banner-${id}`;
+        if (banner.environments.includes(TARGET_ENV)) {
+          campaigns.push({
+            slug,
+            endTime,
+            startTime,
+            isDone: false,
+            campaignId,
+            type: CampaignDataType.BANNER,
+            buttons,
+            data: baseData,
+            condition
+          });
+        }
+      }
+      for (const notification of data.notifications) {
+        const {
+          buttons,
+          id,
+          ...baseData
+        } = notification;
+        const slug = `${campaignId}-notification-${id}`;
+        campaigns.push({
+          slug,
+          endTime,
+          startTime,
+          isDone: false,
+          campaignId,
+          type: CampaignDataType.NOTIFICATION,
+          buttons,
+          data: baseData,
+          condition
+        });
+      }
+    }
+    for (const campaign of campaigns) {
+      const exists = await this.#state.dbService.getCampaign(campaign.slug);
+      if (!exists) {
+        await this.#state.dbService.upsertCampaign(campaign);
+      }
+    }
+    this.#state.eventService.emit('campaign.ready', true);
+  }
+  async runCampaign() {
+    await this.#state.eventService.waitCampaignReady;
+    const campaigns = (await this.getProcessingCampaign()).filter(data => data.type === CampaignDataType.NOTIFICATION);
+    campaigns.forEach(campaign => {
+      const {
+        isDone,
+        slug,
+        type
+      } = campaign;
+      if (isDone) {
+        return;
+      }
+      const onComplete = () => {
+        this.completeCampaignNotification(slug).catch(e => {
+          console.error('Error when complete campaign', slug, e);
+        });
+      };
+      try {
+        switch (type) {
+          case CampaignDataType.NOTIFICATION:
+            {
+              runCampaign(this.#state.notificationService, campaign);
+              onComplete();
+              break;
+            }
+          default:
+            throw new Error('Missing handle campaign');
+        }
+      } catch (e) {
+        console.error('Error on running campaigns', slug, e);
+      }
+    });
+  }
+  getProcessingCampaign() {
+    return this.#state.dbService.getProcessingCampaign();
+  }
+  subscribeProcessingCampaign() {
+    return this.#state.dbService.subscribeProcessingCampaign();
+  }
+  async completeCampaignNotification(slug) {
+    const campaign = await this.#state.dbService.getCampaign(slug);
+    if (campaign) {
+      await this.#state.dbService.upsertCampaign({
+        ...campaign,
+        isDone: true
+      });
+    }
+  }
+}

package/services/campaign-service/types.d.ts

@@ -0,0 +1,34 @@
+import { CampaignAction, CampaignButton } from '@subwallet/extension-base/background/KoniTypes';
+declare type Metadata = Record<string, any> | null;
+interface _BannerData {
+    id: number;
+    alt: string;
+    action: CampaignAction;
+    metadata: Metadata;
+    environments: string[];
+    position: string[];
+    buttons: CampaignButton[];
+    media: string;
+}
+interface _NotificationData {
+    id: number;
+    title: string;
+    message: string;
+    repeat: number;
+    repeatAfter: number;
+    action: CampaignAction;
+    metadata: Metadata;
+    buttons: CampaignButton[];
+}
+interface _CampaignData {
+    id: number;
+    name: string;
+    description: null;
+    start_time: string;
+    end_time: string;
+    condition: Metadata;
+    banners: _BannerData[];
+    notifications: _NotificationData[];
+}
+export declare type ListCampaignResponse = _CampaignData[];
+export {};

package/services/campaign-service/types.js

@@ -0,0 +1 @@
+export {};

package/services/event-service/index.d.ts

@@ -11,6 +11,8 @@ export declare class EventService extends EventEmitter<EventRegistry> {
     readonly waitAccountReady: Promise<boolean>;
     readonly waitChainReady: Promise<boolean>;
     readonly waitAssetReady: Promise<boolean>;
+    readonly waitMigrateReady: Promise<boolean>;
+    readonly waitCampaignReady: Promise<boolean>;
     constructor(options?: {
         lazyTime: number;
     });

package/services/event-service/index.js

@@ -19,6 +19,8 @@ export class EventService extends EventEmitter {
     this.waitAccountReady = this.generateWaitPromise('account.ready');
     this.waitChainReady = this.generateWaitPromise('chain.ready');
     this.waitAssetReady = this.generateWaitPromise('asset.ready');
+    this.waitMigrateReady = this.generateWaitPromise('migration.done');
+    this.waitCampaignReady = this.generateWaitPromise('campaign.ready');
   }
   generateWaitPromise(eventType) {
     return new Promise(resolve => {

package/services/event-service/types.d.ts

@@ -23,6 +23,8 @@ export interface EventRegistry {
     'mantaPay.initSync': [string | undefined];
     'mantaPay.submitTransaction': [SWTransaction | undefined];
     'mantaPay.enable': [string];
+    'migration.done': [boolean];
+    'campaign.ready': [boolean];
 }
 export declare type EventType = keyof EventRegistry;
 export declare const COMMON_RELOAD_EVENTS: EventType[];

package/services/migration-service/index.d.ts

@@ -1,7 +1,9 @@
 import State from '@subwallet/extension-base/koni/background/handlers/State';
+import { EventService } from '@subwallet/extension-base/services/event-service';
 export default class MigrationService {
+    #private;
     readonly state: State;
     private logger;
-    constructor(state: State);
+    constructor(state: State, eventService: EventService);
     run(): Promise<void>;
 }

package/services/migration-service/index.js

@@ -4,8 +4,10 @@
 import { logger as createLogger } from '@polkadot/util';
 import MigrationScripts, { EVERYTIME } from "./scripts/index.js";
 export default class MigrationService {
-  constructor(state) {
+  #eventService;
+  constructor(state, eventService) {
     this.state = state;
+    this.#eventService = eventService;
     this.logger = createLogger('Migration');
   }
   async run() {
@@ -32,5 +34,6 @@ export default class MigrationService {
         this.logger.error('Migration error: ', MigrationScripts[keys[i]].name, error);
       }
     }
+    this.#eventService.emit('migration.done', true);
   }
 }

package/services/notification-service/NotificationService.d.ts

@@ -1,8 +1,8 @@
-import { Notification, NotificationParams } from '@subwallet/extension-base/background/KoniTypes';
+import { Notification, NotificationButton, NotificationParams } from '@subwallet/extension-base/background/KoniTypes';
 import { BehaviorSubject } from 'rxjs';
 export default class NotificationService {
     private notificationSubject;
     getNotificationSubject(): BehaviorSubject<Notification[]>;
     notify(notification: NotificationParams): void;
-    static createBrowserNotification(title: string, message: string, link?: string): void;
+    static createBrowserNotification(title: string, message: string, action?: NotificationParams['action'], buttons?: NotificationButton[]): void;
 }

package/services/notification-service/NotificationService.js

@@ -19,26 +19,40 @@ export default class NotificationService {
     });
     this.notificationSubject.next(notifications);
     if (notification.notifyViaBrowser) {
-      var _notification$action;
-      NotificationService.createBrowserNotification(notification.title, notification.message, notification === null || notification === void 0 ? void 0 : (_notification$action = notification.action) === null || _notification$action === void 0 ? void 0 : _notification$action.url);
+      NotificationService.createBrowserNotification(notification.title, notification.message, notification.action, notification.buttons);
     }
   }
 
   // Create a new chrome notification with link
-  static createBrowserNotification(title, message, link) {
+  static createBrowserNotification(title, message, action, buttons) {
     var _chrome, _chrome$notifications;
+    const link = action === null || action === void 0 ? void 0 : action.url;
+    const onClick = action === null || action === void 0 ? void 0 : action.click;
+    const onButtonClick = action === null || action === void 0 ? void 0 : action.buttonClick;
     (_chrome = chrome) === null || _chrome === void 0 ? void 0 : (_chrome$notifications = _chrome.notifications) === null || _chrome$notifications === void 0 ? void 0 : _chrome$notifications.create({
       type: 'basic',
       title,
       message,
       iconUrl: './images/icon-128.png',
       priority: 2,
-      isClickable: !!link
+      isClickable: !!link || !!onClick,
+      buttons
     }, notificationId => {
-      if (link) {
+      if (link || onClick) {
         chrome.notifications.onClicked.addListener(nId => {
           if (nId === notificationId) {
-            window.open(link);
+            if (onClick) {
+              onClick();
+            } else {
+              window.open(link);
+            }
+          }
+        });
+      }
+      if (onButtonClick) {
+        chrome.notifications.onButtonClicked.addListener((nId, btnIndex) => {
+          if (nId === notificationId) {
+            onButtonClick(btnIndex);
           }
         });
       }

package/services/storage-service/DatabaseService.d.ts

@@ -1,8 +1,9 @@
 import { _ChainAsset } from '@subwallet/chain-list/types';
 import { BalanceItem, ChainStakingMetadata, CrowdloanItem, MantaPayConfig, NftCollection, NftItem, NominatorMetadata, PriceJson, StakingItem, StakingType, TransactionHistoryItem } from '@subwallet/extension-base/background/KoniTypes';
 import { EventService } from '@subwallet/extension-base/services/event-service';
-import { IBalance, IChain, INft } from '@subwallet/extension-base/services/storage-service/databases';
+import { IBalance, ICampaign, IChain, INft } from '@subwallet/extension-base/services/storage-service/databases';
 import { AssetStore, BalanceStore, ChainStore, CrowdloanStore, MetadataStore, MigrationStore, NftCollectionStore, NftStore, PriceStore, StakingStore, TransactionStore } from '@subwallet/extension-base/services/storage-service/db-stores';
+import CampaignStore from '@subwallet/extension-base/services/storage-service/db-stores/Campaign';
 import ChainStakingMetadataStore from '@subwallet/extension-base/services/storage-service/db-stores/ChainStakingMetadata';
 import MantaPayStore from '@subwallet/extension-base/services/storage-service/db-stores/MantaPay';
 import NominatorMetadataStore from '@subwallet/extension-base/services/storage-service/db-stores/NominatorMetadata';
@@ -26,6 +27,7 @@ export default class DatabaseService {
         chainStakingMetadata: ChainStakingMetadataStore;
         nominatorMetadata: NominatorMetadataStore;
         mantaPay: MantaPayStore;
+        campaign: CampaignStore;
     };
     private logger;
     private nftSubscription;
@@ -77,4 +79,8 @@ export default class DatabaseService {
     subscribeMantaPayConfig(chain: string, callback: (data: MantaPayConfig[]) => void): void;
     getMantaPayConfig(chain: string): Promise<any[]>;
     getMantaPayFirstConfig(chain: string): Promise<any>;
+    subscribeProcessingCampaign(): import("dexie").Observable<import("@subwallet/extension-base/background/KoniTypes").CampaignData[]>;
+    getProcessingCampaign(): Promise<import("@subwallet/extension-base/background/KoniTypes").CampaignData[]>;
+    getCampaign(slug: string): Promise<import("@subwallet/extension-base/background/KoniTypes").CampaignData | undefined>;
+    upsertCampaign(campaign: ICampaign): import("dexie").PromiseExtended<unknown>;
 }

package/services/storage-service/DatabaseService.js

@@ -4,6 +4,7 @@
 import { APIItemState, StakingType } from '@subwallet/extension-base/background/KoniTypes';
 import KoniDatabase from '@subwallet/extension-base/services/storage-service/databases';
 import { AssetStore, BalanceStore, ChainStore, CrowdloanStore, MetadataStore, MigrationStore, NftCollectionStore, NftStore, PriceStore, StakingStore, TransactionStore } from '@subwallet/extension-base/services/storage-service/db-stores';
+import CampaignStore from '@subwallet/extension-base/services/storage-service/db-stores/Campaign';
 import ChainStakingMetadataStore from '@subwallet/extension-base/services/storage-service/db-stores/ChainStakingMetadata';
 import MantaPayStore from '@subwallet/extension-base/services/storage-service/db-stores/MantaPay';
 import NominatorMetadataStore from '@subwallet/extension-base/services/storage-service/db-stores/NominatorMetadata';
@@ -34,7 +35,8 @@ export default class DatabaseService {
       // staking
       chainStakingMetadata: new ChainStakingMetadataStore(this._db.chainStakingMetadata),
       nominatorMetadata: new NominatorMetadataStore(this._db.nominatorMetadata),
-      mantaPay: new MantaPayStore(this._db.mantaPay)
+      mantaPay: new MantaPayStore(this._db.mantaPay),
+      campaign: new CampaignStore(this._db.campaign)
     };
   }
   async updatePriceStore(priceData) {
@@ -262,4 +264,19 @@ export default class DatabaseService {
   async getMantaPayFirstConfig(chain) {
     return this.stores.mantaPay.getFirstConfig(chain);
   }
+
+  /* Campaign */
+
+  subscribeProcessingCampaign() {
+    return this.stores.campaign.subscribeProcessingCampaign();
+  }
+  getProcessingCampaign() {
+    return this.stores.campaign.getProcessingCampaign();
+  }
+  getCampaign(slug) {
+    return this.stores.campaign.getCampaign(slug);
+  }
+  upsertCampaign(campaign) {
+    return this.stores.campaign.upsertCampaign(campaign);
+  }
 }

package/services/storage-service/databases/index.d.ts

@@ -1,5 +1,5 @@
 import { _ChainAsset, _ChainInfo } from '@subwallet/chain-list/types';
-import { BalanceItem, ChainStakingMetadata, CrowdloanItem, MetadataItem, NftCollection, NftItem, NominatorMetadata, PriceJson, StakingItem, TransactionHistoryItem } from '@subwallet/extension-base/background/KoniTypes';
+import { BalanceItem, CampaignData, ChainStakingMetadata, CrowdloanItem, MetadataItem, NftCollection, NftItem, NominatorMetadata, PriceJson, StakingItem, TransactionHistoryItem } from '@subwallet/extension-base/background/KoniTypes';
 import Dexie, { Table } from 'dexie';
 export interface DefaultChainDoc {
     chain: string;
@@ -29,6 +29,7 @@ export interface IMigration {
 export interface IMetadataItem extends MetadataItem, DefaultChainDoc {
 }
 export declare type IMantaPayLedger = any;
+export declare type ICampaign = CampaignData;
 export default class KoniDatabase extends Dexie {
     price: Table<PriceJson, object>;
     balances: Table<IBalance, object>;
@@ -44,6 +45,7 @@ export default class KoniDatabase extends Dexie {
     chainStakingMetadata: Table<ChainStakingMetadata, object>;
     nominatorMetadata: Table<NominatorMetadata, object>;
     mantaPay: Table<IMantaPayLedger, object>;
+    campaign: Table<ICampaign, object>;
     private schemaVersion;
     constructor(name?: string, schemaVersion?: number);
     private conditionalVersion;

package/services/storage-service/databases/index.js

@@ -30,6 +30,9 @@ export default class KoniDatabase extends Dexie {
     this.conditionalVersion(3, {
       mantaPay: 'key, chain'
     });
+    this.conditionalVersion(4, {
+      campaign: 'slug'
+    });
   }
   conditionalVersion(version, schema, upgrade) {
     if (this.schemaVersion != null && this.schemaVersion < version) {

package/services/storage-service/db-stores/Campaign.d.ts

@@ -0,0 +1,9 @@
+import { ICampaign } from '@subwallet/extension-base/services/storage-service/databases';
+import BaseStore from '@subwallet/extension-base/services/storage-service/db-stores/BaseStore';
+export default class CampaignStore extends BaseStore<ICampaign> {
+    getAll(): Promise<import("../../../background/KoniTypes").CampaignData[]>;
+    getCampaign(slug: string): Promise<import("../../../background/KoniTypes").CampaignData | undefined>;
+    getProcessingCampaign(): Promise<import("../../../background/KoniTypes").CampaignData[]>;
+    subscribeProcessingCampaign(): import("dexie").Observable<import("../../../background/KoniTypes").CampaignData[]>;
+    upsertCampaign(campaign: ICampaign): import("dexie").PromiseExtended<unknown>;
+}

package/services/storage-service/db-stores/Campaign.js

@@ -0,0 +1,27 @@
+// Copyright 2019-2022 @subwallet/extension-base authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import BaseStore from '@subwallet/extension-base/services/storage-service/db-stores/BaseStore';
+import { liveQuery } from 'dexie';
+const filterProcessing = campaign => {
+  const now = new Date().getTime();
+  const isExpired = now <= campaign.startTime || now >= campaign.endTime;
+  return !(campaign.isDone || isExpired);
+};
+export default class CampaignStore extends BaseStore {
+  async getAll() {
+    return this.table.toArray();
+  }
+  async getCampaign(slug) {
+    return this.table.get(slug);
+  }
+  async getProcessingCampaign() {
+    return (await this.table.toArray()).filter(filterProcessing);
+  }
+  subscribeProcessingCampaign() {
+    return liveQuery(() => this.table.filter(filterProcessing).toArray());
+  }
+  upsertCampaign(campaign) {
+    return this.table.put(campaign);
+  }
+}