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

707b0cc0 · Ori Pomerantz · dfcd8feb · 707b0cc0 · 707b0cc0 · 707b0cc0
Commit 707b0cc0 authored Mar 08, 2023 by Ori Pomerantz
Showing with 236 additions and 209 deletions

README.md packages/atst/README.md +28 -20

cli.md packages/atst/docs/cli.md +32 -41

sdk.md packages/atst/docs/sdk.md +165 -147

package.json packages/atst/package.json +11 -1

No files found.
--- a/packages/atst/README.md
+++ b/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) 
--- a/packages/atst/docs/cli.md
+++ b/packages/atst/docs/cli.md
@@ -14,10 +14,10 @@ npm install @eth-optimism/atst --global
 npx atst <command> [options]
 ```
-## Commands
+### Commands
-read read an attestation
+- `read` read an attestation
-write write an attestation
+- `write` write an attestation
 For more info, run any command with the `--help` flag:
@@ -26,55 +26,46 @@ npx atst read --help
 npx atst write --help
 ```
-## Options:
+### General options
-h, --help Display this message
+- `-h`, `--help` Display help message
-v, --version Display version number
+- `-v`, `--version` Display version number
-## Usage:
-```bash
-npx atst <command> [options]
-```
-Commands:
-read read an attestation
-write write an attestation
-For more info, run any command with the `--help` flag:
-```bash
-npx atst read --help
-npx atst write --help
-```
 ### Read
-`--creator <string> Address of the creator of the attestation`
+- `--creator <address>` Address of the creator of the attestation
-`--about <string> Address of the subject of the attestation`
+- `--about <address>` Address of the subject of the attestation
-`--key <string> Key of the attestation either as string or hex number`
+- `--key <string>` Key of the attestation either as string or hex number
-`--data-type [string] Zod validator for the DataType type string | bytes | number | bool | address (default: string)`
+- `[--data-type <string>]` The DataType type `string` | `bytes` | `number` | `bool` | `address` (default: `string`)
-`--rpc-url [url] Rpc url to use (default: https://mainnet.optimism.io)`
+- `[--rpc-url <url>]` Rpc url to use (default: `https://mainnet.optimism.io`)
-`--contract [address] Contract address to read from (default: 0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77)`
+- `[--contract <address>]` Contract address to read from (default: `0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77`)
-`-h, --help Display this message`
+- `-h`, `--help` Display help message
 Example:
 ```bash
-npx atst read --key "optimist.base-uri" --about 0x2335022c740d17c2837f9C884Bfe4fFdbf0A95D5 --creator 0x60c5C9c98bcBd0b0F2fD89B24c16e533BaA8CdA3
+npx atst read --key "optimist.base-uri" --about 0x2335022c740d17c2837f9C884Bfe4fFdbf0A95D5 \
+    --creator 0x60c5C9c98bcBd0b0F2fD89B24c16e533BaA8CdA3
 ```
-### write
+### Write
+- `--private-key <string>` Private key of the creator of the attestation
+- `[--data-type <string>]` The DataType type `string` | `bytes` | `number` | `bool` | `address` (default: `string`)
+- `--about <address>` Address of the subject of the attestation
+- `--key <address>` Key of the attestation either as string or hex number
+- `--value <string>` undefined
+- `[--rpc-url <url>]` Rpc url to use (default: `https://mainnet.optimism.io`)
+- `[--contract <address>]` Contract address to read from (default: 0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77) 
+- `-h`, `--help` Display this message
-`--private-key <string> Address of the creator of the attestation`
+Example: 
-`--data-type [string] Zod validator for the DataType type string | bytes | number | bool | address (default: string)`
-`--about <string> Address of the subject of the attestation`
-`--key <string> Key of the attestation either as string or hex number`
-`--value <string> undefined`
-`--rpc-url [url] Rpc url to use (default: https://mainnet.optimism.io)`
-`--contract [address] Contract address to read from (default: 0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77) -h, --help Display this message`
 ```bash
-atst write --key "optimist.base-uri" --about 0x2335022c740d17c2837f9C884Bfe4fFdbf0A95D5 --value "my attestation" --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 --rpc-url http://localhost:8545
+npx atst write --key "optimist.base-uri" \
-atst/0.0.0
+    --about 0x2335022c740d17c2837f9C884Bfe4fFdbf0A95D5 \
+    --value "my attestation" \
+    --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 \
+    --rpc-url http://goerli.optimism.io
 ```
\ No newline at end of file
--- a/packages/atst/docs/sdk.md
+++ b/packages/atst/docs/sdk.md
--- a/packages/atst/package.json
+++ b/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"
+  ]
 }