Introduces SuiNS SDK

scripts/.eslintrc.cjs → .eslintrc.cjs

@@ -30,6 +30,8 @@ module.exports = {
 		'external-crates',
 		'storybook-static',
 		'.next',
+		'documentation',
+		'packages',
 	],
 	rules: {
 		'no-case-declarations': 'off',

.github/workflows/move_test.yml

@@ -2,58 +2,58 @@ name: Move Test CI
 
 on:
   pull_request:
-      paths:
-        - '.github/workflows/**'
-        - 'packages/**'
+    paths:
+      - '.github/workflows/move_test.yml'
+      - 'packages/**'
   push:
     branches:
       - main
 
 concurrency:
-    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
-    cancel-in-progress: true
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
 
 jobs:
   test:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 1
-
-    - name: Install Homebrew
-      run: |
-        /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
-        echo "/home/linuxbrew/.linuxbrew/bin" >> $GITHUB_PATH
-
-    - name: Install Sui using Homebrew
-      run: brew install sui
-
-    - name: Run move tests in all package subdirectories, with exclusions
-      run: |
-        exclude_dirs=(governance) # Add excluded directories to this array
-        for dir in packages/*; do
-          dir_name=$(basename "$dir")
-          if [[ ! " ${exclude_dirs[@]} " =~ " ${dir_name} " ]] && [ -d "$dir" ]; then
-            echo "Running sui move test in $dir"
-            (cd "$dir" && sui move test)
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Install Homebrew
+        run: |
+          /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+          echo "/home/linuxbrew/.linuxbrew/bin" >> $GITHUB_PATH
+
+      - name: Install Sui using Homebrew
+        run: brew install sui
+
+      - name: Run move tests in all package subdirectories, with exclusions
+        run: |
+          exclude_dirs=(governance) # Add excluded directories to this array
+          for dir in packages/*; do
+            dir_name=$(basename "$dir")
+            if [[ ! " ${exclude_dirs[@]} " =~ " ${dir_name} " ]] && [ -d "$dir" ]; then
+              echo "Running sui move test in $dir"
+              (cd "$dir" && sui move test)
+            fi
+          done
+
+      - name: Run documentation script
+        run: |
+          bash ./scripts/docgen.sh
+        shell: bash
+
+      - name: Check for changes in move-docs directories
+        run: |
+          output=$(git status --porcelain | grep ' packages/.*/move-docs/' || true)
+          echo "Filtered git status output: $output"
+          if [[ -n "$output" ]]; then
+            echo "Changes in move-docs directories are not committed. Please commit these changes by running scripts/docgen.sh before merging."
+            exit 1  # Fail the job to indicate that documentation is not up-to-date
+          else
+            echo "No changes in move-docs directories. Documentation is up-to-date."
           fi
-        done
-
-    - name: Run documentation script
-      run: |
-        bash ./scripts/docgen.sh
-      shell: bash
-
-    - name: Check for changes in move-docs directories
-      run: |
-        output=$(git status --porcelain | grep ' packages/.*/move-docs/' || true)
-        echo "Filtered git status output: $output"
-        if [[ -n "$output" ]]; then
-          echo "Changes in move-docs directories are not committed. Please commit these changes by running scripts/docgen.sh before merging."
-          exit 1  # Fail the job to indicate that documentation is not up-to-date
-        else
-          echo "No changes in move-docs directories. Documentation is up-to-date."
-        fi
-      shell: bash
+        shell: bash

.github/workflows/sdk_test.yml

@@ -3,15 +3,15 @@ name: SDK Tests CI
 on:
   pull_request:
     paths:
-      - '.github/workflows/**'
+      - '.github/workflows/sdk_test.yml'
       - 'sdk/**'
   push:
     branches:
       - main
 
-concurrency: 
-    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
-    cancel-in-progress: true
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
 
 jobs:
   sdk_test:
@@ -23,3 +23,27 @@ jobs:
         with:
           fetch-depth: 1
 
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Do a global PNPM install
+        run: |
+          npm install -g pnpm
+
+      - name: Install Dependencies
+        run: |
+          pnpm install
+
+      - name: Download & Extract latest SUI binary
+        run: |
+          url=$(curl -s https://api.github.com/repos/mystenlabs/sui/releases/latest  | jq -r '.assets[] | select(.name | contains("ubuntu")) | .browser_download_url')
+          filename="sui-x86-64.tgz"
+          wget $url -O $filename
+          tar -xzf $filename
+          ls
+          ./sui -V
+
+      - name: Prepare local network & run SDK tests
+        run: |
+          ./sui-test-validator --epoch-duration-ms 300000 > /dev/null 2>&1 & cd sdk && VITE_SUI_BIN="../sui" pnpm test:e2e

.github/workflows/suins-build-tx.yaml

@@ -83,7 +83,7 @@ jobs:
 
       - name: Set up working directory
         run: |
-          cd scripts && pnpm install
+          pnpm install
 
       - name: Main Package Upgrade
         if: ${{ inputs.transaction_type == 'Main package upgrade' }}
@@ -93,7 +93,7 @@ jobs:
           NETWORK: mainnet
           ORIGIN: gh_action
         run: |
-          cd scripts && pnpm transactions::main_package::upgrade 
+          cd scripts && pnpm transactions::main_package::upgrade
 
       - name: Transfer Reserved Names
         if: ${{ inputs.transaction_type == 'Transfer Reserved Names' }}
@@ -104,7 +104,7 @@ jobs:
           ORIGIN: gh_action
         run: |
           cd scripts && pnpm transfer::names
-    
+
       - name: Profits to Treasury
         if: ${{ inputs.transaction_type == 'Profits to Treasury' }}
         env:
@@ -134,7 +134,7 @@ jobs:
           ORIGIN: gh_action
         run: |
           cd scripts && pnpm disable-free-claims
-        
+
       - name: Disable Discounts
         if: ${{ inputs.transaction_type == 'Disable Discounts' }}
         env:

.gitignore

@@ -13,3 +13,4 @@ tx-data.txt*
 .DS_STORE*
 published.json
 constants.sdk.json
+dist

scripts/.prettierignore → .prettierignore

@@ -9,7 +9,5 @@ build/
 coverage/
 dist/
 out/
-playwright-report/
-storybook-static/
 CHANGELOG.md
-
+documentation/

documentation/pages/subnames.mdx

@@ -41,9 +41,3 @@ The following table provides more details on the differences between the two typ
 
 Similar to regular names, you can look up subnames through JSON-RPC and GraphQL. You can also look up subnames on chain, as described in [Integrations](./integration.mdx).
 
-
-{/* ## Creating subnames
-
-TODO: Show how someone could create subnames through the SDK (being the parent).
-
-TODO: Show how someone can integrate with the subdomains package to create subnames. */}

package.json

@@ -0,0 +1,36 @@
+{
+	"name": "suins-monorepo",
+	"version": "1.0.0",
+	"description": "This repository holds the SuiNS contracts (both the core and all system packages).",
+	"main": "index.js",
+	"devDependencies": {
+		"typescript": "^5.4.5",
+		"@ianvs/prettier-plugin-sort-imports": "^4.2.1",
+		"@types/node": "^20.11.30",
+		"@typescript-eslint/eslint-plugin": "^7.7.1",
+		"@typescript-eslint/parser": "^7.7.1",
+		"eslint-config-prettier": "^9.1.0",
+		"eslint-config-react-app": "^7.0.1",
+		"eslint-import-resolver-typescript": "^3.6.1",
+		"eslint-plugin-header": "^3.1.1",
+		"eslint-plugin-import": "^2.29.1",
+		"eslint-plugin-prettier": "^5.1.3",
+		"eslint-plugin-require-extensions": "^0.1.3",
+		"eslint-plugin-tsdoc": "^0.2.17",
+		"eslint-plugin-unused-imports": "^3.1.0",
+		"prettier": "^3.2.5",
+		"ts-node": "^10.9.1"
+	},
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1",
+		"prettier:check": "prettier -c --ignore-unknown .",
+		"prettier:fix": "prettier -w --ignore-unknown .",
+		"prettier:fix:watch": "onchange '**' -i -f add -f change -j 5 -- prettier -w --ignore-unknown {{file}}",
+		"eslint:check": "eslint --max-warnings=0 .",
+		"eslint:fix": "pnpm run eslint:check --fix",
+		"lint": "pnpm run eslint:check && pnpm run prettier:check",
+		"lint:fix": "pnpm run eslint:fix && pnpm run prettier:fix"
+	},
+	"author": "",
+	"license": "Apache-2.0"
+}