Initial work: Repository setup, documentation, core/query, core/keys, core/chain

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.5/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/workflows/checks.yml

@@ -0,0 +1,40 @@
+name: Checks
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: Build
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+      - name: Install dependencies
+        run: yarn install --immutable
+      - name: Run codegen
+        run: yarn codegen
+      - name: Run build
+        run: yarn build
+  lint:
+    name: Lint
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+      - name: Install dependencies
+        run: yarn install --immutable
+      - name: Run codegen
+        run: yarn codegen
+      - name: Run lint
+        run: yarn lint

.github/workflows/deploy-docs.yml

@@ -0,0 +1,44 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+      - name: Install dependencies
+        working-directory: ./docs
+        run: yarn install --immutable
+      - name: Run build
+        working-directory: ./docs
+        run: yarn build
+      - name: Upload build artifacts
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/build'
+  deploy:
+    name: Deploy
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/examples.yml

@@ -0,0 +1,66 @@
+name: Examples
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: Build
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+      - name: Install dependencies
+        run: yarn install --immutable
+      - name: Run codegen
+        run: yarn codegen
+      - name: Run build
+        run: yarn build
+      - name: Build examples
+        run: yarn build:examples
+      - name: Ensure the repository contains up-to-date example builds
+        run: ./scripts/check-git-diff.sh
+  run_ts:
+    name: Run examples (TypeScript)
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+      - name: Install dependencies
+        run: yarn install --immutable
+      - name: Run codegen
+        run: yarn codegen
+      - name: Run examples
+        run: echo "TBD"
+  run_js:
+    name: Run examples (JavaScript)
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+      - name: Install dependencies
+        run: yarn install --immutable
+      - name: Run codegen
+        run: yarn codegen
+      - name: Run build
+        run: yarn build
+      - name: Build examples
+        run: yarn build:examples
+      - name: Run examples
+        run: echo "TBD"

.github/workflows/tests.yml

@@ -0,0 +1,43 @@
+name: Tests
+on: [push, pull_request]
+
+jobs:
+  test-sdk:
+    name: SDK Tests
+    strategy:
+      matrix:
+        os: ['ubuntu-latest']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+      - name: Install dependencies
+        run: yarn install --immutable
+      - name: Run codegen
+        run: yarn codegen
+      - name: Run build
+        run: yarn build
+      - name: Setup testing environment
+        run: yarn test:setup
+      - name: Run tests
+        run: yarn test:sdk
+  test-snippets:
+    name: Docs code snippets tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+      - name: Install dependencies
+        run: yarn install --immutable
+      - name: Install /docs dependencies
+        working-directory: ./docs
+        run: yarn install --immutable
+      - name: Test snippets
+        run: yarn test:snippets

.gitignore

@@ -0,0 +1,12 @@
+node_modules
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+examples/**/.env
+**/__generated__
+**/lib
+**/*.tsbuildinfo

.prettierignore

@@ -0,0 +1,2 @@
+.yarn
+**/schema.graphql

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "eslint.workingDirectories": [".", "./packages/*"],
+  "editor.formatOnSave": true
+}

.yarnrc.yml

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.6.0.cjs

README.md

@@ -1,2 +1,7 @@
-# sdk
-Cre functionality needed to create Joystream apps
+# Joystream SDK
+
+https://classic.yarnpkg.com/lang/en/docs/
+https://jestjs.io/docs
+https://changesets-docs.vercel.app/
+https://eslint.org/docs/latest/
+https://prettier.io/docs/

docs/.gitignore

@@ -0,0 +1,21 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.yarn/install-state.gz

docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/docs/core/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "@joystream/sdk-core",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Core utilities for Joystream development"
+  }
+}