Sub vaults

.github/workflows/build-check.yml

@@ -13,15 +13,15 @@ jobs:
       packages: read
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd
 
       - name: Setup pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@b906affcce14559ad1aafd4ab0e942779e9f58b1
         with:
           version: 10.25.0
 
       - name: Setup Node
-        uses: actions/setup-node@v6
+        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f
         with:
           node-version: '24.12.0'
 

.github/workflows/unit-tests.yml

@@ -13,15 +13,15 @@ jobs:
         packages: read
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v4
+        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd
 
       - name: Setup pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@b906affcce14559ad1aafd4ab0e942779e9f58b1
         with:
           version: 10.25.0
 
       - name: Setup Node
-        uses: actions/setup-node@v6
+        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f
         with:
           cache: pnpm
           scope: '@stakewise'

.graphqlconfig

@@ -11,7 +11,7 @@
   "extensions": {
     "endpoints": {
       "Subgraph GraphQL": {
-        "url": "https://graphs.stakewise.io/hoodi/subgraphs/name/stakewise/prod",
+        "url": "https://graphs-replica.stakewise.io/hoodi/subgraphs/name/stakewise/stage",
         "headers": {
           "user-agent": "JS GraphQL"
         },

.husky/pre-commit

@@ -1,3 +1,3 @@
 sh ./scripts/pre-push.sh
-
-npm run lint
+pnpm run check:docLinks
+pnpm run lint

changelog/next-release.md

@@ -0,0 +1,23 @@
+## Added methods
+
+- [sdk.vault.getSubVaults](https://docs.stakewise.io/sdk/api/vault/requests/getsubvaults)
+- [sdk.vault.addSubVault](https://docs.stakewise.io/sdk/api/vault/transactions/addsubvault)
+- [sdk.vault.rejectSubVault](https://docs.stakewise.io/sdk/api/vault/transactions/rejectsubvault)
+- [sdk.vault.ejectSubVault](https://docs.stakewise.io/sdk/api/vault/transactions/ejectsubvault)
+- [sdk.vault.updateState](https://docs.stakewise.io/sdk/api/vault/transactions/updatestate)
+
+## Modified methods
+
+### 1. [sdk.vault.getVault](https://docs.stakewise.io/sdk/api/vault/requests/getvault)
+
+#### Add output field:
+```ts
+type Output = {
+  canHarvest: boolean
+  exitingAssets: string
+  exitingTickets: string
+  ejectingSubVault: string
+  subVaultsRegistry: string
+  pendingMetaSubVault: string
+}
+```

codegen.ts

@@ -2,8 +2,8 @@ import type { CodegenConfig } from '@graphql-codegen/cli'
 import { Network } from './src/helpers/enums'
 import configs from './src/helpers/configs'
 
-
-let network: Network = Network.Mainnet
+// TODO change
+let network: Network = Network.Hoodi
 
 if (process.env.NETWORK === 'mainnet') {
   network = Network.Mainnet

documentation/03-quick-start/_category_.json

@@ -0,0 +1,3 @@
+{
+  "label": "Quick Start"
+}

package.json

@@ -1,6 +1,6 @@
 {
   "type": "module",
-  "version": "4.2.2",
+  "version": "4.2.4",
   "sideEffects": false,
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,6 +20,7 @@
     "graphql": "graphql-codegen && tsx ./scripts/generateGraphqlExports/index.ts",
     "rollup": "rollup --config rollup.config.js",
     "check:version": "node ./scripts/checkVersion.js",
+    "check:docLinks": "node ./scripts/checkDocLinks.js",
     "lint": "eslint ./src --ext .ts,.tsx,.js,.jsx",
     "release": "pnpm build && pnpm publish --tag=latest",
     "sync:docs": "tsx ./scripts/syncDocs/index.ts"

scripts/checkDocLinks.js

@@ -0,0 +1,144 @@
+import path from 'path'
+import https from 'https'
+import { fileURLToPath } from 'url'
+import { execSync } from 'child_process'
+
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+// eslint-disable-next-line no-restricted-syntax
+const docsUrl = 'https://docs.stakewise.io'
+
+const srcDir = path.resolve(__dirname, '../src')
+
+const fetchSitemap = () => {
+  const sitemapUrl = `${docsUrl}/sitemap.xml`
+
+  return new Promise((resolve, reject) => {
+    https
+      .get(sitemapUrl, (res) => {
+        let data = ''
+
+        res.on('data', (chunk) => data += chunk)
+        res.on('end', () => {
+          const matches = data.match(/<loc>([^<]+)/g) || []
+
+          const urls = matches.map((match) => {
+            return match
+              .replace('<loc>', '')
+              .replace(/\/$/, '')
+              .toLowerCase()
+          })
+
+          resolve(urls)
+        })
+      })
+      .on('error', reject)
+  })
+}
+
+const getSdkApiSlugs = () => {
+  try {
+    const output = execSync(
+      `grep -r "^slug:" "${srcDir}" --include="*.md"`,
+      { encoding: 'utf-8' }
+    )
+
+    const slugs = output
+      .split('\n')
+      .filter(Boolean)
+      .map((line) => line.replace(/.*slug:\s*/, '').trim().replace(/\/$/, '').toLowerCase())
+
+    const brokenSlugs = slugs.filter((slug) => !slug.startsWith('/'))
+
+    if (brokenSlugs.length) {
+      console.log('🚫 Slugs must start with /:')
+      brokenSlugs.forEach((slug) => console.log(`${slug}`))
+      process.exit(1)
+    }
+
+    return slugs.filter((slug) => slug.startsWith('/sdk/api/'))
+  }
+  catch {
+    return []
+  }
+}
+
+const getUrls = () => {
+  const rootDir = path.resolve(__dirname, '..')
+
+  try {
+    const output = execSync(
+      `grep -roh "https://docs\\.stakewise\\.io/[^\\"' )\\\`>]*" "${rootDir}" `
+      + '--include="*.ts" --include="*.tsx" --include="*.md" --include="*.mdx" '
+      + '--exclude-dir=node_modules',
+      { encoding: 'utf-8' }
+    )
+
+    return [ ...new Set(
+      output
+        .split('\n')
+        .map((url) => url.replace(/[.,;)]+$/, ''))
+        .filter((url) => url && url !== docsUrl && url !== `${docsUrl}/`)
+    )]
+  }
+  catch {
+    return []
+  }
+}
+
+const checkDocLinks = async () => {
+  const urls = getUrls()
+
+  if (!urls.length) {
+    console.log('No docs links found.')
+
+    return
+  }
+
+  const slugs = getSdkApiSlugs()
+  const broken = []
+
+  let sitemap = null
+
+  for (const url of urls) {
+    const urlPath = url.replace(docsUrl, '').replace(/[#?].*$/, '').replace(/\/$/, '').toLowerCase()
+
+    if (slugs.includes(urlPath)) {
+      continue
+    }
+
+    // Not found in local slugs — check against live sitemap
+    if (!sitemap) {
+      sitemap = await fetchSitemap()
+    }
+
+    if (!sitemap.includes(`${docsUrl}${urlPath}`)) {
+      broken.push(url)
+    }
+  }
+
+  if (broken.length) {
+    broken.forEach((url) => console.log(url))
+    console.log(`\n🚫 Found ${broken.length} broken link(s)!`)
+    process.exit(1)
+  }
+
+  console.log('✅ All docs links are valid.')
+
+  // Warn if staged md files were changed
+  try {
+    const stagedMd = execSync('git diff --cached --name-only -- "src/**/*.md" "documentation/**/*.md"', { encoding: 'utf-8' }).trim()
+
+    if (stagedMd) {
+      const warn = (text) => console.log(`\x1b[33m${text}\x1b[0m`)
+
+      console.log()
+      warn('⚠️SDK docs were changed! ⚠️')
+      warn("Don't forget to run: pnpm sync:docs")
+    }
+  }
+  catch {}
+}
+
+checkDocLinks()