Merge pull request #5090 from ethereum-optimism/qbzzt/atst-docs

feat(packages/atst): Final touches on the docs

packages/atst/README.md

@@ -16,9 +16,9 @@
 
 # atst
 
-atst is a typescript sdk and cli around the attestation station
+atst is a typescript / javascript sdk and cli around AttestationStation
 
-### Visit [Docs](https://community.optimism.io/docs/governance/attestation-station/) for general documentation on the attestation station!
+**Visit [Docs](https://community.optimism.io/docs/governance/attestation-station/) for general documentation on AttestationStation.**
 
 ## Getting started
 
@@ -28,42 +28,50 @@ Install
 npm install @eth-optimism/atst wagmi @wagmi/core ethers@5.7.0
 ```
 
-## atst typescript sdk
+## atst typescript/javascript sdk
 
-The typescript sdk provides a clean [wagmi](https://wagmi.sh/) based interface for reading and writing to the attestation station
+The typescript sdk provides a clean [wagmi](https://wagmi.sh/) based interface for reading and writing to AttestationStation.
 
-### See [sdk docs](https://github.com/ethereum-optimism/optimism/blob/develop/packages/atst/docs/sdk.md) for usage instructions
+**See [sdk docs](https://github.com/ethereum-optimism/optimism/blob/develop/packages/atst/docs/sdk.md) for usage instructions.**
 
 ## atst cli
 
-The cli provides a convenient cli for interacting with the attestation station contract
+The cli provides a convenient cli for interacting with the AttestationStation contract
 
 ![preview](./assets/preview.gif)
 
-## React API
+**See [cli docs](https://github.com/ethereum-optimism/optimism/blob/develop/packages/atst/docs/cli.md) for usage instructions.**
 
-For react hooks we recomend using the [wagmi cli](https://wagmi.sh/cli/getting-started) with the [etherscan plugin](https://wagmi.sh/cli/plugins/etherscan) and [react plugin](https://wagmi.sh/cli/plugins/react) to automatically generate react hooks around the attestation station.
+## React API
 
-Use `createKey` and `createValue` to convert your raw keys and values into bytes that can be used in the attestation station contract calls
+For react hooks we recomend using the [wagmi cli](https://wagmi.sh/cli/getting-started) with the [etherscan plugin](https://wagmi.sh/cli/plugins/etherscan) and [react plugin](https://wagmi.sh/cli/plugins/react) to automatically generate react hooks around AttestationStation.
 
-Use `parseString`, `parseBool`, `parseAddress` and `parseNumber` to convert values returned by attestation station to their correct data type.
+Use `createKey` and `createValue` to convert your raw keys and values into bytes that can be used in AttestationStation contract calls
 
-For convenience we also export the hooks here.
+Use `parseString`, `parseBool`, `parseAddress` and `parseNumber` to convert values returned by AttestationStation to their correct data type.
 
-`useAttestationStationAttestation` - Reads attestations with useContractRead
+For convenience we also [export the hooks here](https://github.com/ethereum-optimism/optimism/blob/develop/packages/atst/src/index.ts):
+- `useAttestationStationAttestation` - Reads attestations with useContractRead
+- `useAttestationStationVersion` - Reads attestation version
+- `useAttestationStationAttest` - Wraps useContractWrite with AttestationStation abi calling attest
+- `usePrepareAttestationStationAttest` - Wraps usePrepare with AttestationStation abi calling attest
+- `useAttestationStationAttestationCreatedEvent` - Wraps useContractEvents for Created events
 
-`useAttestationStationVersion` - Reads attestation version
+Also some more hooks exported by the cli but these are likely the only ones you need.
 
-`useAttestationStationAttest` - Wraps useContractWrite with attestation station abi calling attest
+## Contributing
 
-`usePrepareAttestationStationAttest` - Wraps usePrepare with attestation station abi calling attest
+Please see our [contributing.md](https://github.com/ethereum-optimism/optimism/blob/develop/CONTRIBUTING.md). No contribution is too small.
 
-`useAttestationStationAttestationCreatedEvent` - Wraps useContractEvents for Created events
+Having your contribution denied feels bad. 
+Please consider [opening an issue](https://github.com/ethereum-optimism/optimism/issues) before adding any new features or apis.
 
-Also some more hooks exported by the cli but these are likely the only ones you need.
 
-## Contributing
+## Getting help
 
-Please see our [contributing.md](docs/contributing.md). No contribution is too small.
+If you have any problems, these resources could help you:
 
-Having your contribution denied feels bad. Please consider opening an issue before adding any new features or apis
+- [sdk documentation](https://github.com/ethereum-optimism/optimism/blob/develop/packages/atst/docs/sdk.md)
+- [cli documentation](https://github.com/ethereum-optimism/optimism/blob/develop/packages/atst/docs/cli.md)
+- [Optimism Discord](https://discord-gateway.optimism.io/)
+- [Telegram group](https://t.me/+zwpJ8Ohqgl8yNjNh) 

packages/atst/docs/cli.md

@@ -63,9 +63,9 @@ npx atst read --key "optimist.base-uri" --about 0x2335022c740d17c2837f9C884Bfe4f
 Example: 
 
 ```bash
-atst write --key "optimist.base-uri" \
+npx atst write --key "optimist.base-uri" \
     --about 0x2335022c740d17c2837f9C884Bfe4fFdbf0A95D5 \
     --value "my attestation" \
     --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 \
-    --rpc-url http://localhost:8545
+    --rpc-url http://goerli.optimism.io
 ```

packages/atst/docs/sdk.md

-# atst sdk docs
+# AttestationStation sdk docs
 
 Typescript sdk for interacting with the ATST based on [@wagmi/core](https://wagmi.sh/core/getting-started)
 
@@ -150,7 +150,7 @@ const attestation = await readAttestation(
   about,          // Address: The about topic of the attestation
   key,            // string: The key of the attestation
   dataType,       // Optional, the data type of the attestation, 'string' | 'bytes' | 'number' | 'bool' | 'address'
-  contractAddress // Optional address: the contract address of the attestation station
+  contractAddress // Optional address: the contract address of AttestationStation
 )
 ```
 
@@ -193,7 +193,7 @@ These definitions allow you to communicate with AttestationStation, but are not
 #### `ATTESTATION_STATION_ADDRESS`
 
 
-The deployment address for the attestation station currently deployed with create2 on Optimism and Optimism Goerli `0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77`.
+The deployment address for AttestationStation currently deployed with create2 on Optimism and Optimism Goerli `0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77`.
 
 ```typescript
 import { ATTESTATION_STATION_ADDRESS } from '@eth-optimism/atst'
@@ -201,7 +201,7 @@ import { ATTESTATION_STATION_ADDRESS } from '@eth-optimism/atst'
 
 #### `abi`
 
-The abi of the attestation station contract
+The abi of the AttestationStation contract
 
 ```typescript
 import { abi } from '@eth-optimism/atst'
@@ -265,24 +265,26 @@ const bigNumberAttestation = stringifyAttestationBytes(
 )
 ```
 
-**Note:** `writeAttestation` already does this for you so this is only needed if using a library other than the attestation station.
+**Note:** `writeAttestation` already does this for you so this is only needed if using a library other than `atst`.
 
 ### React API
 
-For react hooks we recomend using the [wagmi cli](https://wagmi.sh/cli/getting-started) with the [etherscan plugin](https://wagmi.sh/cli/plugins/etherscan) and [react plugin](https://wagmi.sh/cli/plugins/react) to automatically generate react hooks around the attestation station.
+For react hooks we recomend using the [wagmi cli](https://wagmi.sh/cli/getting-started) with the [etherscan plugin](https://wagmi.sh/cli/plugins/etherscan) and [react plugin](https://wagmi.sh/cli/plugins/react) to automatically generate react hooks around AttestationStation.
 
-Use `createKey` and `createValue` to convert your raw keys and values into bytes that can be used in the attestation station contract calls.
-Use `parseString`, `parseBool`, `parseAddress` and `parseNumber` to convert values returned by attestation station to their correct data type.
+Use `createKey` and `createValue` to convert your raw keys and values into bytes that can be used in AttestationStation contract calls.
+Use `parseString`, `parseBool`, `parseAddress` and `parseNumber` to convert values returned by AttestationStation to their correct data type.
 
-For convenience we also [export the hooks](../src/react.ts) here:
+For convenience we also [export the hooks here](../src/react.ts):
 - `useAttestationStationAttestation` - Reads attestations with useContractRead
 - `useAttestationStationVersion` - Reads attestation version
-- `useAttestationStationAttest` - Wraps useContractWrite with attestation station abi calling attest
-- `usePrepareAttestationStationAttest` - Wraps usePrepare with attestation station abi calling attest
+- `useAttestationStationAttest` - Wraps useContractWrite with AttestationStation abi calling attest
+- `usePrepareAttestationStationAttest` - Wraps usePrepare with AttestationStation abi calling attest
 - `useAttestationStationAttestationCreatedEvent` - Wraps useContractEvents for Created events
 
 
 
 ## Tutorial
 
-For a tutorial on using the attestation station in general, see out tutorial as well as other Optimism related tutorials in our [optimism-tutorial](https://github.com/ethereum-optimism/optimism-tutorial/tree/main/ecosystem/attestation-station#key-values) repo.
+- [General atst tutorial](https://github.com/ethereum-optimism/optimism-tutorial/tree/main/ecosystem/attestation-station).
+- [React atst starter](https://github.com/ethereum-optimism/optimism-starter). 
+

packages/atst/package.json

@@ -59,5 +59,15 @@
     "@wagmi/core": "^0.9.2",
     "@wagmi/cli": "~0.1.5",
     "wagmi": "~0.11.0"
-  }
+  },
+  "keywords": [
+    "react",
+    "hooks",
+    "eth",
+    "ethereum",
+    "dapps",
+    "web3",
+    "optimism",
+    "attestation"
+  ]
 }