@subql/common-stellar 2.3.1-0 → 2.3.2-0

package/src/project/load.ts

@@ -1,9 +1,6 @@
 // Copyright 2020-2023 SubQuery Pte Ltd authors & contributors
 // SPDX-License-Identifier: GPL-3.0
 
-import fs from 'fs';
-import path from 'path';
-import {loadFromJsonOrYaml} from '@subql/common';
 import {StellarProjectManifestVersioned, VersionedProjectManifest} from './versioned';
 
 export function parseStellarProjectManifest(raw: unknown): StellarProjectManifestVersioned {
@@ -11,23 +8,3 @@ export function parseStellarProjectManifest(raw: unknown): StellarProjectManifes
   projectManifest.validate();
   return projectManifest;
 }
-
-export function loadStellarProjectManifest(file: string): StellarProjectManifestVersioned {
-  let manifestPath = file;
-  if (fs.existsSync(file) && fs.lstatSync(file).isDirectory()) {
-    const yamlFilePath = path.join(file, 'project.yaml');
-    const jsonFilePath = path.join(file, 'project.json');
-    if (fs.existsSync(yamlFilePath)) {
-      manifestPath = yamlFilePath;
-    } else if (fs.existsSync(jsonFilePath)) {
-      manifestPath = jsonFilePath;
-    } else {
-      throw new Error(`Could not find project manifest under dir ${file}`);
-    }
-  }
-
-  const doc = loadFromJsonOrYaml(manifestPath);
-  const projectManifest = new StellarProjectManifestVersioned(doc as VersionedProjectManifest);
-  projectManifest.validate();
-  return projectManifest;
-}

package/src/project/models.ts

@@ -1,7 +1,8 @@
 // Copyright 2020-2023 SubQuery Pte Ltd authors & contributors
 // SPDX-License-Identifier: GPL-3.0
 
