@xyo-network/crypto-address-transaction-history-plugin 4.1.1 → 5.0.0

package/dist/browser/index.d.ts

@@ -1,38 +1,5 @@
-import { AddressTransactionHistoryWitnessConfigSchema, Transaction } from '@xyo-network/crypto-address-transaction-history-payload-plugin';
-import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
-import { EtherscanProvider } from 'ethers';
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { Schema, Payload } from '@xyo-network/payload-model';
-
-type AddressTransactionHistoryWitnessConfig = WitnessConfig<{
-    address?: string;
-    schema: AddressTransactionHistoryWitnessConfigSchema;
-}>;
-
-/** @deprecated - no longer supported by EtherScan */
-declare const getTransactionsForAddress: (
-/**
- * The address of the wallet to search for NFTs
- */
-_publicAddress: string, 
-/**
- * The ethers provider to use to search
- */
-_provider: EtherscanProvider) => Promise<Transaction[]>;
-
-interface AddressTransactionHistoryWitnessParams extends WitnessParams<AnyConfigSchema<AddressTransactionHistoryWitnessConfig>> {
-    provider?: EtherscanProvider;
-}
-declare class AddressTransactionHistoryWitness<TParams extends AddressTransactionHistoryWitnessParams = AddressTransactionHistoryWitnessParams> extends AbstractWitness<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected get provider(): EtherscanProvider;
-    protected observeHandler(): Promise<Payload[]>;
-}
-
-declare const AddressTransactionHistoryPlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<AddressTransactionHistoryWitness<AddressTransactionHistoryWitnessParams>>;
-
-export { AddressTransactionHistoryPlugin, AddressTransactionHistoryWitness, AddressTransactionHistoryPlugin as default, getTransactionsForAddress };
-export type { AddressTransactionHistoryWitnessConfig, AddressTransactionHistoryWitnessParams };
+export * from './Config.ts';
+export * from './lib/index.ts';
+export { AddressTransactionHistoryPlugin, AddressTransactionHistoryPlugin as default } from './Plugin.ts';
+export * from './Witness.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/index.d.ts

@@ -1,38 +1,5 @@
-import { AddressTransactionHistoryWitnessConfigSchema, Transaction } from '@xyo-network/crypto-address-transaction-history-payload-plugin';
-import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
-import { EtherscanProvider } from 'ethers';
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { Schema, Payload } from '@xyo-network/payload-model';
-
-type AddressTransactionHistoryWitnessConfig = WitnessConfig<{
-    address?: string;
-    schema: AddressTransactionHistoryWitnessConfigSchema;
-}>;
-
-/** @deprecated - no longer supported by EtherScan */
-declare const getTransactionsForAddress: (
-/**
- * The address of the wallet to search for NFTs
- */
-_publicAddress: string, 
-/**
- * The ethers provider to use to search
- */
-_provider: EtherscanProvider) => Promise<Transaction[]>;
-
-interface AddressTransactionHistoryWitnessParams extends WitnessParams<AnyConfigSchema<AddressTransactionHistoryWitnessConfig>> {
-    provider?: EtherscanProvider;
-}
-declare class AddressTransactionHistoryWitness<TParams extends AddressTransactionHistoryWitnessParams = AddressTransactionHistoryWitnessParams> extends AbstractWitness<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected get provider(): EtherscanProvider;
-    protected observeHandler(): Promise<Payload[]>;
-}
-
-declare const AddressTransactionHistoryPlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<AddressTransactionHistoryWitness<AddressTransactionHistoryWitnessParams>>;
-
-export { AddressTransactionHistoryPlugin, AddressTransactionHistoryWitness, AddressTransactionHistoryPlugin as default, getTransactionsForAddress };
-export type { AddressTransactionHistoryWitnessConfig, AddressTransactionHistoryWitnessParams };
+export * from './Config.ts';
+export * from './lib/index.ts';
+export { AddressTransactionHistoryPlugin, AddressTransactionHistoryPlugin as default } from './Plugin.ts';
+export * from './Witness.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.ts

