feat: document ts sdk and rename recipient to receiver (#2934)

.github/workflows/typescript-sdk-publish.yml

@@ -24,6 +24,8 @@ env:
 
 jobs:
   publish-jsr:
+    # manually temporarily disabled
+    if: false
     name: 'Publish JSR'
     runs-on: ['ubuntu-latest']
     permissions:
@@ -34,7 +36,13 @@ jobs:
       - name: 'Checkout'
         uses: actions/checkout@v4
 
+      - name: 'Setup bun'
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: 'latest'
+
       - name: 'Publish to JSR'
         working-directory: './typescript-sdk'
         run: |
-          npm_config_yes=true npx jsr publish --allow-slow-types
+          bun install
+          bun scripts/publish.ts --period patch

.gitignore

@@ -76,3 +76,4 @@ db.sqlite
 db.sqlite3*
 
 move/*/build
+.tsup

README.md

@@ -38,13 +38,16 @@ The upgradability of contracts on other chains, connections, token configuration
 | [`evm`](./evm)                     | [EVM] smart contract stack                           | [Solidity]            |
 | [`app`](./app)                     | [app.union.build]                                    | [TypeScript] [Svelte] |
 | [`site`](./site)                   | [union.build]                                        | [TypeScript] [Astro]  |
+| [`TypeScript SDK`](./typescript-sdk) | TypeScript SDK for interacting with Union          | [TypeScript]          |
 
 ## Quickstart
 
 Install [Nix] to _[reproducibly build](https://en.wikipedia.org/wiki/Reproducible_builds) any component_, and to enter a dev shell with _all dependencies_:
-```
+
+```sh
 curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
 ```
+
 _(Note that some components can only be built on Linux. If you are using macOS, we recommend using [OrbStack] to easily set up a [NixOS] VM within two minutes. Most Union developers use macOS with [OrbStack], and there is no need to install Nix inside of the [NixOS] VM.)_
 
 You can now _reproducibly_ build any of Union's components from source:
@@ -60,7 +63,7 @@ nix flake show
 
 The result of whatever you build will be in `result/`
 
-You can now also enter our dev shell, which has all of the dependencies (`cargo`, `rustc`, `node`, `go`, etc.) you need to work on any component: 
+You can now also enter our dev shell, which has all of the dependencies (`cargo`, `rustc`, `node`, `go`, etc.) you need to work on any component:
 _(Don't worry, this will not affect your system outside of this repo)_
 
 ```sh

app/app.nix

@@ -9,10 +9,10 @@
     {
       packages = {
         app = unstablePkgs.buildNpmPackage {
-          npmDepsHash = "sha256-o0iMZ4VvEDlj0OEoieLzZG4J2eeTF4EMRWrYI15e2RY=";
+          npmDepsHash = "sha256-5wMINt346EVAAPt32eRsFvF7m6rH6taeE55Z9tEme1A=";
           src = ./.;
           sourceRoot = "app";
-          npmFlags = [ "--legacy-peer-deps" ];
+          npmFlags = [ "--legacy-peer-deps" "--ignore-scripts" ];
           pname = packageJSON.name;
           version = packageJSON.version;
           nativeBuildInputs = combinedDeps;