✨ Add atst boilerplate

.changeset/thick-frogs-clean.md

+---
+'@eth-optimism/atst': patch
+---
+
+Add new atst package

packages/atst/.eslintrc.json

+{
+  "extends": ["../../.eslintrc.js"]
+}

packages/atst/.gitignore

+node_modules/
+dist/
+coverage/

packages/atst/.lintstagedrc.yml

+"*.{ts,js}":
+  - eslint

packages/atst/LICENSE

+(The MIT License)
+
+Copyright 2020-2022 Optimism
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/atst/README.md

+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/35039927/218812217-92f0f784-cb85-43b9-9ca6-e2b9effd9eb2.png">
+    <img alt="wagmi logo" src="https://user-images.githubusercontent.com/35039927/218812217-92f0f784-cb85-43b9-9ca6-e2b9effd9eb2.png" width="auto" height="300">
+  </picture>
+</p>
+
+<p align="center">
+  I need a tagline here
+<p>
+<a href="https://www.npmjs.com/package/@eth-optimism/atst" target="\_parent">
+<img alt="" src="https://img.shields.io/npm/dm/@eth-optimism/atst.svg" />
+</a>
+
+# atst
+
+atst is a typescript sdk and cli around the attestation station (TODO link to attstation station)
+
+Maybe put a gif of the cli here?
+
+## Visit [Docs](https://evmts-docs-fx6udvub5-evmts.vercel.app/en/getting-started) for more documentation on teh attestation station!
+
+TODO link to oris docs here
+
+Maybe link to cli docs and sdk docs seperately?
+
+## Getting started
+
+Install
+
+```bash
+npm install @eth-optimism/atst
+```
+
+## ATST SDK
+
+TODO
+
+## ATST CLI
+
+TODO
+
+## Contributing
+
+Please see our [contributing.md](/docs/contributing.md).
+
+## 🚧 WARNING: UNDER CONSTRUCTION 🚧
+
+**This sdk is not yet released**
+
+## Check out these other awesome attestation station tools
+
+TODO
\ No newline at end of file

packages/atst/contributing.md

+# @eth-optimism/atst (WIP)
+
+TODO
+
+WIP sdk and cli tool for the attestation station. Currently in design phase. Any code here is purely experimental proof of concepts.
+
+## Dev setup
+
+To be able to run the cli commands with npx you must first link the node module so npm treats it like an installed package
+
+```
+npm link
+```
+
+Alternatively `yarn dev` will run the cli
+
+```bash
+# these are the same
+npx atst --help
+yarn dev --help
+```
+
+Example of how to read an attestation
+
+```bash
+npx atst read --key "optimist.base-uri" --about 0x2335022c740d17c2837f9C884Bfe4fFdbf0A95D5 --creator 0x60c5C9c98bcBd0b0F2fD89B24c16e533BaA8CdA3
+```

packages/atst/package.json

+{
+  "name": "@eth-optimism/atst",
+  "version": "0.0.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "src/index.ts",
+  "module": "dist/index.cjs",
+  "license": "MIT",
+  "bin": {
+    "atst": "./dist/cli.js"
+  },
+  "scripts": {
+    "dev": "tsx src/cli.ts",
+    "clean": "rm -rf ./node_modules && rm -rf ./dist && rm -rf ./coverage",
+    "build": "yarn tsup",
+    "lint": "yarn lint:fix && yarn lint:check",
+    "lint:check": "eslint . --max-warnings=0",
+    "lint:fix": "yarn lint:check --fix",
+    "test": "vitest",
+    "typecheck": "yarn tsc --noEmit"
+  },
+  "dependencies": {
+    "cac": "^6.7.14",
+    "ethers": "^5.7.0",
+    "picocolors": "^1.0.0",
+    "ora": "^6.1.2",
+    "zod": "^3.11.6"
+  },
+  "peerDependencies": {
+    "@wagmi/core": ">0.9.0"
+  },
+  "devDependencies": {
+    "@testing-library/react-hooks": "^8.0.1",
+    "jsdom": "^21.1.0",
+    "react-dom": "^18.2.0",
+    "react": "^18.2.0",
+    "execa": "^1.0.0",
+    "vitest": "^0.28.3",
+    "tsup": "^6.5.0",
+    "tsx": "^3.12.2",
+    "typescript": "^4.9.3",
+    "@wagmi/core": "^0.9.2"
+  }
+}

packages/atst/src/README.md

+# src
+
+Source code for atst
+
+## index.ts
+
+Entrypoint for sdk
+
+## cli.ts
+
+Entrypoint for the cli
+
+## __snapshots__
+
+Vitest snapshots for the vitest tests
+
+## commands
+
+CLI implementations of atst read and write
+
+## contants
+
+Internal and external constants
+
+## lib
+
+All library code for the sdk lives here
+
+## test
+
+Test helpers
+
+## types
+
+Zod and typscript types
\ No newline at end of file