@@ -1,38 +1,5 @@
-import { AddressTransactionHistoryWitnessConfigSchema, Transaction } from '@xyo-network/crypto-address-transaction-history-payload-plugin';
-import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
-import { EtherscanProvider } from 'ethers';
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { Schema, Payload } from '@xyo-network/payload-model';
-
-type AddressTransactionHistoryWitnessConfig = WitnessConfig<{
-    address?: string;
-    schema: AddressTransactionHistoryWitnessConfigSchema;
-}>;
-
-/** @deprecated - no longer supported by EtherScan */
-declare const getTransactionsForAddress: (
-/**
- * The address of the wallet to search for NFTs
- */
-_publicAddress: string, 
-/**
- * The ethers provider to use to search
- */
-_provider: EtherscanProvider) => Promise<Transaction[]>;
-
-interface AddressTransactionHistoryWitnessParams extends WitnessParams<AnyConfigSchema<AddressTransactionHistoryWitnessConfig>> {
-    provider?: EtherscanProvider;
-}
-declare class AddressTransactionHistoryWitness<TParams extends AddressTransactionHistoryWitnessParams = AddressTransactionHistoryWitnessParams> extends AbstractWitness<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected get provider(): EtherscanProvider;
-    protected observeHandler(): Promise<Payload[]>;
-}
-
-declare const AddressTransactionHistoryPlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<AddressTransactionHistoryWitness<AddressTransactionHistoryWitnessParams>>;
-
-export { AddressTransactionHistoryPlugin, AddressTransactionHistoryWitness, AddressTransactionHistoryPlugin as default, getTransactionsForAddress };
-export type { AddressTransactionHistoryWitnessConfig, AddressTransactionHistoryWitnessParams };
+export * from './Config.ts';
+export * from './lib/index.ts';
+export { AddressTransactionHistoryPlugin, AddressTransactionHistoryPlugin as default } from './Plugin.ts';
+export * from './Witness.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/crypto-address-transaction-history-plugin",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,22 +28,25 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/assert": "^4.13.23",
-    "@xyo-network/abstract-witness": "^4.1.7",
-    "@xyo-network/crypto-address-transaction-history-payload-plugin": "^4.1.1",
-    "@xyo-network/module-model": "^4.1.7",
-    "@xyo-network/payload-model": "^4.1.7",
-    "@xyo-network/payloadset-plugin": "^4.1.7",
-    "@xyo-network/witness-model": "^4.1.7",
+    "@xylabs/assert": "^5.0.0",
+    "@xyo-network/abstract-witness": "^5.0.0",
+    "@xyo-network/crypto-address-transaction-history-payload-plugin": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/payloadset-plugin": "^5.0.0",
+    "@xyo-network/witness-model": "^5.0.0",
     "ethers": "^6.15.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
-    "@xylabs/tsconfig": "^7.0.0-rc.24",
-    "@xylabs/vitest-extended": "^4.13.23",
-    "@xyo-network/payload-wrapper": "^4.1.7",
-    "knip": "^5.62.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/payload-wrapper": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/lib/spec/getTransactionsForAddress.spec.ts

