chore: add examples template

iosh · Sep 12, 2024 · f8363dc · f8363dc
1 parent e72ddcf
commit f8363dc
Show file tree

Hide file tree

Showing 9 changed files with 256 additions and 104 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,34 @@
+# Examples
+
+The `examples/` directory is a growing & living folder, and open for contributions.
+
+
+- Epoch
+  - [ ] Fetching Epoch
+  - [ ] Watching Epoch
+- Clients
+  - [ ] Public (w/ HTTP, WebSocket, Fallback)
+  - [ ] Wallet – JSON-RPC Account (`window.fluent`)
+  - [ ] Wallet - JSON-RPC Account (WalletConnect v2)
+- Contracts
+  - [ ] Deploying
+  - [ ] Reading
+  - [ ] Writing
+  - [ ] Multicall
+  - [ ] Call
+  - [ ] Events
+  - [ ] Simulating Method Calls
+- Filters & Logs
+  - [ ] Blocks
+  - [ ] Pending Transactions
+  - [ ] Events
+- Signatures
+  - [ ] Sign typed data
+    - [ ] + verify/recover address
+  - [ ] Sign message (+ recover message address)
+    - [ ] + verify/recover address
+- Transactions
+  - [ ] Fetching Transactions & Receipts
+  - [ ] Transaction Types (EIP-1559, Legacy, etc)
+  - [ ] Simulating Transactions
+  - [ ] Sending Transactions (& Waiting for Receipt)
diff --git a/examples/_template/README.md b/examples/_template/README.md
@@ -0,0 +1,3 @@
+# _REPLACE ME_ Example
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github.com/iosh/cive/tree/main/examples/PATH/TO/EXAMPLE/DIR)
diff --git a/examples/_template/index.html b/examples/_template/index.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  </head>
+  <body>
+    <h1>_REPLACE ME_ Example</h1>
+    <div id="app">Loading...</div>
+    <script type="module">
+      import out from './index.ts';
+      document.querySelector('#app').innerHTML = Array.isArray(out)
+        ? out.map(x => `<div style="margin-bottom: 16px;">${x}</div>`).join('')
+        : out;
+    </script>
+  </body>
+</html>
diff --git a/examples/_template/index.ts b/examples/_template/index.ts
@@ -0,0 +1,11 @@
+import { http, createPublicClient } from 'cive'
+import { mainnet } from 'cive/chains'
+
+const client = createPublicClient({
+  chain: mainnet,
+  transport: http(),
+})
+
+const epochNumber = await client.getEpochNumber()
+
+export default [`epoch number: ${epochNumber}`]
diff --git a/examples/_template/package.json b/examples/_template/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "example-template",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite"
+  },
+  "dependencies": {
+    "cive": "latest"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.3",
+    "vite": "^5.4.4"
+  }
+}
diff --git a/examples/_template/tsconfig.json b/examples/_template/tsconfig.json
@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "lib": ["ESNext", "DOM"],
+    "moduleResolution": "Node",
+    "strict": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "noEmit": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"]
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# _REPLACE ME_ Example

		[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github.com/iosh/cive/tree/main/examples/PATH/TO/EXAMPLE/DIR)