Merge pull request #523 from MoralisWeb3/feat/solUtils

feat(sol): sol-utils package

.changeset/early-points-hammer.md

@@ -0,0 +1,7 @@
+---
+'@moralisweb3/core': major
+'@moralisweb3/sol-api': major
+'@moralisweb3/sol-utils': major
+---
+
+Adding solUtils package to codebase.

demos/test-node/src/SolApi.ts

@@ -1,4 +1,4 @@
-import { SolNetworkName } from '@moralisweb3/core';
+import { SolNetworkName } from '@moralisweb3/sol-utils';
 import Moralis from 'moralis';
 import { smokeTest } from './Tester';
 

jest.config.js

@@ -2,6 +2,7 @@ module.exports = {
   // Map workspaces to their source code so that Jest can resolve them correctly.
   moduleNameMapper: {
     '^@moralisweb3/evm-api': '<rootDir>/../evmApi/src',
+    '^@moralisweb3/sol-utils': '<rootDir>/../solUtils/src',
     '^@moralisweb3/evm-utils': '<rootDir>/../evmUtils/src',
     '^@moralisweb3/api-utils': '<rootDir>/../apiUtils/src',
     '^@moralisweb3/core': '<rootDir>/../core/src',

packages/core/src/Config/MoralisConfig.ts

@@ -1,4 +1,4 @@
-import { SolNetworkish } from '../dataTypes';
+import { SolNetworkish } from './interfaces';
 import { CoreConfig, EvmAddressFormat, EvmChainIdFormat } from './CoreConfig';
 import { EvmChainish } from './interfaces/EvmChainish';
 

packages/core/src/Config/interfaces/SolNetworkish.ts

@@ -0,0 +1,14 @@
+/**
+ * Note this is just an interface, used in the core config.
+ * The implementations are located in the @moralisweb3/sol-utils package.
+ */
+
+export const solNetworkNames = ['mainnet', 'devnet'] as const;
+
+export type SolNetworkName = typeof solNetworkNames[number];
+
+export interface SolNetworkable {
+  network: SolNetworkName;
+}
+
+export type SolNetworkish = SolNetworkable | string;

packages/core/src/Config/interfaces/index.ts

@@ -1 +1,2 @@
+export * from './SolNetworkish';
 export * from './EvmChainish';

packages/core/src/dataTypes/index.ts

@@ -1,4 +1 @@
-export * from './SolNetwork';
-export * from './SolAddress';
-export * from './SolNative';
 export * from './abstract';

packages/moralis/src/index.ts

@@ -2,6 +2,7 @@ import { MoralisApiUtils } from '@moralisweb3/api-utils';
 import { MoralisAuth } from '@moralisweb3/auth';
 import { MoralisEvmUtils } from '@moralisweb3/evm-utils';
 import { MoralisEvmApi } from '@moralisweb3/evm-api';
+import { MoralisSolUtils } from '@moralisweb3/sol-utils';
 import { MoralisSolApi } from '@moralisweb3/sol-api';
 import { MoralisCoreProvider } from '@moralisweb3/core';
 
@@ -15,10 +16,11 @@ const apiUtils = MoralisApiUtils.create(core);
 // Feature modules
 const auth = MoralisAuth.create(core);
 const evmApi = MoralisEvmApi.create(core);
+const solUtils = MoralisSolUtils.create(core);
 const solApi = MoralisSolApi.create(core);
 
 // Register all Moralis modules to MoralisCore
-core.registerModules([evmUtils, auth, apiUtils, evmApi, solApi]);
+core.registerModules([evmUtils, solUtils, auth, apiUtils, evmApi, solApi]);
 
 const Moralis = {
   Core: core,

packages/solApi/package.json

@@ -29,6 +29,7 @@
   "dependencies": {
     "@moralisweb3/api-utils": "^2.0.0-alpha.2",
     "@moralisweb3/core": "^2.0.0-alpha.2",
+    "@moralisweb3/sol-utils": "^2.0.0-alpha.2",
     "ethers": "^5.6.2"
   }
 }

packages/solApi/src/config/SolApiConfig.ts

@@ -1,4 +1,5 @@
-import { ConfigKey, SolNetworkish } from '@moralisweb3/core/lib';
+import { SolNetworkish } from '@moralisweb3/sol-utils';
+import { ConfigKey } from '@moralisweb3/core';
 
 export const SolApiConfig = {
   defaultSolNetwork: {

packages/solApi/src/resolvers/SolNetworkResolver.ts

@@ -1,4 +1,5 @@
-import { MoralisCoreProvider, SolNetwork, SolNetworkish, SolNetworkName } from '@moralisweb3/core';
+import { MoralisCoreProvider } from '@moralisweb3/core';
+import { SolNetwork, SolNetworkish, SolNetworkName } from '@moralisweb3/sol-utils';
 import { SolApiConfig } from '../config/SolApiConfig';
 
 export class SolNetworkResolver {

packages/solApi/src/resolvers/account/getBalance.ts

@@ -1,5 +1,6 @@
 import { ApiResolver } from '@moralisweb3/api-utils';
-import { Camelize, SolAddress, SolAddressish, SolNetworkish, SolNative } from '@moralisweb3/core';
+import { Camelize } from '@moralisweb3/core';
+import { SolAddress, SolAddressish, SolNetworkish, SolNative } from '@moralisweb3/sol-utils';
 import { operations } from '../../generated/types';
 import { BASE_URL } from '../../MoralisSolApi';
 import { SolNetworkResolver } from '../SolNetworkResolver';

packages/solApi/src/resolvers/account/getNFTs.ts

@@ -1,5 +1,6 @@
 import { ApiResolver } from '@moralisweb3/api-utils';
-import { Camelize, SolAddress, SolAddressish, SolNetworkish } from '@moralisweb3/core';
+import { Camelize } from '@moralisweb3/core';
+import { SolAddress, SolAddressish, SolNetworkish } from '@moralisweb3/sol-utils';
 import { operations } from '../../generated/types';
 import { BASE_URL } from '../../MoralisSolApi';
 import { SolNetworkResolver } from '../SolNetworkResolver';

packages/solApi/src/resolvers/account/getPortfolio.ts

@@ -1,5 +1,6 @@
 import { ApiResolver } from '@moralisweb3/api-utils';
-import { Camelize, SolAddress, SolAddressish, SolNative, SolNetworkish } from '@moralisweb3/core';
+import { Camelize } from '@moralisweb3/core';
+import { SolAddress, SolAddressish, SolNative, SolNetworkish } from '@moralisweb3/sol-utils';
 import { operations } from '../../generated/types';
 import { BASE_URL } from '../../MoralisSolApi';
 import { SolNetworkResolver } from '../SolNetworkResolver';

packages/solApi/src/resolvers/account/getSPL.ts

@@ -1,5 +1,6 @@
 import { ApiResolver } from '@moralisweb3/api-utils';
-import { Camelize, SolAddress, SolAddressish, SolNative, SolNetworkish } from '@moralisweb3/core';
+import { Camelize } from '@moralisweb3/core';
+import { SolAddress, SolAddressish, SolNative, SolNetworkish } from '@moralisweb3/sol-utils';
 import { operations } from '../../generated/types';
 import { BASE_URL } from '../../MoralisSolApi';
 import { SolNetworkResolver } from '../SolNetworkResolver';

packages/solApi/src/resolvers/nft/getNFTMetadata.ts

@@ -1,5 +1,6 @@
 import { ApiResolver } from '@moralisweb3/api-utils';
-import { Camelize, SolAddress, SolAddressish, SolNetworkish } from '@moralisweb3/core';
+import { Camelize } from '@moralisweb3/core';
+import { SolAddress, SolAddressish, SolNetworkish } from '@moralisweb3/sol-utils';
 import { operations } from '../../generated/types';
 import { BASE_URL } from '../../MoralisSolApi';
 import { SolNetworkResolver } from '../SolNetworkResolver';

packages/solUtils/.prettierignore

@@ -0,0 +1,10 @@
+CHANGELOG.md
+
+# Output folders
+lib/**/*
+dist
+coverage/
+lib.esm
+node_modules
+
+src/generated

packages/solUtils/.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('../../.prettierrc'),
+};

packages/solUtils/README.md

@@ -0,0 +1 @@
+# @moralisweb3/sol-utils

packages/solUtils/jest.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('../../jest.config'),
+};

packages/solUtils/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@moralisweb3/sol-utils",
+  "author": "Moralis",
+  "version": "2.0.0-alpha.2",
+  "license": "MIT",
+  "private": false,
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "lib/index.*",
+    "lib/**/*.d.ts",
+    "dist"
+  ],
+  "scripts": {
+    "test": "yarn jest --runInBand --detectOpenHandles --forceExit --ci",
+    "test:coverage": "yarn run test --coverage",
+    "test:watch": "yarn run test --watch",
+    "format": "prettier . \"**/*.+(js|ts|json)\" --write",
+    "lint": "eslint . --ext .js,.ts,.tsx,jsx",
+    "format:check": "prettier . \"**/*.+(js|ts|json)\" --check",
+    "clean": "rm -rf lib && rm -rf lib.esm && rm -rf tsconfig.tsbuildinfo",
+    "gen:types": "openapi-typescript https://solana-gateway.moralis.io/api-json/ --output src/generated/types.ts",
+    "build": "tsc",
+    "dev": "tsc --watch"
+  },
+  "devDependencies": {
+    "openapi-typescript": "^5.2.0",
+    "prettier": "^2.5.1",
+    "typescript": "^4.5.5"
+  },
+  "dependencies": {
+    "@ethersproject/bignumber": "^5.6.0",
+    "@ethersproject/units": "^5.6.0",
+    "@moralisweb3/core": "^2.0.0-alpha.2"
+  }
+}

packages/solUtils/src/MoralisSolUtils.ts

@@ -0,0 +1,21 @@
+import MoralisCore, { Module, MoralisCoreProvider } from '@moralisweb3/core';
+
+export class MoralisSolUtils extends Module {
+  public static readonly moduleName = 'evmUtils';
+
+  public static create(core?: MoralisCore): MoralisSolUtils {
+    return new MoralisSolUtils(core ?? MoralisCoreProvider.getDefault());
+  }
+
+  private constructor(core: MoralisCore) {
+    super(MoralisSolUtils.moduleName, core);
+  }
+
+  public setup() {
+    // Nothing
+  }
+
+  public start() {
+    // Nothing
+  }
+}

packages/core/src/dataTypes/SolAddress.ts → packages/solUtils/src/dataTypes/SolAddress/SolAddress.ts

@@ -1,4 +1,4 @@
-import { MoralisData, MoralisDataFormatted } from './abstract';
+import { MoralisData, MoralisDataFormatted } from '@moralisweb3/core';
 
 export type SolAddressish = SolAddress | string;
 

packages/solUtils/src/dataTypes/SolAddress/index.ts

@@ -0,0 +1 @@
+export * from './SolAddress';

packages/core/src/dataTypes/SolNative.ts → packages/solUtils/src/dataTypes/SolNative/SolNative.ts

@@ -1,7 +1,6 @@
 import { BigNumber, BigNumberish, parseFixed } from '@ethersproject/bignumber';
 import { formatUnits } from '@ethersproject/units';
-import { CoreErrorCode, MoralisCoreError } from '../Error';
-import { MoralisData, MoralisDataFormatted } from './abstract';
+import { MoralisData, MoralisDataFormatted, CoreErrorCode, MoralisCoreError } from '@moralisweb3/core';
 
 export type SolNativeUnit = 'solana' | 'lamports' | number;
 

packages/solUtils/src/dataTypes/SolNative/index.ts

@@ -0,0 +1 @@
+export * from './SolNative';

packages/core/src/dataTypes/SolNetwork.ts → packages/solUtils/src/dataTypes/SolNetwork/SolNetwork.ts

@@ -1,5 +1,4 @@
-import { CoreErrorCode, MoralisCoreError } from '../Error';
-import { MoralisData, MoralisDataFormatted } from './abstract';
+import { MoralisData, MoralisDataFormatted, CoreErrorCode, MoralisCoreError } from '@moralisweb3/core';
 
 const solNetworkNames = ['mainnet', 'devnet'] as const;
 

packages/solUtils/src/dataTypes/SolNetwork/index.ts

@@ -0,0 +1 @@
+export * from './SolNetwork';

packages/solUtils/src/dataTypes/index.ts

@@ -0,0 +1,3 @@
+export * from './SolAddress';
+export * from './SolNetwork';
+export * from './SolNative';

packages/solUtils/src/index.ts

@@ -0,0 +1,2 @@
+export * from './dataTypes';
+export * from './MoralisSolUtils';

packages/solUtils/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.package.json",
+  "compilerOptions": {
+    "outDir": "./lib",
+    "declarationDir": "./lib/",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*", "types/**/*"]
+}