bulletin-deploy 0.4.4 → 0.5.0

package/README.md

@@ -5,7 +5,7 @@ Deploy static sites and apps to the Polkadot Triangle network with decentralized
 ## Quick Start
 
 ```bash
-npm install -g github:paritytech/bulletin-deploy
+npm install -g bulletin-deploy
 # Build your app (e.g. npm run build)
 bulletin-deploy ./dist my-app00.dot
 ```
@@ -31,8 +31,6 @@ ipfs init
 
 ## CLI Usage
 
-### Deploy an app
-
 ```bash
 bulletin-deploy <build-dir> <domain.dot>
 ```
@@ -43,9 +41,6 @@ Examples:
 # Basic deploy
 bulletin-deploy ./dist my-app00.dot
 
-# With DotNS owner mnemonic
-MNEMONIC="word1 word2 ..." bulletin-deploy ./dist my-app00.dot
-
 # Custom RPC endpoint
 bulletin-deploy --rpc wss://custom-bulletin.example.com ./dist my-app00.dot
 ```
@@ -54,7 +49,6 @@ bulletin-deploy --rpc wss://custom-bulletin.example.com ./dist my-app00.dot
 
 ```
 Options:
-  --mnemonic "..."    DotNS owner mnemonic (or set MNEMONIC env var)
   --rpc wss://...     Bulletin RPC (or set BULLETIN_RPC env var)
   --help              Show help
 ```
@@ -62,9 +56,8 @@ Options:
 ## GitHub Actions
 
 1. Copy `workflows/deploy-on-pr.yml` to your repo's `.github/workflows/` directory
-2. Set the `MNEMONIC` secret in your repo settings (the mnemonic that owns your `.dot` domain)
-3. Customize the **Build** step for your framework (Vite, Next.js, etc.)
-4. Push and watch the deploy
+2. Customize the **Build** step for your framework (Vite, Next.js, etc.)
+3. Push and watch the deploy
 
 The template workflow:
 - Deploys on push to main and on PRs
@@ -75,9 +68,8 @@ The template workflow:
 ## Programmatic API
 
 ```javascript
-import { deploy, DotNS } from "@paritytech/bulletin-deploy";
+import { deploy, DotNS } from "bulletin-deploy";
 
-// Deploy a directory
 const result = await deploy("./dist", "my-app00.dot");
 console.log(result.cid, result.domainName);
 ```
@@ -87,12 +79,8 @@ console.log(result.cid, result.domainName);
 | Variable | Default | Description |
 |---|---|---|
 | `BULLETIN_RPC` | `wss://paseo-bulletin-rpc.polkadot.io` | Bulletin chain WebSocket RPC |
-| `BULLETIN_POOL_SIZE` | `10` | Number of pool accounts to derive |
-| `BULLETIN_POOL_MNEMONIC` | Dev phrase (Alice) | Mnemonic for pool account derivation |
-| `MNEMONIC` | Dev phrase | DotNS domain owner mnemonic |
 | `BULLETIN_DEPLOY_TELEMETRY` | `1` (enabled) | Set to `0` to disable Sentry telemetry |
 | `IPFS_CID` | _(none)_ | Skip storage, use pre-existing CID |
-| `GITHUB_OUTPUT` | _(none)_ | GitHub Actions output file (set automatically in CI) |
 
 ## How It Works
 
@@ -125,18 +113,15 @@ When a pool account's authorization drops below thresholds (50 transactions or 5
 
 ## Telemetry
 
-Sentry telemetry is enabled by default for deploy observability.
+Sentry telemetry is enabled by default for deploy observability. Set `BULLETIN_DEPLOY_TELEMETRY=0` to disable.
 
 What's tracked:
 - Deploy duration and success/failure
 - Storage phase timing (merkleize, chunk upload, root node)
 - DotNS phase timing (registration, contenthash update)
 - Pool account selection
-- Chunk retry counts
 - Source metadata (repo, branch, PR number, CI vs local)
 
-Telemetry is enabled by default. Set `BULLETIN_DEPLOY_TELEMETRY=0` to disable.
-
 Dashboard: https://polkadot-community-foundation.sentry.io/dashboards/92523/
 
 ## Troubleshooting
@@ -148,7 +133,6 @@ Dashboard: https://polkadot-community-foundation.sentry.io/dashboards/92523/
 | `IPFS CLI not installed` | Install Kubo: `brew install ipfs && ipfs init` |
 | `CommitmentNotFound` | DotNS timing issue during registration. Retry the deploy. |
 | `All pool accounts exhausted` | Auto-authorization will top up the best available account |
-| `File exceeds 8MB limit` | File is automatically chunked. This shouldn't appear for directories. |
 | `fetchNonce timed out` | Bulletin RPC may be down. Check endpoint or try a different one. |
 
 ## Configuration for Different Chains
@@ -160,11 +144,5 @@ By default, bulletin-deploy targets the **Paseo testnet**:
 To point at a different chain, set the `BULLETIN_RPC` environment variable:
 
 ```bash
-# Local development
-BULLETIN_RPC=ws://127.0.0.1:9944 bulletin-deploy ./dist my-app00.dot
-
-# Custom endpoint
 BULLETIN_RPC=wss://your-bulletin-rpc.example.com bulletin-deploy ./dist my-app00.dot
 ```
