@subql/common-solana 0.0.0-1

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

@@ -0,0 +1,200 @@
+// Copyright 2020-2025 SubQuery Pte Ltd authors & contributors
+// SPDX-License-Identifier: GPL-3.0
+
+import {
+  BaseDeploymentV1_0_0,
+  CommonEndpointConfig,
+  CommonProjectNetworkV1_0_0,
+  FileType,
+  IsNetworkEndpoint,
+  ParentProjectModel,
+  ProjectManifestBaseImpl,
+  RunnerNodeImpl,
+  RunnerQueryBaseModel,
+} from '@subql/common';
+import { BaseMapping, NodeSpec, RunnerSpecs, QuerySpec, ParentProject } from '@subql/types-core';
+import {
+  CustomDatasourceTemplate,
+  SolanaProjectManifestV1_0_0,
+  ISolanaEndpointConfig,
+  RuntimeDatasourceTemplate,
+  SubqlCustomDatasource,
+  SubqlMapping,
+  SubqlRuntimeDatasource,
+} from '@subql/types-solana';
+import { plainToInstance, Transform, TransformFnParams, Type } from 'class-transformer';
+import {
+  Equals,
+  IsArray,
+  IsIn,
+  IsNotEmpty,
+  IsObject,
+  IsOptional,
+  IsPositive,
+  IsString,
+  ValidateNested,
+  validateSync,
+} from 'class-validator';
+import { CustomDataSourceBase, RuntimeDataSourceBase } from '../../models';
+import { SubqlSolanaDataSource, SubqlRuntimeHandler } from '../../types';
+
+const SOLANA_NODE_NAME = `@subql/node-solana`;
+
+export class SolanaRunnerNodeImpl extends RunnerNodeImpl {
+  @IsIn([SOLANA_NODE_NAME], {
+    message: `Runner Solana node name is incorrect, supposed to be '${SOLANA_NODE_NAME}'`,
+  })
+  name: string = SOLANA_NODE_NAME;
+}
+
+function validateObject(object: any, errorMessage = 'failed to validate object.'): void {
+  const errors = validateSync(object, { whitelist: true, forbidNonWhitelisted: true });
+  if (errors?.length) {
+    const errorMsgs = errors.map((e) => e.toString()).join('\n');
+    throw new Error(`${errorMessage}\n${errorMsgs}`);
+  }
+}
+
+export class SolanaRuntimeDataSourceImpl
+  extends RuntimeDataSourceBase<SubqlMapping<SubqlRuntimeHandler>>
+  implements SubqlRuntimeDatasource {
+  validate(): void {
+    return validateObject(this, 'failed to validate runtime datasource.');
+  }
+}
+
+export class SolanaCustomDataSourceImpl<K extends string = string, M extends BaseMapping<any> = BaseMapping<any>>
+  extends CustomDataSourceBase<K, M>
+  implements SubqlCustomDatasource<K, M> {
+  validate(): void {
+    return validateObject(this, 'failed to validate custom datasource.');
+  }
+}
+
+export class RuntimeDatasourceTemplateImpl extends SolanaRuntimeDataSourceImpl implements RuntimeDatasourceTemplate {
+  @IsString()
+  name!: string;
+}
+
+export class CustomDatasourceTemplateImpl extends SolanaCustomDataSourceImpl implements CustomDatasourceTemplate {
+  @IsString()
+  name!: string;
+}
+
+export class SolanaRunnerSpecsImpl implements RunnerSpecs {
+  @IsObject()
+  @ValidateNested()
+  @Type(() => SolanaRunnerNodeImpl)
+  node!: NodeSpec;
+  @IsObject()
+  @ValidateNested()
+  @Type(() => RunnerQueryBaseModel)
+  query!: QuerySpec;
+}
+
+export class ProjectNetworkDeploymentV1_0_0 {
+  @IsNotEmpty()
+  @Transform(({ value }: TransformFnParams) => value.trim())
+  @IsString()
+  chainId!: string;
+  @IsOptional()
+  @IsArray()
+  bypassBlocks?: (number | `${number}-${number}`)[];
+}
+
+export class SolanaEndpointConfig extends CommonEndpointConfig implements ISolanaEndpointConfig {
+  @IsOptional()
+  @IsPositive()
+  batchSize?: number;
+}
+
+export class ProjectNetworkV1_0_0 extends CommonProjectNetworkV1_0_0<void> {
+  @IsOptional()
+  @IsNetworkEndpoint(SolanaEndpointConfig)
+  endpoint: string | string[] | Record<string, CommonEndpointConfig> = {};
+}
+
+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 plainToInstance(ProjectNetworkDeploymentV1_0_0, params.value);
+  })
+  @ValidateNested()
+  @Type(() => ProjectNetworkDeploymentV1_0_0)
+  network!: ProjectNetworkDeploymentV1_0_0;
+  @IsObject()
+  @ValidateNested()
+  @Type(() => SolanaRunnerSpecsImpl)
+  runner!: RunnerSpecs;
+  @IsArray()
+  @ValidateNested()
+  @Type(() => SolanaCustomDataSourceImpl, {
+    discriminator: {
+      property: 'kind',
+      subTypes: [{ value: SolanaRuntimeDataSourceImpl, name: 'solana/Runtime' }],
+    },
+    keepDiscriminatorProperty: true,
+  })
+  dataSources!: (SubqlRuntimeDatasource | SubqlCustomDatasource)[];
+  @IsOptional()
+  @IsArray()
+  @ValidateNested()
+  @Type(() => CustomDatasourceTemplateImpl, {
+    discriminator: {
+      property: 'kind',
+      subTypes: [{ value: RuntimeDatasourceTemplateImpl, name: 'solana/Runtime' }],
+    },
+    keepDiscriminatorProperty: true,
+  })
+  templates?: (RuntimeDatasourceTemplate | CustomDatasourceTemplate)[];
+}
+
+export class ProjectManifestV1_0_0Impl
+  extends ProjectManifestBaseImpl<DeploymentV1_0_0>
+  implements SolanaProjectManifestV1_0_0 {
+  constructor() {
+    super(DeploymentV1_0_0);
+  }
+
+  @Equals('1.0.0')
+  specVersion = '1.0.0';
+  @Type(() => SolanaCustomDataSourceImpl, {
+    discriminator: {
+      property: 'kind',
+      subTypes: [{ value: SolanaRuntimeDataSourceImpl, name: 'solana/Runtime' }],
+    },
+    keepDiscriminatorProperty: true,
+  })
+  dataSources!: SubqlSolanaDataSource[];
+  @Type(() => ProjectNetworkV1_0_0)
+  network!: ProjectNetworkV1_0_0;
+  @IsString()
+  name!: string;
+  @IsString()
+  version!: string;
+  @ValidateNested()
+  @Type(() => FileType)
+  schema!: FileType;
+  @IsOptional()
+  @IsArray()
+  @ValidateNested()
+  @Type(() => CustomDatasourceTemplateImpl, {
+    discriminator: {
+      property: 'kind',
+      subTypes: [{ value: RuntimeDatasourceTemplateImpl, name: 'solana/Runtime' }],
+    },
+    keepDiscriminatorProperty: true,
+  })
+  templates?: (RuntimeDatasourceTemplate | CustomDatasourceTemplate)[];
+  @IsObject()
+  @ValidateNested()
+  @Type(() => SolanaRunnerSpecsImpl)
+  runner!: RunnerSpecs;
+
+  @IsOptional()
+  @IsObject()
+  @Type(() => ParentProjectModel)
+  parent?: ParentProject;
+}

