diff --git a/.github/workflows/deploydocs.yml b/.github/workflows/deploydocs.yml deleted file mode 100644 index 46a1170bc..000000000 --- a/.github/workflows/deploydocs.yml +++ /dev/null @@ -1,62 +0,0 @@ -name: Deploy Docs - -on: - push: - branches: - - main - - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages -permissions: - contents: write - pages: write - id-token: write - -# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. -# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. -concurrency: - group: "pages" - cancel-in-progress: false - -jobs: - build_docs: - name: Build Docs - environment: - # environment created automatically by GitHub - name: github-pages - runs-on: ubuntu-latest - steps: - - name: Checkout Repo - uses: actions/checkout@v3 - with: - fetch-depth: 0 # Fetch the full history instead of a shallow clone - - name: Setup Node.js 18.x - uses: actions/setup-node@v3 - with: - node-version: 18 - - - name: Enable Corepack - run: corepack enable - - - name: Install Dependencies - run: yarn - - - name: Build all packages - run: yarn build:all - - - name: Create Docs - run: yarn docs - - # Checks out the newly built docs artifact to the gh-pages branch of this repo - # Then, publishes to GitHub actions. - - name: Checkout gh-pages and Deploy to GitHub Pages - id: deployment - uses: crazy-max/ghaction-github-pages@v4 - with: - target_branch: gh-pages - build_dir: docs - keep_history: true - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz index eaefe895e..ce21ccaa3 100644 Binary files a/.yarn/install-state.gz and b/.yarn/install-state.gz differ diff --git a/README.md b/README.md index 6c1260124..7a18172d9 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,7 @@ SeiJS is a monorepo that contains multiple NPM libraries for writing application ## Documentation -Please check [our documentation](https://docs.sei.io) for notes on how to get up and running. The tutorial has examples -on how to connect to a Sei wallet, query an RPC endpoint, transfer tokens, IBC transfer, and interact with contracts. - -You can also refer to the [typedoc documentation](https://sei-protocol.github.io/sei-js/) for reference on the contents -of the @sei-js/core and @sei-js/react library. +Please check [our documentation](https://sei-js.docs.sei.io) for notes on how to get up and running. ## Packages diff --git a/TYPEDOC-README.md b/TYPEDOC-README.md deleted file mode 100644 index 384e98be6..000000000 --- a/TYPEDOC-README.md +++ /dev/null @@ -1,27 +0,0 @@ -
-SEI Logo -

@sei-js

-
- -

