Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 64 additions & 9 deletions .github/workflows/release-typescript-sdk.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ jobs:
outputs:
sdk_version: ${{ steps.sdk-version.outputs.value }}
publish_release: ${{ steps.release-mode.outputs.value }}
sdk_already_published: ${{ steps.sdk-presence.outputs.value }}
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down Expand Up @@ -93,10 +94,31 @@ jobs:
exit 1
fi

- name: Check whether SDK package version already exists on npm
id: sdk-presence
shell: bash
run: |
set -euo pipefail
if [[ "${{ steps.release-mode.outputs.value }}" != "true" ]]; then
echo "value=false" >> "${GITHUB_OUTPUT}"
exit 0
fi

package_name="$(node -p "require('./${SDK_DIRECTORY}/package.json').name")"
package_version="${{ steps.sdk-version.outputs.value }}"
if pnpm view "${package_name}@${package_version}" version >/dev/null 2>&1; then
echo "value=true" >> "${GITHUB_OUTPUT}"
echo ">>> ${package_name}@${package_version} already exists on npm; SDK verification/publish steps will skip where possible."
else
echo "value=false" >> "${GITHUB_OUTPUT}"
fi

- name: Install workspace dependencies
if: steps.sdk-presence.outputs.value != 'true'
run: pnpm install --frozen-lockfile

- name: Run TypeScript SDK checks
if: steps.sdk-presence.outputs.value != 'true'
run: pnpm --dir "${SDK_DIRECTORY}" run check

publish-native:
Expand Down Expand Up @@ -130,11 +152,6 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Rust CI toolchain and tools
uses: ./.github/actions/rust-ci-setup
with:
cargo-tools: cargo-make,cargo-nextest

- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
Expand All @@ -148,11 +165,33 @@ jobs:
cache-dependency-path: pnpm-lock.yaml
registry-url: https://registry.npmjs.org

- name: Check whether native runtime package version already exists on npm
id: native-package-presence
if: needs.verify.outputs.publish_release == 'true'
shell: bash
run: |
set -euo pipefail
package_name="${{ matrix.package_name }}"
package_version="${{ needs.verify.outputs.sdk_version }}"
if pnpm view "${package_name}@${package_version}" version >/dev/null 2>&1; then
echo "value=true" >> "${GITHUB_OUTPUT}"
echo ">>> ${package_name}@${package_version} already exists on npm; skipping native runtime build/publish."
else
echo "value=false" >> "${GITHUB_OUTPUT}"
fi

- name: Setup Rust CI toolchain and tools
if: needs.verify.outputs.publish_release != 'true' || steps.native-package-presence.outputs.value != 'true'
uses: ./.github/actions/rust-ci-setup
with:
cargo-tools: cargo-make,cargo-nextest

- name: Install workspace dependencies
if: needs.verify.outputs.publish_release != 'true' || steps.native-package-presence.outputs.value != 'true'
run: pnpm install --frozen-lockfile

- name: Publish native runtime package
if: needs.verify.outputs.publish_release == 'true'
if: needs.verify.outputs.publish_release == 'true' && steps.native-package-presence.outputs.value != 'true'
working-directory: ${{ matrix.package_dir }}
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
Expand Down Expand Up @@ -189,11 +228,27 @@ jobs:
cache-dependency-path: pnpm-lock.yaml
registry-url: https://registry.npmjs.org

- name: Check whether SDK package version already exists on npm
id: sdk-package-presence
if: needs.verify.outputs.publish_release == 'true'
shell: bash
run: |
set -euo pipefail
package_name="$(node -p "require('./${SDK_DIRECTORY}/package.json').name")"
package_version="${{ needs.verify.outputs.sdk_version }}"
if pnpm view "${package_name}@${package_version}" version >/dev/null 2>&1; then
echo "value=true" >> "${GITHUB_OUTPUT}"
echo ">>> ${package_name}@${package_version} already exists on npm; skipping SDK install/publish."
else
echo "value=false" >> "${GITHUB_OUTPUT}"
fi

- name: Install workspace dependencies
if: needs.verify.outputs.publish_release != 'true' || steps.sdk-package-presence.outputs.value != 'true'
run: pnpm install --frozen-lockfile

