@xyo-network/erc1967-witness 2.84.1

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@xyo-network/erc1967-witness",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/plugins/issues"
+  },
+  "dependencies": {
+    "@xylabs/assert": "^2.13.20",
+    "@xylabs/hex": "^2.13.20",
+    "@xyo-network/open-zeppelin-typechain": "^3.0.5",
+    "@xyo-network/payload-model": "^2.84.3",
+    "@xyo-network/witness-blockchain-abstract": "^2.84.3"
+  },
+  "devDependencies": {
+    "@xylabs/jest-helpers": "^2.13.20",
+    "@xylabs/ts-scripts-yarn3": "^3.2.19",
+    "@xylabs/tsconfig": "^3.2.19",
+    "ethers": "^6.9.0",
+    "jest": "^29.7.0",
+    "typescript": "^5.3.3"
+  },
+  "description": "Typescript/Javascript Plugins for XYO Platform",
+  "types": "dist/node/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": {
+          "types": "./dist/browser/index.d.cts",
+          "default": "./dist/browser/index.cjs"
+        },
+        "import": {
+          "types": "./dist/browser/index.d.mts",
+          "default": "./dist/browser/index.js"
+        }
+      },
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.cts",
+          "default": "./dist/node/index.cjs"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.js"
+        }
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/plugins.git"
+  },
+  "sideEffects": false,
+  "version": "2.84.1",
+  "type": "module"
+}

package/src/Payload.ts

@@ -0,0 +1,19 @@
+import { Address } from '@xylabs/hex'
+import { Payload } from '@xyo-network/payload-model'
+
+import { Erc1967SlotStatus } from './lib'
+
+export const Erc1967StatusSchema = 'network.xyo.erc1967.status'
+export type Erc1967StatusSchema = typeof Erc1967StatusSchema
+
+export type Erc1967Status = Payload<
+  {
+    address: Address
+    beacon?: Erc1967SlotStatus['beacon']
+    block: number
+    chainId: number
+    implementation?: Erc1967SlotStatus['implementation']
+    slots?: Erc1967SlotStatus['slots']
+  },
+  Erc1967StatusSchema
+>

package/src/Witness.ts

