@docknetwork/wallet-sdk-data-store 0.4.19 → 0.4.22

package/src/entities/network.entity.ts

@@ -1,14 +0,0 @@
-import {Entity, Column, PrimaryColumn} from '../typeorm';
-import {ContextProps} from '../types';
-
-@Entity()
-export class NetworkEntity {
-  @PrimaryColumn()
-  id: string;
-
-  @Column()
-  name: string;
-
-  @Column()
-  configs: string;
-}

package/src/entities/transaction.entity.ts

@@ -1,67 +0,0 @@
-import { Entity, Column, PrimaryColumn } from 'typeorm';
-import { DataStore } from '../types';
-
-@Entity()
-export class TransactionEntity {
-  @PrimaryColumn()
-  id: string;
-
-  @Column({ nullable: true })
-  hash: string;
-
-  @Column({ default: 'transfer' })
-  type: string;
-
-  @Column({ nullable: true })
-  error: string;
-
-  @Column({ nullable: true })
-  metadata: string;
-
-  @Column()
-  date: Date;
-
-  @Column()
-  fromAddress: string;
-
-  @Column()
-  recipientAddress: string;
-
-  @Column({ nullable: true })
-  amount: string;
-
-  @Column()
-  feeAmount: string;
-
-  @Column({ default: 'testnet' })
-  network: string;
-
-  @Column()
-  status: string;
-
-  @Column({ default: false })
-  retrySucceeded: boolean;
-}
-
-export async function getLogs({
-  dataStore,
-}: {
-  dataStore: DataStore;
-}): Promise<TransactionEntity[]> {
-  const repository = dataStore.db.getRepository(TransactionEntity);
-  const entities = await repository.find({});
-
-  return entities;
-}
-
-export async function createTransaction({
-  dataStore,
-  transaction,
-}: {
-  dataStore: DataStore;
-  transaction: TransactionEntity,
-}): Promise<TransactionEntity> {
-  const repository = dataStore.db.getRepository(TransactionEntity);
-
-  return repository.save(transaction);
-}

package/src/entities/wallet.entity.ts

@@ -1,37 +0,0 @@
-import {Entity, Column, PrimaryGeneratedColumn, PrimaryColumn} from '../typeorm';
-import {ContextProps} from '../types';
-
-@Entity()
-export class WalletEntity {
-  @PrimaryColumn()
-  id: string;
-
-  @Column({
-    nullable: true,
-  })
-  version?: string;
-
-  @Column()
-  networkId: string;
-}
-
-export async function getWallet({
-  dataStore,
-}: ContextProps): Promise<WalletEntity> {
-  const result = await dataStore.db.getRepository(WalletEntity).find();
-  return result[0];
-}
-
-export function createWallet({dataStore}: ContextProps): Promise<WalletEntity> {
-  return dataStore.db.getRepository(WalletEntity).save({
-    id: 'configs',
-    ...dataStore,
-  });
-}
-
-export function updateWallet({dataStore}: ContextProps): Promise<WalletEntity> {
-  return dataStore.db.getRepository(WalletEntity).save({
-    id: 'configs',
-    ...dataStore,
-  });
-}

package/src/migration/bootstrap-tables.ts

@@ -1,5 +0,0 @@
-import {DataSource} from '../typeorm';
-
-export function bootstrapTables(dataSource: DataSource) {
-  // will be generated from typeorm once the schema is defined
-}

package/src/migration/index.ts

@@ -1,53 +0,0 @@
-import {isRunningOnV1DataStore, migration1} from './migration1';
-import {ContextProps} from '../types';
-import {logger} from '../logger';
-import {createWallet, getWallet, updateWallet} from '../entities/wallet.entity';
-import {bootstrapTables} from './bootstrap-tables';
-
-export const CURRENT_DATA_STORE_VERSION = 'v2';
-
-export type MigrationResult = {
-  migrated: boolean;
-  version: string;
-};
-
-const migrations = [
-  migration1,
-  // add new migrations here
-];
-
-export async function migrate({dataStore}: ContextProps) {
-  // bootstrap v2 data
-  await bootstrapTables(dataStore.db);
-
-  // Fetch existing configs from the database
-  let existingConfigs = await getWallet({dataStore});
-
-  // Force v1 migration
-  // dataStore.version = 'v1';
-  // If no configs exist, create a new one
-  if (!existingConfigs) {
-    logger.debug('Wallet not found in the database, creating a new wallet...');
-    const isV1DataStore = await isRunningOnV1DataStore({dataStore});
-    logger.debug(`Is v1 data store: ${isV1DataStore}`);
-    dataStore.version = isV1DataStore ? 'v1' : CURRENT_DATA_STORE_VERSION;
-    await createWallet({
-      dataStore,
-    });
-    logger.debug('universal wallet created');
-  }
-
-  for (const migrate of migrations) {
-    const results = await migrate({dataStore});
-
-    if (results.migrated) {
-      logger.debug('Migration completed');
-      dataStore.version = results.version;
-      await updateWallet({dataStore});
-    } else {
-      logger.debug('Migration not required');
-    }
-  }
-
-  logger.debug(`DataStore version: ${dataStore.version}`);
-}