- name: Wait for native packages to index on npm
if: needs.verify.outputs.publish_release == 'true'
if: needs.verify.outputs.publish_release == 'true' && steps.sdk-package-presence.outputs.value != 'true'
shell: bash
run: |
set -euo pipefail
Expand All @@ -206,7 +261,7 @@ jobs:
local pkg="$1"
local attempt
for attempt in $(seq 1 30); do
if npm view "${pkg}@${version}" version >/dev/null 2>&1; then
if pnpm view "${pkg}@${version}" version >/dev/null 2>&1; then
echo ">>> ${pkg}@${version} is visible on npm"
return 0
fi
Expand Down Expand Up @@ -237,7 +292,7 @@ jobs:
fi

- name: Publish TypeScript SDK
if: needs.verify.outputs.publish_release == 'true'
if: needs.verify.outputs.publish_release == 'true' && steps.sdk-package-presence.outputs.value != 'true'
working-directory: ${{ env.SDK_DIRECTORY }}
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
Expand Down
4 changes: 3 additions & 1 deletion sdks/typescript/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# `@lythaeon-sof/sdk`

TypeScript SDK for building apps with a typed `App`, `Plugin`, `runtime`, and `derivedState` model.
TypeScript SDK for building Node.js Solana observer apps on top of SOF.

These apps ingest Solana data from websocket, gRPC, gossip, or direct-shred sources, run typed plugins and derived state, and execute on the packaged SOF runtime host without requiring app authors to touch the Rust code underneath.

## Tooling

Expand Down
4 changes: 2 additions & 2 deletions sdks/typescript/RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Use `ts-sdk-vX.Y.Z` tags for npm releases.
Examples:

```sh
git tag ts-sdk-v0.1.1
git push origin ts-sdk-v0.1.1
git tag ts-sdk-v0.1.2
git push origin ts-sdk-v0.1.2
```

The release workflow rejects tags that do not match `sdks/typescript/package.json`.
Expand Down
2 changes: 1 addition & 1 deletion sdks/typescript/native/darwin-arm64/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lythaeon-sof/sdk-native-darwin-arm64",
"version": "0.1.1",
"version": "0.1.2",
"license": "MIT OR Apache-2.0",
"description": "Native SOF runtime host for @lythaeon-sof/sdk on macOS arm64",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion sdks/typescript/native/darwin-x64/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lythaeon-sof/sdk-native-darwin-x64",
"version": "0.1.1",
"version": "0.1.2",
"license": "MIT OR Apache-2.0",
"description": "Native SOF runtime host for @lythaeon-sof/sdk on macOS x64",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion sdks/typescript/native/linux-arm64/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lythaeon-sof/sdk-native-linux-arm64",
"version": "0.1.1",
"version": "0.1.2",
"license": "MIT OR Apache-2.0",
"description": "Native SOF runtime host for @lythaeon-sof/sdk on Linux arm64",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion sdks/typescript/native/linux-x64/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lythaeon-sof/sdk-native-linux-x64",
"version": "0.1.1",
"version": "0.1.2",
"license": "MIT OR Apache-2.0",
"description": "Native SOF runtime host for @lythaeon-sof/sdk on Linux x64",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion sdks/typescript/native/win32-arm64/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lythaeon-sof/sdk-native-win32-arm64",
"version": "0.1.1",
"version": "0.1.2",
"license": "MIT OR Apache-2.0",
"description": "Native SOF runtime host for @lythaeon-sof/sdk on Windows arm64",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion sdks/typescript/native/win32-x64/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lythaeon-sof/sdk-native-win32-x64",
"version": "0.1.1",
"version": "0.1.2",
"license": "MIT OR Apache-2.0",
"description": "Native SOF runtime host for @lythaeon-sof/sdk on Windows x64",
"repository": {
Expand Down
4 changes: 2 additions & 2 deletions sdks/typescript/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@lythaeon-sof/sdk",
"version": "0.1.1",
"description": "TypeScript App SDK",
"version": "0.1.2",
"description": "TypeScript SDK for Node.js Solana observer apps on SOF",
"license": "MIT OR Apache-2.0",
"sideEffects": false,
"packageManager": "pnpm@10.28.2",
Expand Down
Loading