@@ -0,0 +1,61 @@
+import '@xylabs/vitest-extended'
+
+import type { AccessList, Transaction } from '@xyo-network/crypto-address-transaction-history-payload-plugin'
+import { EtherscanProvider } from 'ethers'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { getTransactionsForAddress } from '../getTransactionsForAddress.ts'
+
+const validateAccessList = (accessList: AccessList) => {
+  expect(accessList).toBeArray()
+  for (const list of accessList) {
+    expect(list.address).toBeString()
+    expect(list.storageKeys).toBeArray()
+    for (const storageKey of list.storageKeys) {
+      expect(storageKey).toBeString()
+    }
+  }
+}
+
+// eslint-disable-next-line complexity
+const validateTransaction = (t: Transaction) => {
+  if (t?.accessList) validateAccessList(t.accessList)
+  if (t?.blockHash !== undefined) expect(t.blockHash).toBeString()
+  if (t?.blockNumber !== undefined) expect(t.blockNumber).toBeNumber()
+  expect(t.chainId).toBeNumber()
+  expect(t.confirmations).toBeNumber()
+  expect(t.data).toBeString()
+  expect(t.from).toBeString()
+  expect(t.gasLimit).toBeString()
+  if (t?.gasPrice !== undefined) expect(t.gasPrice).toBeString()
+  expect(t.hash).toBeString()
+  if (t?.maxFeePerGas !== undefined) expect(t.maxFeePerGas).toBeString()
+  if (t?.maxPriorityFeePerGas !== undefined) expect(t.maxPriorityFeePerGas).toBeString()
+  expect(t.nonce).toBeNumber()
+  if (t?.r !== undefined) expect(t.r).toBeString()
+  if (t?.raw !== undefined) expect(t.raw).toBeString()
+  if (t?.s !== undefined) expect(t.s).toBeString()
+  if (t?.timestamp !== undefined) expect(t.timestamp).toBeNumber()
+  if (t?.to !== undefined) expect(t.to).toBeString()
+  // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+  if (t?.type !== undefined) t.type === null ? expect(t.type).toBeNull() : expect(t.type).toBeNumber()
+  if (t?.v !== undefined) expect(t.v).toBeNumber()
+  if (t?.value !== undefined) expect(t.value).toBeString()
+}
+
+describe.skipIf(!process.env.ETHERSCAN_API_KEY)('getTransactionsForAddress', () => {
+  const address = '0x35C556C8e97509Bf1f6D286BB0137512E11711a6'
+  const network = 'homestead'
+  const apiKey = process.env.ETHERSCAN_API_KEY
+  const provider = new EtherscanProvider(network, apiKey)
+  test('observe', async () => {
+    const transactions = await getTransactionsForAddress(address, provider)
+    expect(transactions.length).toBeGreaterThan(0)
+    for (const transaction of transactions) {
+      validateTransaction(transaction)
+    }
+  })
+})

package/src/spec/Plugin.spec.ts

@@ -0,0 +1,17 @@
+import '@xylabs/vitest-extended'
+
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { AddressTransactionHistoryPlugin } from '../Plugin.ts'
+
+describe('AddressTransactionHistoryPlugin', () => {
+  test('Add to Resolver', async () => {
+    const plugin = AddressTransactionHistoryPlugin()
+    const resolver = await new PayloadSetPluginResolver().register(plugin)
+    expect(resolver.resolve(plugin.set)).toBeDefined()
+  })
+})

package/src/spec/Witness.spec.ts

@@ -0,0 +1,35 @@
+import '@xylabs/vitest-extended'
+
+import {
+  AddressTransactionHistoryWitnessConfigSchema,
+  isAddressTransactionHistoryPayload,
+} from '@xyo-network/crypto-address-transaction-history-payload-plugin'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+import { EtherscanProvider } from 'ethers'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { AddressTransactionHistoryWitness } from '../Witness.ts'
+
+describe.skipIf(!process.env.ETHERSCAN_API_KEY)('AddressTransactionHistoryWitness', () => {
+  const address = '0x35C556C8e97509Bf1f6D286BB0137512E11711a6'
+  const network = 'homestead'
+  const apiKey = process.env.ETHERSCAN_API_KEY
+  const provider = new EtherscanProvider(network, apiKey)
+  test('observe', async () => {
+    const witness = await AddressTransactionHistoryWitness.create({
+      config: { address, schema: AddressTransactionHistoryWitnessConfigSchema },
+      provider,
+    })
+    const observation = await witness.observe()
+    const transactions = observation.filter(isAddressTransactionHistoryPayload)
+    expect(transactions.length).toBeGreaterThan(0)
+    expect(observation.length).toEqual(transactions.length)
+    for (const transaction of transactions) {
+      const wrapped = PayloadWrapper.wrap(transaction)
+      expect(await wrapped.getValid()).toBe(true)
+    }
+  })
+})

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
-}