package/src/migration/migration1/index.ts

@@ -1,64 +0,0 @@
-import {getV1LocalStorage, getWalletDocuments} from './v1-data-store';
-import {logger} from '../../logger';
-import {migrateV1Data} from './migrate-v1-data';
-import {MigrationResult} from '../index';
-import {ContextProps} from '../../types';
-
-/**
- * Migrate from v1 to v2
- *
- * v1 data store is stored in local storage
- * v2 will store on typeorm
- *
- */
-export async function migration1({
-  dataStore,
-}: ContextProps): Promise<MigrationResult> {
-  logger.debug('Checking if v1 migration is required');
-
-  if (dataStore.version !== 'v1') {
-    logger.debug('v1 data migration NOT required');
-    return {
-      migrated: false,
-      version: dataStore.version,
-    };
-  }
-
-  logger.debug('v1 data Migration required');
-
-  await migrateV1Data({dataStore});
-
-  return {
-    migrated: true,
-    version: 'v2',
-  };
-}
-
-/**
- * Check if a migration from v2 is required
- * Once v2 is migrated, the local storage entry will be removed
- */
-export async function isRunningOnV1DataStore({
-  dataStore,
-}: ContextProps): Promise<boolean> {
-  // If sdk version is defined, can skip migration
-  if (dataStore.version) {
-    return false;
-  }
-
-  const v1LocalStorage = getV1LocalStorage();
-
-  if (!v1LocalStorage) {
-    logger.debug('v1 local storage not found');
-    return false;
-  }
-
-  const documents = await getWalletDocuments();
-
-  if (documents.length === 0) {
-    logger.debug('no documents found on v1 data store');
-    return false;
-  }
-
-  return true;
-}

package/src/migration/migration1/migrate-v1-data.ts

@@ -1,57 +0,0 @@
-import {getV1LocalStorage} from './v1-data-store';
-import {createDocument} from '../../entities/document';
-import {documentHasType} from '../../helpers';
-
-export async function importUniversalWalletDocuments({documents, dataStore}) {
-  for (const _document of documents) {
-    let document = _document;
-    if (documentHasType(document, 'VerifiableCredential') && document.value) {
-      document = document.value;
-    }
-
-    try {
-      await createDocument({
-        dataStore,
-        json: document,
-      });
-    } catch (err) {
-      console.error(err);
-    }
-  }
-}
-async function migrateDocuments({v1Storage, dataStore}) {
-  const walletJSON = await v1Storage.getItem('wallet');
-  const wallet = JSON.parse(walletJSON);
-
-  const documents = Object.keys(wallet).map(key => wallet[key]);
-
-  await importUniversalWalletDocuments({documents, dataStore});
-}
-
-function migrateNotificaions() {}
-
-function migrateDevSettings() {}
-
-function migrateTransactions() {
-  // Will skip this migration for performance improvements
-  // That would require Realm db as dependency
-  // We can drop the realm.db dependency from the wallet-sdk
-  // Transactions will be pulled from subscan into in the new data-store automatically
-}
-
-export async function migrateV1Data({dataStore}) {
-  const v1Storage = getV1LocalStorage();
-
-  await migrateDocuments({
-    v1Storage,
-    dataStore,
-  });
-  await migrateNotificaions();
-  await migrateDevSettings();
-  await migrateTransactions();
-
-  // remove localStorage entries
-  const walletJSON = await v1Storage.getItem('wallet');
-  await v1Storage.setItem('wallet-backup', walletJSON);
-  await v1Storage.removeItem('wallet');
-}

package/src/migration/migration1/v1-data-store.ts

@@ -1,39 +0,0 @@
-import assert from 'assert';
-
-export type LocalStorage = {
-  getItem: (key: string) => Promise<string | null>;
-  setItem: (key: string, value: string) => Promise<void>;
-  removeItem: (key: string) => Promise<void>;
-};
-
-let _localStorage: LocalStorage;
-
-/**
- * Legacy data-store was based on AsyncLocalStorage
- * The wallet will inject its implementation here, so that the migration scripts can use it
- *
- * @param _impl
- */
-export function setV1LocalStorage(_impl: LocalStorage) {
-  assert(!!_impl, 'LocalStorage implementation is required');
-
-  _localStorage = _impl;
-}
-
-export function getV1LocalStorage(): LocalStorage {
-  return _localStorage;
-}
-
-export async function getWalletDocuments() {
-  const jsonData = await _localStorage.getItem('wallet');
-
-  if (!jsonData) {
-    return [];
-  }
-
-  const wallet = JSON.parse(jsonData as string);
-
-  return Object.keys(wallet).map(key => {
-    return wallet[key];
-  });
-}