@@ -0,0 +1,60 @@
+import { assertEx } from '@xylabs/assert'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+import {
+  AbstractBlockchainWitness,
+  BlockchainAddress,
+  BlockchainAddressSchema,
+  BlockchainWitnessConfig,
+  BlockchainWitnessParams,
+} from '@xyo-network/witness-blockchain-abstract'
+
+import { getErc1967SlotStatus } from './lib'
+import { Erc1967Status, Erc1967StatusSchema } from './Payload'
+
+export const BlockchainErc1967WitnessConfigSchema = 'network.xyo.blockchain.Erc1967.witness.config'
+export type BlockchainErc1967WitnessConfigSchema = typeof BlockchainErc1967WitnessConfigSchema
+
+export type BlockchainErc1967WitnessConfig = BlockchainWitnessConfig<{ address?: string }, BlockchainErc1967WitnessConfigSchema>
+
+export type BlockchainErc1967WitnessParams = BlockchainWitnessParams<BlockchainErc1967WitnessConfig>
+
+export class BlockchainErc1967Witness<
+  TParams extends BlockchainErc1967WitnessParams = BlockchainErc1967WitnessParams,
+> extends AbstractBlockchainWitness<TParams, BlockchainAddress, Erc1967Status> {
+  static override configSchemas = [BlockchainErc1967WitnessConfigSchema]
+
+  protected override async observeHandler(inPayloads: BlockchainAddress[] = []): Promise<Erc1967Status[]> {
+    await this.started('throw')
+    //calling it here to make sure we rests the cache
+    await this.getProviders()
+    try {
+      const observations = await Promise.all(
+        inPayloads.filter(isPayloadOfSchemaType(BlockchainAddressSchema)).map(async ({ address }) => {
+          const validatedAddress = assertEx(address ?? this.config.address, 'Missing address')
+
+          const provider = await this.getProvider(true, true)
+
+          const block = await provider.getBlockNumber()
+
+          const { beacon, implementation, slots } = await getErc1967SlotStatus(provider, validatedAddress, block)
+
+          const observation: Erc1967Status = {
+            address: validatedAddress,
+            beacon,
+            block,
+            chainId: Number((await provider.getNetwork()).chainId),
+            implementation,
+            schema: Erc1967StatusSchema,
+            slots,
+          }
+          return observation
+        }),
+      )
+      return observations
+    } catch (ex) {
+      const error = ex as Error
+      console.log(`Error [${this.config.name}]: ${error.message}`)
+      throw error
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './lib'
+export * from './Payload'
+export * from './Witness'

package/src/lib/getErc1967SlotStatus.ts

@@ -0,0 +1,70 @@
+import { Address, hexFromHexString, isHexZero } from '@xylabs/hex'
+import { UpgradeableBeacon__factory } from '@xyo-network/open-zeppelin-typechain'
+import { Provider } from 'ethers'
+
+export const ERC1967_PROXY_IMPLEMENTATION_STORAGE_SLOT = '0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc'
+export const ERC1967_PROXY_BEACON_STORAGE_SLOT = '0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50'
+export const ERC1967_PROXY_ADMIN_STORAGE_SLOT = '0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103'
+export const ERC1967_PROXY_ROLLBACK_STORAGE_SLOT = '0x4910fdfa16fed3260ed0e7147f7cc6da11a60208b5b9406d12a635614ffd9143'
+
+export interface Erc1967DataSlots {
+  admin?: Address
+  beacon?: Address
+  implementation?: Address
+  rollback?: Address
+}
+
+export interface Erc1967SlotStatus {
+  address: Address
+  beacon?: {
+    implementation?: Address
+  }
+  implementation: Address
+  slots: Erc1967DataSlots
+}
+
+const readAddressFromSlot = async (provider: Provider, address: string, slot: string, block?: number) => {
+  try {
+    const slotValue = await provider.getStorage(address, slot, block)
+    return hexFromHexString(slotValue, { prefix: true })
+  } catch (ex) {
+    return undefined
+  }
+}
+
+export const getErc1967SlotStatus = async (provider: Provider, address: string, block?: number): Promise<Erc1967SlotStatus> => {
+  const status: Erc1967SlotStatus = {
+    address,
+    implementation: address,
+    slots: {
+      admin: await readAddressFromSlot(provider, address, ERC1967_PROXY_ADMIN_STORAGE_SLOT, block),
+      beacon: await readAddressFromSlot(provider, address, ERC1967_PROXY_BEACON_STORAGE_SLOT, block),
+      implementation: await readAddressFromSlot(provider, address, ERC1967_PROXY_IMPLEMENTATION_STORAGE_SLOT, block),
+      rollback: await readAddressFromSlot(provider, address, ERC1967_PROXY_ROLLBACK_STORAGE_SLOT, block),
+    },
+  }
+
+  if (status.slots.implementation && !isHexZero(status.slots.implementation)) {
+    status.implementation = `0x${BigInt(status.slots.implementation as string)
+      .toString(16)
+      .padStart(40, '0')}`
+  } else {
+    if (status.slots.beacon && !isHexZero(status.slots.beacon)) {
+      const beacon = UpgradeableBeacon__factory.connect(status.slots.beacon as string, { provider })
+      try {
+        const implementation = await beacon.implementation(block ? { blockTag: block } : {})
+        if (implementation) {
+          status.beacon = { implementation }
+          if (!isHexZero(implementation)) {
+            status.implementation = implementation
+          }
+        }
+      } catch (ex) {
+        const error = ex as Error
+        console.log(error.message)
+      }
+    }
+  }
+
+  return status
+}

package/src/lib/index.ts

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

package/typedoc.json

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

package/xy.config.ts

@@ -0,0 +1,14 @@
+import { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
+const config: XyTsupConfig = {
+  compile: {
+    browser: {
+      src: true,
+    },
+    node: {
+      src: true,
+    },
+  },
+}
+
+// eslint-disable-next-line import/no-default-export
+export default config