- -**@sei-js** is a collection of TypeScript libraries and CLI's designed to streamline development on Sei. Whether you're building decentralized applications, writing a smart contract, or working with protocol buffers, **@sei-js** has you covered. - -## Packages - -| Package | Description | -|-------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [evm](/@sei-js/docs/modules/evm.html) | The `/evm` package provides utilities, functions, wrappers, and configurations for seamless interaction with Sei via the Ethereum Virtual Machine (EVM). If you're building smart contracts or integrating Sei with Ethereum-based tooling, or interacting with EVM contacts like ERC20 tokens this package contains all the configs needed. | -| [create-sei](/@sei-js/docs/modules/create-sei.html) | The `/create-sei` package provides a CLI to quickly spin up Sei frontend dApps. | -| [cosmjs](/@sei-js/docs/modules/cosmjs.html) | The `/cosmjs` package offers similar functionality to the `/evm` package but tailored for interactions with Sei via the Cosmos interfaces. It includes utilities, functions, wrappers, and configurations specifically designed for CosmWasm and Rust development. | -| [cosmos](/@sei-js/docs/modules/cosmos.html) | The `/cosmos` package contains REST client libraries, proto encoding helpers, and types generated using the official Sei protocol buffers. If you're working with Sei's protocol buffer definitions or building clients for Sei services, this package will be invaluable. | -| [registry](/@sei-js/docs/modules/registry.html) | The `/registry` package contains exports data from the [Sei chain-registry](https://github.com/sei-protocol/chain-registry) and the [community asset list](https://github.com/Sei-Public-Goods/sei-assetlist) as constants in typescript. | -| [ledger](/@sei-js/docs/modules/ledger.html) | The `/ledger` package contains helpful configs and functions for connection to Sei using a Ledger device. | -| [sei-global-wallet](/@sei-js/docs/modules/sei-global-wallet.html) | The `/sei-global-wallet` library contains exports for using the "Sei Global Wallet" which is an EIP-6963-compatible wallet for libraries like RainbowKit, WalletConnect, Dynamic itself and others | - -## Resources - -- [Sei Documentation](https://docs.sei.io) -- [Sei Developers Hub](https://www.sei.io/developers) - -Feel free to explore each package for detailed documentation and examples. We're excited to see what you build on Sei! diff --git a/package.json b/package.json index 6c43d0632..ad52e5d05 100644 --- a/package.json +++ b/package.json @@ -7,15 +7,14 @@ "packages/*" ], "scripts": { - "build:all": "yarn workspaces foreach --topological-dev --all run build", + "build:all": "yarn workspaces foreach --all --parallel run build", "postinstall": "yarn update-submodules", "update-submodules": "git submodule update --init --recursive", "docs": "cd docs && yarn dlx mint dev", - "typedocs": "typedoc", "release": "changeset publish && git push --follow-tags", "release:internal": "yarn build:all && yarn changeset && yarn changeset version --snapshot internal && yarn changeset publish --no-git-tag --snapshot --tag internal", - "test:all": "yarn workspaces foreach --all run test", - "test:coverage": "yarn workspaces foreach --all run test --coverage" + "test:all": "yarn workspaces foreach --all --parallel run test", + "test:coverage": "yarn workspaces foreach --all --parallel run test --coverage" }, "dependencies": { "@biomejs/biome": "^1.9.4", @@ -29,8 +28,6 @@ "rimraf": "^3.0.2", "ts-jest": "^29.3.0", "ts-node": "2.1.2", - "typedoc": "^0.27.9", - "typedoc-material-theme": "^1.3.0", "typescript": "^5.8.2" }, "packageManager": "yarn@4.7.0" diff --git a/packages/create-sei/package.json b/packages/create-sei/package.json index 429584425..c5a045fc2 100644 --- a/packages/create-sei/package.json +++ b/packages/create-sei/package.json @@ -6,8 +6,7 @@ "bin": "./dist/main.js", "scripts": { "build": "tsc && cp -r ./templates ./dist/templates", - "dev": "node --loader ts-node/esm src/main.ts", - "docs": "typedoc --out docs" + "dev": "node --loader ts-node/esm src/main.ts" }, "dependencies": { "boxen": "^7.1.1", diff --git a/packages/create-sei/tsconfig.json b/packages/create-sei/tsconfig.json index ed06d9e8a..86b7187f0 100644 --- a/packages/create-sei/tsconfig.json +++ b/packages/create-sei/tsconfig.json @@ -15,11 +15,5 @@ "noUnusedParameters": true, "noFallthroughCasesInSwitch": true }, - "include": ["src"], - "typedocOptions": { - "readme": "./README.md", - "name": "create-sei", - "entryPoints": ["src/main.ts"], - "exclude": ["node_modules"] - } + "include": ["src"] } diff --git a/packages/ledger/package.json b/packages/ledger/package.json index 1cf2085d3..d4decf83d 100644 --- a/packages/ledger/package.json +++ b/packages/ledger/package.json @@ -14,7 +14,6 @@ "build:cjs": "tsc --outDir dist/cjs --module commonjs", "build:esm": "tsc --outDir dist/esm --module esnext", "build:types": "tsc --project ./tsconfig.declaration.json", - "docs": "typedoc --out docs", "test": "jest" }, "homepage": "https://github.com/sei-protocol/sei-js#readme", diff --git a/packages/ledger/tsconfig.json b/packages/ledger/tsconfig.json index 37425ac79..b538f2cac 100644 --- a/packages/ledger/tsconfig.json +++ b/packages/ledger/tsconfig.json @@ -4,10 +4,5 @@ "compilerOptions": { "outDir": "./dist/types", "rootDir": "./" - }, - "typedocOptions": { - "readme": "./README.md", - "name": "ledger", - "entryPoints": ["src/index.ts"] } } diff --git a/packages/mcp-server/tsconfig.json b/packages/mcp-server/tsconfig.json index b20c37eca..b29dc02ab 100644 --- a/packages/mcp-server/tsconfig.json +++ b/packages/mcp-server/tsconfig.json @@ -4,11 +4,5 @@ "compilerOptions": { "outDir": "./dist/types", "moduleResolution": "bundler" - }, - "typedocOptions": { - "readme": "./README.md", - "name": "mcp-server", - "entryPoints": ["src/index.ts"], - "exclude": ["node_modules"] } } diff --git a/packages/precompiles/package.json b/packages/precompiles/package.json index 95303dff1..e17c68e8c 100644 --- a/packages/precompiles/package.json +++ b/packages/precompiles/package.json @@ -11,7 +11,6 @@ "build:cjs": "tsc --outDir dist/cjs --module commonjs", "build:esm": "tsc --outDir dist/esm --module esnext", "build:types": "tsc --project ./tsconfig.declaration.json", - "docs": "typedoc --out docs", "test": "jest --passWithNoTests" }, "homepage": "https://github.com/sei-protocol/sei-js#readme", diff --git a/packages/precompiles/tsconfig.json b/packages/precompiles/tsconfig.json index feb1d80b5..db69f30f0 100644 --- a/packages/precompiles/tsconfig.json +++ b/packages/precompiles/tsconfig.json @@ -3,11 +3,5 @@ "include": ["src"], "compilerOptions": { "outDir": "./dist/types" - }, - "typedocOptions": { - "readme": "./README.md", - "name": "precompiles", - "entryPoints": ["src/index.ts"], - "exclude": ["node_modules"] } } diff --git a/packages/registry/package.json b/packages/registry/package.json index 85f11492f..77dd015e3 100644 --- a/packages/registry/package.json +++ b/packages/registry/package.json @@ -14,7 +14,6 @@ "build:cjs": "tsc --outDir dist/cjs --module commonjs", "build:esm": "tsc --outDir dist/esm --module esnext", "build:types": "tsc --project ./tsconfig.declaration.json", - "docs": "typedoc --out docs", "test": "jest" }, "homepage": "https://github.com/sei-protocol/sei-js#readme", diff --git a/packages/registry/tsconfig.json b/packages/registry/tsconfig.json index e0da48954..e6fb86c89 100644 --- a/packages/registry/tsconfig.json +++ b/packages/registry/tsconfig.json @@ -4,10 +4,5 @@ "compilerOptions": { "outDir": "./dist/types", "rootDir": "./" - }, - "typedocOptions": { - "readme": "./README.md", - "name": "registry", - "entryPoints": ["src/index.ts"] } } diff --git a/packages/sei-global-wallet/tsconfig.json b/packages/sei-global-wallet/tsconfig.json index 9078ee046..db69f30f0 100644 --- a/packages/sei-global-wallet/tsconfig.json +++ b/packages/sei-global-wallet/tsconfig.json @@ -3,11 +3,5 @@ "include": ["src"], "compilerOptions": { "outDir": "./dist/types" - }, - "typedocOptions": { - "readme": "./README.md", - "name": "sei-account", - "entryPoints": ["src/index.ts"], - "exclude": ["node_modules"] } } diff --git a/typedoc.theme.css b/typedoc.theme.css deleted file mode 100644 index e6dc0b640..000000000 --- a/typedoc.theme.css +++ /dev/null @@ -1,65 +0,0 @@ -.container-main { - grid-template-columns: minmax(0, 1.15fr) minmax(0, 2fr) !important; -} - -.tsd-generator { - display: none; -} - -.tsd-accordion-summary { - margin-top: 0.25rem; -} - -.tsd-accordion-summary > svg { - margin-top: 2px !important; - right: 1rem !important; -} - -.tsd-accordion-summary > a { - padding: 0.88rem 1.25rem !important; -} - -.tsd-accordion-details { - margin-top: 1rem !important; -} - -.site-menu { - overflow: scroll !important; - padding-right: 0.5rem !important; - margin-right: 1rem !important; -} - -.tsd-nested-navigation > li > details { - margin-left: unset !important; -} - -.tsd-page-title > h1 { - display: none; -} - -.tsd-page-toolbar { - height: unset !important; -} - -.container-main { - margin-top: 1rem !important; -} - -.current { - padding: 0.88rem 1.25rem !important; -} - -.settings { - margin: 0 !important; -} - -.page-menu { - display: flex; - flex-direction: column; - gap: 2rem !important; - padding: 2rem !important; -} - -.warning { - display: none; -} diff --git a/yarn.lock b/yarn.lock index 74d71b7d6..d6d715c02 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1649,17 +1649,6 @@ __metadata: languageName: node linkType: hard -"@gerrit0/mini-shiki@npm:^1.24.0": - version: 1.27.2 - resolution: "@gerrit0/mini-shiki@npm:1.27.2" - dependencies: - "@shikijs/engine-oniguruma": "npm:^1.27.2" - "@shikijs/types": "npm:^1.27.2" - "@shikijs/vscode-textmate": "npm:^10.0.1" - checksum: 10c0/aee681637d123e0e8c9ec154b117ce166dd8b4b9896341e617fef16d0b21ef91a17f6f90cc874137e33ca85b5898817b59bb8aea178cdb2fa6e75b0fff3640c2 - languageName: node - linkType: hard - "@img/sharp-darwin-arm64@npm:0.33.5": version: 0.33.5 resolution: "@img/sharp-darwin-arm64@npm:0.33.5" @@ -2890,13 +2879,6 @@ __metadata: languageName: node linkType: hard -"@material/material-color-utilities@npm:^0.3.0": - version: 0.3.0 - resolution: "@material/material-color-utilities@npm:0.3.0" - checksum: 10c0/3bef025428b893f2acc9e9e2bd186363a60b7c0836fe43c78222e29fe67dc579618e844f0661a20657ed9f7fd8b94fd43a2961892894d0b6a2ba5264ce2673f8 - languageName: node - linkType: hard - "@mdx-js/mdx@npm:^3.1.0": version: 3.1.0 resolution: "@mdx-js/mdx@npm:3.1.0" @@ -3605,16 +3587,6 @@ __metadata: languageName: node linkType: hard -"@shikijs/engine-oniguruma@npm:^1.27.2": - version: 1.29.2 - resolution: "@shikijs/engine-oniguruma@npm:1.29.2" - dependencies: - "@shikijs/types": "npm:1.29.2" - "@shikijs/vscode-textmate": "npm:^10.0.1" - checksum: 10c0/87d77e05af7fe862df40899a7034cbbd48d3635e27706873025e5035be578584d012f850208e97ca484d5e876bf802d4e23d0394d25026adb678eeb1d1f340ff - languageName: node - linkType: hard - "@shikijs/langs@npm:3.7.0": version: 3.7.0 resolution: "@shikijs/langs@npm:3.7.0" @@ -3643,16 +3615,6 @@ __metadata: languageName: node linkType: hard -"@shikijs/types@npm:1.29.2, @shikijs/types@npm:^1.27.2": - version: 1.29.2 - resolution: "@shikijs/types@npm:1.29.2" - dependencies: - "@shikijs/vscode-textmate": "npm:^10.0.1" - "@types/hast": "npm:^3.0.4" - checksum: 10c0/37b4ac315effc03e7185aca1da0c2631ac55bdf613897476bd1d879105c41f86ccce6ebd0b78779513d88cc2ee371039f7efd95d604f77f21f180791978822b3 - languageName: node - linkType: hard - "@shikijs/types@npm:3.7.0": version: 3.7.0 resolution: "@shikijs/types@npm:3.7.0" @@ -3663,7 +3625,7 @@ __metadata: languageName: node linkType: hard -"@shikijs/vscode-textmate@npm:^10.0.1, @shikijs/vscode-textmate@npm:^10.0.2": +"@shikijs/vscode-textmate@npm:^10.0.2": version: 10.0.2 resolution: "@shikijs/vscode-textmate@npm:10.0.2" checksum: 10c0/36b682d691088ec244de292dc8f91b808f95c89466af421cf84cbab92230f03c8348649c14b3251991b10ce632b0c715e416e992dd5f28ff3221dc2693fd9462 @@ -6613,13 +6575,6 @@ __metadata: languageName: node linkType: hard -"entities@npm:^4.4.0": - version: 4.5.0 - resolution: "entities@npm:4.5.0" - checksum: 10c0/5b039739f7621f5d1ad996715e53d964035f75ad3b9a4d38c6b3804bb226e282ffeae2443624d8fdd9c47d8e926ae9ac009c54671243f0c3294c26af7cc85250 - languageName: node - linkType: hard - "entities@npm:^6.0.0": version: 6.0.1 resolution: "entities@npm:6.0.1" @@ -10196,15 +10151,6 @@ __metadata: languageName: node linkType: hard -"linkify-it@npm:^5.0.0": - version: 5.0.0 - resolution: "linkify-it@npm:5.0.0" - dependencies: - uc.micro: "npm:^2.0.0" - checksum: 10c0/ff4abbcdfa2003472fc3eb4b8e60905ec97718e11e33cca52059919a4c80cc0e0c2a14d23e23d8c00e5402bc5a885cdba8ca053a11483ab3cc8b3c7a52f88e2d - languageName: node - linkType: hard - "locate-path@npm:^5.0.0": version: 5.0.0 resolution: "locate-path@npm:5.0.0" @@ -10317,13 +10263,6 @@ __metadata: languageName: node linkType: hard -"lunr@npm:^2.3.9": - version: 2.3.9 - resolution: "lunr@npm:2.3.9" - checksum: 10c0/77d7dbb4fbd602aac161e2b50887d8eda28c0fa3b799159cee380fbb311f1e614219126ecbbd2c3a9c685f1720a8109b3c1ca85cc893c39b6c9cc6a62a1d8a8b - languageName: node - linkType: hard - "make-dir@npm:^4.0.0": version: 4.0.0 resolution: "make-dir@npm:4.0.0" @@ -10375,22 +10314,6 @@ __metadata: languageName: node linkType: hard -"markdown-it@npm:^14.1.0": - version: 14.1.0 - resolution: "markdown-it@npm:14.1.0" - dependencies: - argparse: "npm:^2.0.1" - entities: "npm:^4.4.0" - linkify-it: "npm:^5.0.0" - mdurl: "npm:^2.0.0" - punycode.js: "npm:^2.3.1" - uc.micro: "npm:^2.1.0" - bin: - markdown-it: bin/markdown-it.mjs - checksum: 10c0/9a6bb444181d2db7016a4173ae56a95a62c84d4cbfb6916a399b11d3e6581bf1cc2e4e1d07a2f022ae72c25f56db90fbe1e529fca16fbf9541659dc53480d4b4 - languageName: node - linkType: hard - "markdown-table@npm:^3.0.0": version: 3.0.4 resolution: "markdown-table@npm:3.0.4" @@ -10664,13 +10587,6 @@ __metadata: languageName: node linkType: hard -"mdurl@npm:^2.0.0": - version: 2.0.0 - resolution: "mdurl@npm:2.0.0" - checksum: 10c0/633db522272f75ce4788440669137c77540d74a83e9015666a9557a152c02e245b192edc20bc90ae953bbab727503994a53b236b4d9c99bdaee594d0e7dd2ce0 - languageName: node - linkType: hard - "media-typer@npm:0.3.0": version: 0.3.0 resolution: "media-typer@npm:0.3.0" @@ -11288,7 +11204,7 @@ __metadata: languageName: node linkType: hard -"minimatch@npm:^9.0.4, minimatch@npm:^9.0.5": +"minimatch@npm:^9.0.4": version: 9.0.5 resolution: "minimatch@npm:9.0.5" dependencies: @@ -12464,13 +12380,6 @@ __metadata: languageName: node linkType: hard -"punycode.js@npm:^2.3.1": - version: 2.3.1 - resolution: "punycode.js@npm:2.3.1" - checksum: 10c0/1d12c1c0e06127fa5db56bd7fdf698daf9a78104456a6b67326877afc21feaa821257b171539caedd2f0524027fa38e67b13dd094159c8d70b6d26d2bea4dfdb - languageName: node - linkType: hard - "punycode@npm:^2.1.0": version: 2.3.1 resolution: "punycode@npm:2.3.1" @@ -13270,8 +13179,6 @@ __metadata: rimraf: "npm:^3.0.2" ts-jest: "npm:^29.3.0" ts-node: "npm:2.1.2" - typedoc: "npm:^0.27.9" - typedoc-material-theme: "npm:^1.3.0" typescript: "npm:^5.8.2" languageName: unknown linkType: soft @@ -14512,34 +14419,6 @@ __metadata: languageName: node linkType: hard -"typedoc-material-theme@npm:^1.3.0": - version: 1.4.0 - resolution: "typedoc-material-theme@npm:1.4.0" - dependencies: - "@material/material-color-utilities": "npm:^0.3.0" - peerDependencies: - typedoc: ^0.25.13 || ^0.26.x || ^0.27.x || ^0.28.x - checksum: 10c0/7fbd16392ae76ee1922df0d5cc1eb5f29ae2626433b11429830a4685a7e598d8ac49036e173ddb815d75b46ca6917e8d02ffc579471313ea5983a84fc2c71067 - languageName: node - linkType: hard - -"typedoc@npm:^0.27.9": - version: 0.27.9 - resolution: "typedoc@npm:0.27.9" - dependencies: - "@gerrit0/mini-shiki": "npm:^1.24.0" - lunr: "npm:^2.3.9" - markdown-it: "npm:^14.1.0" - minimatch: "npm:^9.0.5" - yaml: "npm:^2.6.1" - peerDependencies: - typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x - bin: - typedoc: bin/typedoc - checksum: 10c0/999668d9d23e1824b762e2c411e2c0860d0ce4a2e61f23a2c31d36a1d6337a763553bc75205aee25ce34659e9315315c720694e9eccd7e7e4755873fdfec1192 - languageName: node - linkType: hard - "typescript@npm:^5.7.3, typescript@npm:^5.8.2, typescript@npm:^5.8.3": version: 5.8.3 resolution: "typescript@npm:5.8.3" @@ -14560,13 +14439,6 @@ __metadata: languageName: node linkType: hard -"uc.micro@npm:^2.0.0, uc.micro@npm:^2.1.0": - version: 2.1.0 - resolution: "uc.micro@npm:2.1.0" - checksum: 10c0/8862eddb412dda76f15db8ad1c640ccc2f47cdf8252a4a30be908d535602c8d33f9855dfcccb8b8837855c1ce1eaa563f7fa7ebe3c98fd0794351aab9b9c55fa - languageName: node - linkType: hard - "unbox-primitive@npm:^1.1.0": version: 1.1.0 resolution: "unbox-primitive@npm:1.1.0" @@ -15441,15 +15313,6 @@ __metadata: languageName: node linkType: hard -"yaml@npm:^2.6.1": - version: 2.7.1 - resolution: "yaml@npm:2.7.1" - bin: - yaml: bin.mjs - checksum: 10c0/ee2126398ab7d1fdde566b4013b68e36930b9e6d8e68b6db356875c99614c10d678b6f45597a145ff6d63814961221fc305bf9242af8bf7450177f8a68537590 - languageName: node - linkType: hard - "yargs-parser@npm:^21.1.1": version: 21.1.1 resolution: "yargs-parser@npm:21.1.1"