feat: improve typescript sdk docs (#2946)

unionlabs · Sep 12, 2024 · a1ca6c0 · a1ca6c0
2 parents 38cfe9f + d845952
commit a1ca6c0
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 12 deletions.
diff --git a/docs/src/content/docs/integrations/typescript/index.mdx b/docs/src/content/docs/integrations/typescript/index.mdx
@@ -9,13 +9,13 @@ import { Tabs, TabItem } from '@astrojs/starlight/components'
 <PackageManagers
   type="add"
   frame="none"
-  pkg="@unionlabs/client"
+  pkg="@unionlabs/client@latest"
   pkgManagers={['npm', 'pnpm', 'bun', 'yarn']}
 />
 
-The Union client is TypeScript-first and framework agnostic.
+The Union Client is TypeScript-first and framework agnostic.
 At [app.union.build](https://app.union.build) we use [Svelte](https://svelte.dev) but you can use any framework or no frameworks at all.
-If you're a [React](https://reactjs.org) user, [checkout this demo on Stackblitz](https://stackblitz.com/edit/github-nav3yr-xbanxq?file=src%2Fapp.tsx).
+If you're a [React](https://reactjs.org) developer, [checkout this demo on Stackblitz](https://stackblitz.com/edit/github-nav3yr-xbanxq?file=src%2Fapp.tsx).
 
 :::note
 
@@ -140,10 +140,14 @@ console.info(`Transfer hash: ${transfer.value}`)
 import { privateKeyToAccount } from "viem/accounts"
 import { createUnionClient, http } from "@unionlabs/client"
 
+let PRIVATE_KEY = process.env["PRIVATE_KEY"]
+if (!PRIVATE_KEY) throw new Error("PRIVATE_KEY is not set")
+PRIVATE_KEY = PRIVATE_KEY.startsWith("0x") ? PRIVATE_KEY : `0x${PRIVATE_KEY}`
+
 export const unionClient = createUnionClient({
   chainId: "80084",
-  transport: http("https://bartio.rpc.berachain.com"),
-  account: privateKeyToAccount(`0x${process.env.PRIVATE_KEY}`),
+  account: privateKeyToAccount(PRIVATE_KEY),
+  transport: http("https://bartio.rpc.berachain.com")
 })
 ```
   </TabItem>
@@ -152,5 +156,5 @@ export const unionClient = createUnionClient({
 Run the above example
 
 ```bash frame="none"
-PRIVATE_KEY= npm_config_yes=true npx tsx main.ts
+PRIVATE_KEY="" npm_config_yes=true npx tsx main.ts
 ```
diff --git a/typescript-sdk/bun.lockb b/typescript-sdk/bun.lockb
diff --git a/typescript-sdk/jsr.json b/typescript-sdk/jsr.json
@@ -1,7 +1,7 @@
 {
   "$schema": "https://jsr.io/schema/config-file.v1.json",
   "name": "@union/client",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "license": "MIT",
   "exports": {
     ".": "./src/mod.ts"

diff --git a/typescript-sdk/package.json b/typescript-sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@unionlabs/client",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "homepage": "https://jsr.io/@union/client",
   "description": "Union Labs cross-chain transfers client",
   "type": "module",
@@ -36,7 +36,7 @@
     "@scure/base": "1.1.8",
     "neverthrow": "^8.0.0",
     "ofetch": "^1.3.4",
-    "viem": "^2.21.4"
+    "viem": "^2.21.6"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.16.2",
@@ -48,13 +48,13 @@
     "@types/node": "^22.5.4",
     "consola": "^3.2.3",
     "cosmjs-types": "^0.9.0",
-    "jsr": "^0.13.1",
+    "jsr": "^0.13.2",
     "patch-package": "^8.0.0",
     "tsup": "^8.2.4",
-    "tsx": "^4.19.0",
+    "tsx": "^4.19.1",
     "typescript": "^5.6.2",
     "vite-tsconfig-paths": "^5.0.1",
-    "vitest": "^2.0.5"
+    "vitest": "^2.1.0"
   },
   "repository": {
     "type": "git",