package/templates/idl.ts.ejs

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: Apache-2.0
+
+// Auto-generated , DO NOT EDIT
+import { SolanaInstruction, SolanaLogMessage } from '@subql/types-solana';
+
+import {<% props.instructions.forEach(function(inst){ %><%= inst %>InstructionDataArgs, <% }); %>} from '../program-interfaces/<%=props.name%>/instructions';
+
+<% props.instructions.forEach(function(inst){ %>
+export type <%=inst %>Instruction = SolanaInstruction<<%=inst%>InstructionDataArgs>
+<% }); %>

package/test/abiTest/project.yaml

@@ -0,0 +1,51 @@
+specVersion: '1.0.0'
+name: 'example'
+
+version: '0.0.1'
+runner:
+  node:
+    name: '@subql/node-ethereum'
+    version: '*'
+  query:
+    name: '@subql/query'
+    version: '*'
+description: ''
+repository: ''
+schema:
+  file: './schema.graphql'
+network:
+  chainId: '1'
+  endpoint: 'aaa'
+  dictionary: ''
+
+customDs:
+  assets:
+    abi:
+      file: ./erc20.json
+    artifact:
+      file: ./abis/Erc20.sol/erc20.json
+dataSources:
+  - kind: ethereum/Runtime
+    options:
+      abi: Erc20
+    assets:
+      Erc20:
+        file: './abis/erc20.json'
+    startBlock: 1
+    mapping:
+      file: ''
+      handlers:
+        - handler: handleTransaction
+          kind: ethereum/BlockHandler
+  - kind: ethereum/Runtime
+    options:
+      abi: 'artifactErc20'
+    assets:
+      'artifactErc20':
+        file: './abis/Erc20.sol/Erc20.json'
+    startBlock: 1
+    mapping:
+      file: ''
+      handlers:
+        - handler: handleTransaction
+          kind: ethereum/BlockHandler