package/src/migrations/1691498362273-bootstrap.ts

@@ -1,130 +0,0 @@
-import {
-  MigrationInterface,
-  QueryRunner,
-  Table,
-  TableColumn,
-  TableForeignKey,
-  TableIndex,
-} from 'typeorm';
-import { logger } from '../logger';
-
-export class Bootstrap1691498362273 implements MigrationInterface {
-  name = 'Bootstrap1691498362273';
-
-  public async up(queryRunner: QueryRunner): Promise<void> {
-    const hasNetworkEntityTable = await queryRunner.hasTable('network_entity');
-
-    if (hasNetworkEntityTable) {
-      logger.debug('Table already bootstrapped');
-      return;
-    }
-
-    logger.debug('Running table bootstrap migration');
-
-    await queryRunner.createTable(
-      new Table({
-        name: 'network_entity',
-        columns: [
-          new TableColumn({name: 'id', type: 'varchar', isPrimary: true}),
-          new TableColumn({name: 'name', type: 'varchar'}),
-          new TableColumn({name: 'configs', type: 'varchar'}),
-        ],
-      }),
-    );
-
-    await queryRunner.createTable(
-      new Table({
-        name: 'document_type_entity',
-        columns: [new TableColumn({name: 'id', type: 'text', isPrimary: true})],
-      }),
-    );
-
-    await queryRunner.createTable(
-      new Table({
-        name: 'document_entity',
-        columns: [
-          new TableColumn({name: 'id', type: 'text', isPrimary: true}),
-          new TableColumn({name: 'networkId', type: 'text', isNullable: true}),
-          new TableColumn({name: 'type', type: 'text'}),
-          new TableColumn({name: 'correlation', type: 'text'}),
-          new TableColumn({name: 'data', type: 'blob'}),
-        ],
-      }),
-    );
-
-    await queryRunner.createTable(
-      new Table({
-        name: 'wallet_entity',
-        columns: [
-          new TableColumn({name: 'id', type: 'varchar', isPrimary: true}),
-          new TableColumn({name: 'version', type: 'varchar', isNullable: true}),
-          new TableColumn({name: 'networkId', type: 'varchar'}),
-        ],
-      }),
-    );
-
-    await queryRunner.createTable(
-      new Table({
-        name: 'document_entity__type_rel_document_type_entity',
-        columns: [
-          new TableColumn({
-            name: 'documentEntityId',
-            type: 'text',
-            isPrimary: true,
-          }),
-          new TableColumn({
-            name: 'documentTypeEntityId',
-            type: 'text',
-            isPrimary: true,
-          }),
-        ],
-        foreignKeys: [
-          new TableForeignKey({
-            columnNames: ['documentEntityId'],
-            referencedColumnNames: ['id'],
-            referencedTableName: 'document_entity',
-            onDelete: 'CASCADE',
-            onUpdate: 'CASCADE',
-          }),
-          new TableForeignKey({
-            columnNames: ['documentTypeEntityId'],
-            referencedColumnNames: ['id'],
-            referencedTableName: 'document_type_entity',
-            onDelete: 'NO ACTION',
-            onUpdate: 'NO ACTION',
-          }),
-        ],
-      }),
-    );
-
-    await queryRunner.createIndex(
-      'document_entity__type_rel_document_type_entity',
-      new TableIndex({
-        name: 'IDX_e929f32563f62d753a51bcd8b9',
-        columnNames: ['documentEntityId'],
-      }),
-    );
-
-    await queryRunner.createIndex(
-      'document_entity__type_rel_document_type_entity',
-      new TableIndex({
-        name: 'IDX_7d377ef9ddb323247aedd63d66',
-        columnNames: ['documentTypeEntityId'],
-      }),
-    );
-
-    logger.debug('Table bootstrap migration completed');
-  }
-
-  public async down(queryRunner: QueryRunner): Promise<void> {
-    logger.debug('Running table bootstrap migration revert');
-    await queryRunner.dropTable(
-      'document_entity__type_rel_document_type_entity',
-    );
-    await queryRunner.dropTable('wallet_entity');
-    await queryRunner.dropTable('document_entity');
-    await queryRunner.dropTable('document_type_entity');
-    await queryRunner.dropTable('network_entity');
-    logger.debug('Revert completed');
-  }
-}

package/src/migrations/index.ts

@@ -1,3 +0,0 @@
-import {Bootstrap1691498362273} from './1691498362273-bootstrap';
-
-export default [Bootstrap1691498362273];

package/src/migrations-data-source.ts

@@ -1,6 +0,0 @@
-import {getDataSource} from './helpers';
-
-export default getDataSource({
-  dbType: 'sqlite',
-  databasePath: 'data-store.sqlite',
-});

package/src/typeorm.ts

@@ -1 +0,0 @@
-export * from 'typeorm';