packages/atst/src/constants/attestationStationAddress.ts

+/**
+ * The attestation station contract address
+ * The attestation station contract is deterministically deployed
+ * to 0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77
+ */
+export const ATTESTATION_STATION_ADDRESS =
+  '0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77'

packages/atst/src/index.ts

+// constants
+export { ATTESTATION_STATION_ADDRESS } from './constants/attestationStationAddress'

packages/atst/src/lib/abi.spec.ts

+import { describe, expect, it } from 'vitest'
+
+import { abi } from './abi'
+
+/**
+ * This is a low value test that I made only because
+ * it makes for a good final check that indeed are
+ * exporting the correct abi
+ */
+describe('abi', () => {
+  it('is the correct abi', () => {
+    const methodNames = abi.map((obj) => (obj as { name: string }).name)
+    expect(methodNames).toMatchInlineSnapshot(`
+          [
+            undefined,
+            "AttestationCreated",
+            "attest",
+            "attest",
+            "attestations",
+            "version",
+          ]
+        `)
+  })
+})

packages/atst/src/lib/abi.ts

+/**
+ * The attestation station abi
+ */
+export const abi = [
+  {
+    inputs: [],
+    stateMutability: 'nonpayable',
+    type: 'constructor',
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'creator',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'address',
+        name: 'about',
+        type: 'address',
+      },
+      {
+        indexed: true,
+        internalType: 'bytes32',
+        name: 'key',
+        type: 'bytes32',
+      },
+      {
+        indexed: false,
+        internalType: 'bytes',
+        name: 'val',
+        type: 'bytes',
+      },
+    ],
+    name: 'AttestationCreated',
+    type: 'event',
+  },
+  {
+    inputs: [
+      {
+        components: [
+          {
+            internalType: 'address',
+            name: 'about',
+            type: 'address',
+          },
+          {
+            internalType: 'bytes32',
+            name: 'key',
+            type: 'bytes32',
+          },
+          {
+            internalType: 'bytes',
+            name: 'val',
+            type: 'bytes',
+          },
+        ],
+        internalType: 'struct AttestationStation.AttestationData[]',
+        name: '_attestations',
+        type: 'tuple[]',
+      },
+    ],
+    name: 'attest',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: '_about',
+        type: 'address',
+      },
+      {
+        internalType: 'bytes32',
+        name: '_key',
+        type: 'bytes32',
+      },
+      {
+        internalType: 'bytes',
+        name: '_val',
+        type: 'bytes',
+      },
+    ],
+    name: 'attest',
+    outputs: [],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: '',
+        type: 'address',
+      },
+      {
+        internalType: 'address',
+        name: '',
+        type: 'address',
+      },
+      {
+        internalType: 'bytes32',
+        name: '',
+        type: 'bytes32',
+      },
+    ],
+    name: 'attestations',
+    outputs: [
+      {
+        internalType: 'bytes',
+        name: '',
+        type: 'bytes',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [],
+    name: 'version',
+    outputs: [
+      {
+        internalType: 'string',
+        name: '',
+        type: 'string',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+] as const

packages/atst/tsconfig.json

+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "composite": true,
+    "target": "es2017",
+    "lib": ["esnext"],
+    "skipLibCheck": true,
+    "strict": true,
+    "module": "commonjs",
+    "outDir": "build"
+  },
+  "include": ["src", "src/**/*.json"]
+}

packages/atst/tsup.config.ts

+import { defineConfig } from 'tsup'
+
+/**
+ * @see https://tsup.egoist.dev/
+ */
+export default defineConfig({
+  name: '@eth-optimism/atst',
+  /**
+   * This is also a cli app and tsup will automatically make the cli entrypoint executable
+   *
+   * @see https://tsup.egoist.dev/#building-cli-app
+   */
+  entry: ['src/index.ts', 'src/cli.ts'],
+  outDir: 'dist',
+  target: 'es2021',
+  // will create a .js file for commonjs and a .cjs file for esm
+  format: ['esm', 'cjs'],
+  // don't generate .d.ts files.  This is default but being explicit
+  dts: false,
+  splitting: false,
+  sourcemap: true,
+  // remove dist folder before building
+  clean: true,
+})

packages/atst/vite.config.ts

+import { defineConfig } from 'vitest/config'
+
+/**
+ * @see https://vitejs.dev/config/
+ */
+export default defineConfig({
+  test: {
+    environment: 'jsdom',
+    testTimeout: 10000,
+  },
+})