package/test/project_1.0.0.yaml

@@ -0,0 +1,91 @@
+specVersion: '1.0.0'
+
+name: 'test'
+version: '0.0.1'
+runner:
+  node:
+    name: '@subql/node-solana'
+    version: '*'
+  query:
+    name: '@subql/query'
+    version: '*'
+description: 'This project can be use as a starting point for developing your new Solana SubQuery project'
+repository: 'https://github.com/subquery/solana-subql-starter'
+
+schema:
+  file: './schema.graphql'
+
+network:
+  #  endpoint: "fill it in"
+  chainId: '1'
+  dictionary: 'https://eth-dict.api.onfinality.io/'
+  endpoint: 'wss://eth.api.onfinality.io/ws?apikey='
+
+dataSources:
+  - kind: solana/Runtime
+    startBlock: 12369621
+    mapping:
+      file: './dist/index.js'
+      handlers:
+        - handler: handlePoolCreated
+          kind: solana/LogHandler
+          filter:
+            topics:
+              - PoolCreated(address indexed token0, address indexed token1, uint24 indexed fee, int24 tickSpacing, address pool)
+    # solana/contract
+  - kind: solana/Runtime
+    startBlock: 12369651
+    mapping:
+      file: './dist/index.js'
+      handlers:
+        - handler: handleIncreaseLiquidity
+          kind: solana/LogHandler
+          filter:
+            topics:
+              - IncreaseLiquidity (uint256 tokenId, uint128 liquidity, uint256 amount0, uint256 amount1)
+        - handler: handleDecreaseLiquidity
+          kind: solana/LogHandler
+          filter:
+            topics:
+              - DecreaseLiquidity (uint256 tokenId, uint128 liquidity, uint256 amount0, uint256 amount1)
+        - handler: handleCollect
+          kind: solana/LogHandler
+          filter:
+            topics:
+              - Collect (uint256 tokenId, address recipient, uint256 amount0, uint256 amount1)
+        - handler: handleTransfer
+          kind: solana/LogHandler
+          filter:
+            topics:
+              - Transfer (address from, address to, uint256 tokenId)
+templates:
+  - name: Pool
+    kind: solana/Runtime
+    mapping:
+      file: './dist/index.js'
+      handlers:
+        - handler: handleInitialize
+          kind: solana/LogHandler
+          filter:
+            topics:
+              - Initialize (uint160,int24)
+        - handler: handleSwap
+          kind: solana/LogHandler
+          filter:
+            topics:
+              - Swap (address sender, address recipient, int256 amount0, int256 amount1, uint160 sqrtPriceX96, uint128 liquidity, int24 tick)
+        - handler: handleMint
+          kind: solana/LogHandler
+          filter:
+            topics:
+              - Mint(address sender, address owner, int24 tickLower, int24 tickUpper, uint128 amount, uint256 amount0, uint256 amount1)
+        - handler: handleBurn
+          kind: solana/LogHandler
+          filter:
+            topics:
+              - Burn(indexed address,indexed int24,indexed int24,uint128,uint256,uint256)
+        - handler: handleFlash
+          kind: solana/LogHandler
+          filter:
+            topics:
+              - Flash(indexed address,indexed address,uint256,uint256,uint256,uint256)

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "tsBuildInfoFile": "dist/.tsbuildinfo",
+    "outDir": "dist",
+    "noImplicitAny": true,
+    "strict": true
+  },
+  "references": [{"path": "../types"}],
+  "include": ["src/**/*"]
+}