Merge pull request #81 from labscommunity/feat--ArweaveKit-Plug-In-System

Feat  arweave kit plug in system

Author: LorimerJenkins

__tests__/plugin/plugin.spec.ts

@@ -0,0 +1,63 @@
+import * as pluginOne from './pluginOne';
+import * as pluginTwo from './pluginTwo';
+import { ArweaveKit } from '../../src/lib/wallet';
+
+describe('Plugins', () => {
+  it('should use plugins', () => {
+    const arweaveKit = ArweaveKit.use({
+      name: 'pluginOne',
+      plugin: pluginOne,
+    }).use({ name: 'pluginTwo', plugin: pluginTwo });
+
+    expect(arweaveKit.pluginOne.hello()).toBe('PluginOne');
+    expect(arweaveKit.pluginTwo.hello()).toBe('PluginTwo');
+  });
+
+  it('should throw error when same named plugins used', () => {
+    try {
+      const arweaveKit = ArweaveKit.use({
+        name: 'pluginThree',
+        plugin: pluginOne,
+      }).use({ name: 'pluginThree', plugin: pluginTwo });
+
+      // if not thrown error fail the test
+      fail('must throw error');
+    } catch (error: any) {
+      expect(error.message).toBe(
+        'Plugin name already exists, please change plugin name.'
+      );
+    }
+  });
+
+  it('should throw error when empty name used for plugin', () => {
+    try {
+      const arweaveKit = ArweaveKit.use({
+        name: '',
+        plugin: pluginOne,
+      });
+
+      // if not thrown error fail the test
+      fail('must throw error');
+    } catch (error: any) {
+      expect(error.message).toBe('Please provide a valid plugin name.');
+    }
+  });
+
+  it('should contain all functions with plugins', () => {
+    const arweaveKit = ArweaveKit.use({
+      name: 'pluginFour',
+      plugin: pluginOne,
+    });
+
+    const functionNames = [
+      'pluginFour',
+      'initArweave',
+      'createWallet',
+      'getAddress',
+      'getBalance',
+    ];
+    functionNames.forEach((functionName) => {
+      expect(!!(arweaveKit as any)[functionName]).toBeTruthy();
+    });
+  });
+});

__tests__/plugin/pluginOne.ts

@@ -0,0 +1,3 @@
+export function hello(): string {
+  return 'PluginOne';
+}

__tests__/plugin/pluginTwo.ts

@@ -0,0 +1,3 @@
+export function hello(): string {
+  return 'PluginTwo';
+}

jestconfig.json

@@ -2,5 +2,8 @@
   "preset": "ts-jest",
   "testMatch": ["**/*.spec.ts"],
   "globalTeardown": "<rootDir>/__tests__/globalTeardown.ts",
-  "globalSetup": "<rootDir>/__tests__/globalSetup.ts"
+  "globalSetup": "<rootDir>/__tests__/globalSetup.ts",
+  "moduleNameMapper": {
+    "^#utils$": "<rootDir>/src/utils.ts"
+  }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "arweavekit",
-  "version": "1.4.9",
+  "version": "1.5.0",
   "description": "Utility library to build full stack permaweb applications",
   "type": "module",
   "main": "dist/index.js",
@@ -59,6 +59,9 @@
     "warp-contracts": "^1.4.17",
     "warp-contracts-plugin-deploy": "^1.0.9"
   },
+  "imports": {
+    "#utils": "./dist/utils.js"
+  },
   "exports": {
     ".": {
       "import": "./dist/index.js"

src/lib/auth.ts

@@ -4,6 +4,7 @@ import {
   UserDetailsReturnProps,
 } from '../types/auth';
 import { Othent as othent } from 'othent';
+import { createArweaveKit } from '#utils';
 
 /***
  * connect to arconnect wallet
@@ -136,3 +137,19 @@ export const Othent = {
   logOut,
   userDetails,
 };
+
+export const ArweaveKit = createArweaveKit({
+  connect,
+  disconnect,
+  getActiveAddress,
+  getPermissions,
+  getWalletNames,
+  getAllAddresses,
+  getActivePublicKey,
+  isInstalled,
+  logIn,
+  logOut,
+  userDetails,
+  ArConnect,
+  Othent,
+});

src/lib/contract.ts

@@ -1,7 +1,7 @@
 import type { CacheOptions, JWKInterface, Tag } from 'warp-contracts';
 import * as Types from '../types/contract';
 import { Othent as othent } from 'othent';
-import { appVersionTag } from '../utils';
+import { appVersionTag, createArweaveKit } from '../utils';
 import { ethers } from 'ethers';
 
 /**
@@ -505,3 +505,12 @@ export async function readContractWOthent(
 
   return res;
 }
+
+export const ArweaveKit = createArweaveKit({
+  createContract,
+  writeContract,
+  readContractState,
+  getContract,
+  writeContractWOthent,
+  readContractWOthent,
+});

src/lib/encryption.ts

@@ -1,5 +1,6 @@
 import { JWKInterface } from 'warp-contracts';
 import * as Types from '../types/encryption';
+import { createArweaveKit } from '../utils';
 import Arweave from 'arweave';
 
 /**
@@ -345,3 +346,14 @@ export async function decryptDataWithAES(
 
   return decryptedData;
 }
+
+export const ArweaveKit = createArweaveKit({
+  concatenateArrayBuffers,
+  separateArrayBuffer,
+  bufferToBase64,
+  encryptDataWithAES,
+  encryptAESKeywithRSA,
+  decryptAESKeywithRSA,
+  base64ToBuffer,
+  decryptDataWithAES,
+});

src/lib/graphql.ts

@@ -2,7 +2,7 @@ import Arweave from 'arweave';
 import { buildSchema, parse, validate, GraphQLError } from 'graphql';
 
 import * as Types from '../types/graphql';
-import { ARWEAVE_GATEWAYS } from '../utils';
+import { createArweaveKit, ARWEAVE_GATEWAYS } from '../utils';
 
 /**
  * Query data with GraphQL endpoint
@@ -286,3 +286,11 @@ enum SortOrder {
   HEIGHT_DESC
 }
 `;
+
+export const ArweaveKit = createArweaveKit({
+  queryGQL,
+  queryTransactionsGQL,
+  queryAllTransactionsGQL,
+  ARWEAVE_GATEWAYS,
+  graphQlSchemaString,
+});

src/lib/transaction.ts

@@ -4,7 +4,7 @@ import { JWKInterface } from 'arweave/node/lib/wallet';
 import * as Types from '../types/transaction';
 import { Othent as othent } from 'othent';
 import { ethers } from 'ethers';
-import { appVersionTag } from '../utils';
+import { createArweaveKit, appVersionTag } from '../utils';
 
 async function initArweave(params: Types.InitArweaveProps) {
   let arweave: Arweave;
@@ -347,3 +347,13 @@ export async function createAndPostTransactionWOthent(
     throw new Error('Transaction creation unsuccessful.');
   }
 }
+
+export const ArweaveKit = createArweaveKit({
+  initArweave,
+  createTransaction,
+  signTransaction,
+  postTransaction,
+  getTransactionStatus,
+  getTransaction,
+  createAndPostTransactionWOthent,
+});