-
-The Asset Hub RPC endpoints are configured in `src/dotns.js` and support automatic failover across multiple providers.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bulletin-deploy",
-  "version": "0.4.4",
+  "version": "0.5.0",
   "private": false,
   "repository": {
     "type": "git",

package/src/deploy.js

@@ -268,12 +268,12 @@ export async function merkleize(directoryPath, outputCarPath) {
 
 export async function storeDirectory(directoryPath) {
   const carPath = path.join(path.dirname(directoryPath), `${path.basename(directoryPath)}.car`);
-  const { cid: ipfsCid } = await withSpan("deploy.merkleize", "merkleize", { "deploy.directory": directoryPath }, async () => {
+  const { cid: ipfsCid } = await withSpan("deploy.merkleize", "1a. merkleize", { "deploy.directory": directoryPath }, async () => {
     return merkleize(directoryPath, carPath);
   });
   const carBuffer = fs.readFileSync(carPath);
   const carChunks = chunk(carBuffer, CHUNK_SIZE);
-  const storageCid = await withSpan("deploy.chunk-upload", "chunk-upload", { "deploy.chunks.total": carChunks.length, "deploy.car.bytes": carBuffer.length }, async () => {
+  const storageCid = await withSpan("deploy.chunk-upload", "1b. chunk-upload", { "deploy.chunks.total": carChunks.length, "deploy.car.bytes": carBuffer.length }, async () => {
     return storeChunkedContent(carChunks);
   });
   return { storageCid, ipfsCid };
@@ -296,7 +296,7 @@ export async function deploy(content, domainName = null) {
     console.log("Storage");
     console.log("=".repeat(60));
 
-    await withSpan("deploy.storage", "storage", {}, async () => {
+    await withSpan("deploy.storage", "1. storage", {}, async () => {
       if (process.env.IPFS_CID) {
         cid = process.env.IPFS_CID;
         ipfsCid = cid;
@@ -344,7 +344,7 @@ export async function deploy(content, domainName = null) {
     console.log("DotNS");
     console.log("=".repeat(60));
 
-    await withSpan("deploy.dotns", "dotns", { "deploy.domain": name }, async () => {
+    await withSpan("deploy.dotns", "2. dotns", { "deploy.domain": name }, async () => {
       const dotns = new DotNS();
       await dotns.connect();
       const { owned, owner } = await dotns.checkOwnership(name);

package/src/dotns.js

@@ -492,7 +492,7 @@ export class DotNS {
   }
 
   async setContenthash(domainName, contenthashHex) {
-    return withSpan("deploy.dotns.set-contenthash", "set-contenthash", {}, async () => {
+    return withSpan("deploy.dotns.set-contenthash", "2b. set-contenthash", {}, async () => {
       this.ensureConnected();
       const node = namehash(`${domainName}.dot`);
       let ipfsCid = null;
@@ -512,7 +512,7 @@ export class DotNS {
   }
 
   async register(label, options = {}) {
-    return withSpan("deploy.dotns.register", `register ${label}.dot`, {}, async () => {
+    return withSpan("deploy.dotns.register", `2a. register ${label}.dot`, {}, async () => {
       const status = parseProofOfPersonhoodStatus(options.status || process.env.DOTNS_STATUS);
       const reverse = options.reverse ?? (process.env.DOTNS_REVERSE ?? "false").toLowerCase() === "true";
       if (!this.connected) await this.connect(options);
@@ -523,10 +523,10 @@ export class DotNS {
         this.setUserPopStatus(status),
       ]);
       const { commitment, registration } = await this.generateCommitment(label, reverse);
-      await withSpan("deploy.dotns.submit-commitment", "submit-commitment", {}, () => this.submitCommitment(commitment));
-      await withSpan("deploy.dotns.wait-commitment-age", "wait-commitment-age", {}, () => this.waitForCommitmentAge());
+      await withSpan("deploy.dotns.submit-commitment", "2a-i. submit-commitment", {}, () => this.submitCommitment(commitment));
+      await withSpan("deploy.dotns.wait-commitment-age", "2a-ii. wait-commitment-age", {}, () => this.waitForCommitmentAge());
       const pricing = await this.getPriceAndValidate(label);
-      await withSpan("deploy.dotns.finalize-registration", "finalize-registration", {}, () => this.finalizeRegistration(registration, pricing.priceWei));
+      await withSpan("deploy.dotns.finalize-registration", "2a-iii. finalize-registration", {}, () => this.finalizeRegistration(registration, pricing.priceWei));
       await this.verifyOwnership(label);
       console.log(`\n   Registration complete!`);
       return { label, owner: this.evmAddress };

package/workflows/deploy-on-pr.yml

@@ -50,7 +50,7 @@ jobs:
       - run: ipfs init
 
       - name: Install deploy tool
-        run: npm install -g github:paritytech/bulletin-deploy
+        run: npm install -g bulletin-deploy
 
       - name: Deploy
         uses: nick-fields/retry@v3