-import {forbidNonWhitelisted} from '@subql/common';
+import {forbidNonWhitelisted, ProcessorImpl} from '@subql/common';
+import {Processor, FileReference} from '@subql/types-core';
 import {
   StellarHandlerKind,
   StellarDatasourceKind,
@@ -12,7 +13,6 @@ import {
   SubqlRuntimeHandler,
   SubqlRuntimeDatasource,
   SubqlCustomDatasource,
-  FileReference,
   CustomDataSourceAsset,
   StellarBlockFilter,
   StellarTransactionFilter,
@@ -76,6 +76,7 @@ export class BlockHandler implements SubqlBlockHandler {
 }
 
 export class TransactionHandler implements SubqlTransactionHandler {
+  @forbidNonWhitelisted({account: ''})
   @IsObject()
   @IsOptional()
   @Type(() => TransactionFilter)
@@ -87,6 +88,7 @@ export class TransactionHandler implements SubqlTransactionHandler {
 }
 
 export class SorobanTransactionHandler implements SubqlSorobanTransactionHandler {
+  @forbidNonWhitelisted({account: ''})
   @IsObject()
   @IsOptional()
   @Type(() => TransactionFilter)
@@ -98,6 +100,7 @@ export class SorobanTransactionHandler implements SubqlSorobanTransactionHandler
 }
 
 export class OperationHandler implements SubqlOperationHandler {
+  @forbidNonWhitelisted({type: '', sourceAccount: ''})
   @IsObject()
   @IsOptional()
   @Type(() => OperationFilter)
@@ -109,6 +112,7 @@ export class OperationHandler implements SubqlOperationHandler {
 }
 
 export class EffectHandler implements SubqlEffectHandler {
+  @forbidNonWhitelisted({type: '', account: ''})
   @IsObject()
   @IsOptional()
   @Type(() => EffectFilter)
@@ -221,8 +225,8 @@ export class FileReferenceImpl implements FileReference {
   file: string;
 }
 
-export class CustomDataSourceBase<K extends string, M extends SubqlMapping = SubqlMapping<SubqlCustomHandler>>
-  implements SubqlCustomDatasource<K, M>
+export class CustomDataSourceBase<K extends string, M extends SubqlMapping = SubqlMapping<SubqlCustomHandler>, O = any>
+  implements SubqlCustomDatasource<K, M, O>
 {
   @IsString()
   kind: K;
@@ -235,9 +239,9 @@ export class CustomDataSourceBase<K extends string, M extends SubqlMapping = Sub
   @Type(() => FileReferenceImpl)
   @ValidateNested({each: true})
   assets: Map<string, CustomDataSourceAsset>;
-  @Type(() => FileReferenceImpl)
+  @Type(() => ProcessorImpl)
   @IsObject()
-  processor: FileReference;
+  processor: Processor<O>;
   @IsOptional()
   @ValidateNested()
   options?: StellarProcessorOptions;

package/src/project/project.spec.ts

@@ -1,14 +1,35 @@
 // Copyright 2020-2023 SubQuery Pte Ltd authors & contributors
 // SPDX-License-Identifier: GPL-3.0
 
+import fs from 'fs';
 import path from 'path';
-import {RunnerQueryBaseModel} from '@subql/common';
+import {RunnerQueryBaseModel, loadFromJsonOrYaml} from '@subql/common';
 import {validateSync} from 'class-validator';
 import {DeploymentV1_0_0, StellarRunnerNodeImpl, StellarRunnerSpecsImpl} from '../project/versioned/v1_0_0';
-import {loadStellarProjectManifest} from './load';
+import {StellarProjectManifestVersioned, VersionedProjectManifest} from './versioned';
 
 const projectsDir = path.join(__dirname, '../../test');
 
+function loadStellarProjectManifest(file: string): StellarProjectManifestVersioned {
+  let manifestPath = file;
+  if (fs.existsSync(file) && fs.lstatSync(file).isDirectory()) {
+    const yamlFilePath = path.join(file, 'project.yaml');
+    const jsonFilePath = path.join(file, 'project.json');
+    if (fs.existsSync(yamlFilePath)) {
+      manifestPath = yamlFilePath;
+    } else if (fs.existsSync(jsonFilePath)) {
+      manifestPath = jsonFilePath;
+    } else {
+      throw new Error(`Could not find project manifest under dir ${file}`);
+    }
+  }
+
+  const doc = loadFromJsonOrYaml(manifestPath);
+  const projectManifest = new StellarProjectManifestVersioned(doc as VersionedProjectManifest);
+  projectManifest.validate();
+  return projectManifest;
+}
+
 describe('project.yaml', () => {
   it('can validate project.yaml', () => {
     expect(() => loadStellarProjectManifest(path.join(projectsDir, 'project_falsy.yaml'))).toThrow();

package/src/project/types.ts

@@ -1,7 +1,7 @@
 // Copyright 2020-2023 SubQuery Pte Ltd authors & contributors
 // SPDX-License-Identifier: GPL-3.0
 
-import {IProjectManifest, ProjectNetworkConfig} from '@subql/common';
+import {IProjectManifest, ProjectNetworkConfig} from '@subql/types-core';
 import {SubqlDatasource} from '@subql/types-stellar';
 
 // All of these used to be redefined in this file, re-exporting for simplicity
@@ -26,7 +26,6 @@ export {
 export type IStellarProjectManifest = IProjectManifest<SubqlDatasource>;
 
 export interface StellarProjectNetworkConfig extends ProjectNetworkConfig {
-  genesisHash?: string;
-  chainId?: string;
+  chainId: string;
   sorobanEndpoint: string;
 }

package/src/project/utils.ts

@@ -10,39 +10,39 @@ import {
   SubqlRuntimeDatasource,
 } from '@subql/types-stellar';
 
-export function isBlockHandlerProcessor<B>(
-  hp: SecondLayerHandlerProcessor<StellarHandlerKind, unknown, unknown>
-): hp is SecondLayerHandlerProcessor<StellarHandlerKind.Block, unknown, B> {
+export function isBlockHandlerProcessor<F extends Record<string, unknown>, B>(
+  hp: SecondLayerHandlerProcessor<StellarHandlerKind, F, unknown>
+): hp is SecondLayerHandlerProcessor<StellarHandlerKind.Block, F, B> {
   return hp.baseHandlerKind === StellarHandlerKind.Block;
 }
 
-export function isTransactionHandlerProcessor<T>(
-  hp: SecondLayerHandlerProcessor<StellarHandlerKind, unknown, unknown>
-): hp is SecondLayerHandlerProcessor<StellarHandlerKind.Transaction, unknown, T> {
+export function isTransactionHandlerProcessor<F extends Record<string, unknown>, T>(
+  hp: SecondLayerHandlerProcessor<StellarHandlerKind, F, unknown>
+): hp is SecondLayerHandlerProcessor<StellarHandlerKind.Transaction, F, T> {
   return hp.baseHandlerKind === StellarHandlerKind.Transaction;
 }
 
-export function isSorobanTransactionHandlerProcessor<T>(
-  hp: SecondLayerHandlerProcessor<StellarHandlerKind, unknown, unknown>
-): hp is SecondLayerHandlerProcessor<StellarHandlerKind.SorobanTransaction, unknown, T> {
+export function isSorobanTransactionHandlerProcessor<F extends Record<string, unknown>, T>(
+  hp: SecondLayerHandlerProcessor<StellarHandlerKind, F, unknown>
+): hp is SecondLayerHandlerProcessor<StellarHandlerKind.SorobanTransaction, F, T> {
   return hp.baseHandlerKind === StellarHandlerKind.SorobanTransaction;
 }
 
-export function isOperationHandlerProcessor<O>(
-  hp: SecondLayerHandlerProcessor<StellarHandlerKind, unknown, unknown>
-): hp is SecondLayerHandlerProcessor<StellarHandlerKind.Operation, unknown, O> {
+export function isOperationHandlerProcessor<F extends Record<string, unknown>, O>(
+  hp: SecondLayerHandlerProcessor<StellarHandlerKind, F, unknown>
+): hp is SecondLayerHandlerProcessor<StellarHandlerKind.Operation, F, O> {
   return hp.baseHandlerKind === StellarHandlerKind.Operation;
 }
 
-export function isEffectHandlerProcessor<E>(
-  hp: SecondLayerHandlerProcessor<StellarHandlerKind, unknown, unknown>
-): hp is SecondLayerHandlerProcessor<StellarHandlerKind.Effects, unknown, E> {
+export function isEffectHandlerProcessor<F extends Record<string, unknown>, E>(
+  hp: SecondLayerHandlerProcessor<StellarHandlerKind, F, unknown>
+): hp is SecondLayerHandlerProcessor<StellarHandlerKind.Effects, F, E> {
   return hp.baseHandlerKind === StellarHandlerKind.Effects;
 }
 
-export function isEventHandlerProcessor<E>(
-  hp: SecondLayerHandlerProcessor<StellarHandlerKind, unknown, unknown>
-): hp is SecondLayerHandlerProcessor<StellarHandlerKind.Event, unknown, E> {
+export function isEventHandlerProcessor<F extends Record<string, unknown>, E>(
+  hp: SecondLayerHandlerProcessor<StellarHandlerKind, F, unknown>
+): hp is SecondLayerHandlerProcessor<StellarHandlerKind.Event, F, E> {
   return hp.baseHandlerKind === StellarHandlerKind.Event;
 }
 

package/src/project/versioned/ProjectManifestVersioned.ts

@@ -42,7 +42,7 @@ export class StellarProjectManifestVersioned implements IStellarProjectManifest
   }
 
   toDeployment(): string | undefined {
-    return this._impl.toDeployment();
+    return this._impl.deployment.toYaml();
   }
 
   validate(): void {

package/src/project/versioned/v1_0_0/index.ts

@@ -2,4 +2,3 @@
 // SPDX-License-Identifier: GPL-3.0
 
 export * from './model';
-export * from './types';

package/src/project/versioned/v1_0_0/model.ts

@@ -2,18 +2,25 @@
 // SPDX-License-Identifier: GPL-3.0
 
 import {
-  BaseMapping,
   FileType,
-  NodeSpec,
   ProjectManifestBaseImpl,
-  QuerySpec,
+  ParentProjectModel,
   RunnerNodeImpl,
   RunnerQueryBaseModel,
-  RunnerSpecs,
   validateObject,
+  CommonProjectNetworkV1_0_0,
+  BaseDeploymentV1_0_0,
 } from '@subql/common';
-import {SubqlCustomDatasource, SubqlMapping, SubqlRuntimeDatasource} from '@subql/types-stellar';
-import {plainToClass, Transform, TransformFnParams, Type} from 'class-transformer';
+import {BaseMapping, NodeSpec, ParentProject, QuerySpec, RunnerSpecs} from '@subql/types-core';
+import {
+  CustomDatasourceTemplate,
+  RuntimeDatasourceTemplate,
+  StellarProjectManifestV1_0_0,
+  SubqlCustomDatasource,
+  SubqlMapping,
+  SubqlRuntimeDatasource,
+} from '@subql/types-stellar';
+import {plainToInstance, Transform, TransformFnParams, Type} from 'class-transformer';
 import {
   Equals,
   IsArray,
@@ -27,7 +34,6 @@ import {
 } from 'class-validator';
 import {CustomDataSourceBase, StellarMapping, RuntimeDataSourceBase} from '../../models';
 import {SubqlStellarDataSource, SubqlRuntimeHandler} from '../../types';
-import {CustomDatasourceTemplate, StellarProjectManifestV1_0_0, RuntimeDatasourceTemplate} from './types';
 
 const Stellar_NODE_NAME = `@subql/node-stellar`;
 
@@ -52,10 +58,7 @@ export class StellarRuntimeDataSourceImpl
   }
 }
 
-export class StellarCustomDataSourceImpl<
-    K extends string = string,
-    M extends BaseMapping<any, any> = BaseMapping<Record<string, unknown>, any>
-  >
+export class StellarCustomDataSourceImpl<K extends string = string, M extends BaseMapping<any> = BaseMapping<any>>
   extends CustomDataSourceBase<K, M>
   implements SubqlCustomDatasource<K, M>
 {
@@ -90,47 +93,32 @@ export class ProjectNetworkDeploymentV1_0_0 {
   @Transform(({value}: TransformFnParams) => value.trim())
   @IsString()
   chainId: string;
-  @ValidateNested()
-  @Type(() => FileType)
-  @IsOptional()
-  chaintypes?: FileType;
+
   @IsOptional()
   @IsArray()
   bypassBlocks?: (number | string)[];
 }
 
-export class ProjectNetworkV1_0_0 extends ProjectNetworkDeploymentV1_0_0 {
-  @IsString({each: true})
-  @IsOptional()
-  endpoint?: string | string[];
+export class StellarProjectNetwork extends CommonProjectNetworkV1_0_0<FileType> {
   @IsString()
   @IsOptional()
   soroban?: string;
-  @IsString()
-  @IsOptional()
-  dictionary?: string;
 }
 
-export class DeploymentV1_0_0 {
+export class DeploymentV1_0_0 extends BaseDeploymentV1_0_0 {
   @Transform((params) => {
     if (params.value.genesisHash && !params.value.chainId) {
       params.value.chainId = params.value.genesisHash;
     }
-    return plainToClass(ProjectNetworkDeploymentV1_0_0, params.value);
+    return plainToInstance(ProjectNetworkDeploymentV1_0_0, params.value);
   })
   @ValidateNested()
   @Type(() => ProjectNetworkDeploymentV1_0_0)
   network: ProjectNetworkDeploymentV1_0_0;
-  @Equals('1.0.0')
-  @IsString()
-  specVersion: string;
   @IsObject()
   @ValidateNested()
   @Type(() => StellarRunnerSpecsImpl)
   runner: RunnerSpecs;
-  @ValidateNested()
-  @Type(() => FileType)
-  schema: FileType;
   @IsArray()
   @ValidateNested()
   @Type(() => StellarCustomDataSourceImpl, {
@@ -155,9 +143,13 @@ export class DeploymentV1_0_0 {
 }
 
 export class ProjectManifestV1_0_0Impl<D extends object = DeploymentV1_0_0>
-  extends ProjectManifestBaseImpl<D>
+  extends ProjectManifestBaseImpl<DeploymentV1_0_0>
   implements StellarProjectManifestV1_0_0
 {
+  constructor() {
+    super(DeploymentV1_0_0);
+  }
+
   @Equals('1.0.0')
   specVersion: string;
   @Type(() => StellarCustomDataSourceImpl, {
@@ -168,8 +160,8 @@ export class ProjectManifestV1_0_0Impl<D extends object = DeploymentV1_0_0>
     keepDiscriminatorProperty: true,
   })
   dataSources: SubqlStellarDataSource[];
-  @Type(() => ProjectNetworkV1_0_0)
-  network: ProjectNetworkV1_0_0;
+  @Type(() => StellarProjectNetwork)
+  network: StellarProjectNetwork;
   @IsString()
   name: string;
   @IsString()
@@ -192,14 +184,9 @@ export class ProjectManifestV1_0_0Impl<D extends object = DeploymentV1_0_0>
   @ValidateNested()
   @Type(() => StellarRunnerSpecsImpl)
   runner: RunnerSpecs;
-  protected _deployment: D;
 
-  get deployment(): D {
-    if (!this._deployment) {
-      this._deployment = plainToClass(DeploymentV1_0_0, this) as unknown as D;
-      //validateSync(this._deployment.)
-      validateSync(this._deployment, {whitelist: true});
-    }
-    return this._deployment;
-  }
+  @IsOptional()
+  @IsObject()
+  @Type(() => ParentProjectModel)
+  parent?: ParentProject;
 }

package/test/project_1.0.0.yaml

@@ -32,7 +32,7 @@ dataSources:
         - handler: handleOperation
           kind: stellar/OperationHandler
           filter:
-            source_account: 'GAKNXHJ5PCZYFIBNBWB4RCQHH6GDEO7Z334N74BOQUQCHKOURQEPMXCH'
+            sourceAccount: 'GAKNXHJ5PCZYFIBNBWB4RCQHH6GDEO7Z334N74BOQUQCHKOURQEPMXCH'
             type: 'account_merge'
         - handler: handleEffect
           kind: stellar/EffectHandler

package/dist/project/versioned/v1_0_0/types.d.ts

@@ -1,7 +0,0 @@
-import { ProjectManifestV1_0_0, TemplateBase } from '@subql/common';
-import { SubqlCustomDatasource, SubqlRuntimeDatasource } from '@subql/types-stellar';
-export interface RuntimeDatasourceTemplate extends Omit<SubqlRuntimeDatasource, 'name'>, TemplateBase {
-}
-export interface CustomDatasourceTemplate extends Omit<SubqlCustomDatasource, 'name'>, TemplateBase {
-}
-export type StellarProjectManifestV1_0_0 = ProjectManifestV1_0_0<RuntimeDatasourceTemplate | CustomDatasourceTemplate, SubqlRuntimeDatasource | SubqlCustomDatasource>;

package/dist/project/versioned/v1_0_0/types.js

@@ -1,5 +0,0 @@
-"use strict";
-// Copyright 2020-2023 SubQuery Pte Ltd authors & contributors
-// SPDX-License-Identifier: GPL-3.0
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/dist/project/versioned/v1_0_0/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/project/versioned/v1_0_0/types.ts"],"names":[],"mappings":";AAAA,8DAA8D;AAC9D,mCAAmC","sourcesContent":["// Copyright 2020-2023 SubQuery Pte Ltd authors & contributors\n// SPDX-License-Identifier: GPL-3.0\n\nimport {ProjectManifestV1_0_0, TemplateBase} from '@subql/common';\nimport {SubqlCustomDatasource, SubqlRuntimeDatasource} from '@subql/types-stellar';\n\nexport interface RuntimeDatasourceTemplate extends Omit<SubqlRuntimeDatasource, 'name'>, TemplateBase {}\nexport interface CustomDatasourceTemplate extends Omit<SubqlCustomDatasource, 'name'>, TemplateBase {}\n\nexport type StellarProjectManifestV1_0_0 = ProjectManifestV1_0_0<\n  RuntimeDatasourceTemplate | CustomDatasourceTemplate,\n  SubqlRuntimeDatasource | SubqlCustomDatasource\n>;\n"]}

package/src/project/versioned/v1_0_0/types.ts

@@ -1,13 +0,0 @@
-// Copyright 2020-2023 SubQuery Pte Ltd authors & contributors
-// SPDX-License-Identifier: GPL-3.0
-
-import {ProjectManifestV1_0_0, TemplateBase} from '@subql/common';
-import {SubqlCustomDatasource, SubqlRuntimeDatasource} from '@subql/types-stellar';
-
-export interface RuntimeDatasourceTemplate extends Omit<SubqlRuntimeDatasource, 'name'>, TemplateBase {}
-export interface CustomDatasourceTemplate extends Omit<SubqlCustomDatasource, 'name'>, TemplateBase {}
-
-export type StellarProjectManifestV1_0_0 = ProjectManifestV1_0_0<
-  RuntimeDatasourceTemplate | CustomDatasourceTemplate,
-  SubqlRuntimeDatasource | SubqlCustomDatasource
->;