Added documentation to justfile #125

x3c41a · 2025-11-28T09:10:09Z

No description provided.

examples/justfile

bkontur · 2025-11-28T12:00:41Z

@x3c41a @karolk91 let's make "the justfile stuff running examples" work in CI #108 (comment)

x3c41a · 2025-11-28T12:07:57Z

@x3c41a @karolk91 let's make "the justfile stuff running examples" work in CI #108 (comment)

do you mind if it will be a separate PR? I want to experiment with justfile in this one...

bkontur · 2025-11-28T13:38:16Z

@x3c41a @karolk91 let's make "the justfile stuff running examples" work in CI #108 (comment)

do you mind if it will be a separate PR? I want to experiment with justfile in this one...

Why? What experiments with justfile?
From my point of view, getting this working in CI is the most important part.

x3c41a · 2025-11-28T14:03:58Z

Why? What experiments with justfile?

I want to split that one big just authorize-and-store [client] into smaller sub-commands so that they can be used both in README (to replace those big commands that we have) and in the CI.

From my point of view, getting this working in CI is the most important part.

Yes, I agree. I just want to make it maintainable and utilise the full power of justs.

x3c41a · 2025-12-04T09:14:02Z

I updated README, please, take a look @bkontur
As a side note, I noticed that Connect IPFS nodes step started to fail with

🔗 Connecting IPFS nodes...
Error: connect 12D3KooWRkZhiRhsqmrQ28rt73K7V3aCBpqKrLGSXmZ99PTcTZby failure: failed to dial: failed to dial 12D3KooWRkZhiRhsqmrQ28rt73K7V3aCBpqKrLGSXmZ99PTcTZby: all dials failed
  * [/ip4/127.0.0.1/tcp/12347/ws] dial tcp 127.0.0.1:12347: connect: connection refused
Error: connect 12D3KooWQCkBm1BYtkHpocxCwMgR8yjitEeHGx8spzcDLGt2gkBm failure: failed to dial: failed to dial 12D3KooWQCkBm1BYtkHpocxCwMgR8yjitEeHGx8spzcDLGt2gkBm: all dials failed
  * [/ip4/127.0.0.1/tcp/10001/ws] dial tcp 127.0.0.1:10001: connect: connection refused

x3c41a · 2025-12-04T12:39:32Z

I updated README, please, take a look @bkontur As a side note, I noticed that Connect IPFS nodes step started to fail with

🔗 Connecting IPFS nodes...
Error: connect 12D3KooWRkZhiRhsqmrQ28rt73K7V3aCBpqKrLGSXmZ99PTcTZby failure: failed to dial: failed to dial 12D3KooWRkZhiRhsqmrQ28rt73K7V3aCBpqKrLGSXmZ99PTcTZby: all dials failed
  * [/ip4/127.0.0.1/tcp/12347/ws] dial tcp 127.0.0.1:12347: connect: connection refused
Error: connect 12D3KooWQCkBm1BYtkHpocxCwMgR8yjitEeHGx8spzcDLGt2gkBm failure: failed to dial: failed to dial 12D3KooWQCkBm1BYtkHpocxCwMgR8yjitEeHGx8spzcDLGt2gkBm: all dials failed
  * [/ip4/127.0.0.1/tcp/10001/ws] dial tcp 127.0.0.1:10001: connect: connection refused

fixed with the latest commit

examples/README.md

bkontur · 2025-12-08T10:54:16Z

examples/justfile

+
+# Test the complete workflow (builds, starts services, runs example, shuts down services)
+# Parameters: api=[papi|pjs] - choose between Polkadot API (papi) or Polkadot JS (pjs)
+authorize-and-store api="papi": build npm-install


Suggested change

authorize-and-store api="papi": build npm-install

run-authorize-and-store api="papi": build npm-install

bkontur · 2025-12-08T10:55:31Z

examples/justfile

+    # Initialize IPFS
+    just ipfs-init
+
+    # Start services
+    just ipfs-start
+    just bulletin-zombienet-start
+    just ipfs-connect
+    just ipfs-reconnect-start
+
+    # Generate PAPI descriptors if needed
+    if [ "$API_TYPE" == "papi" ]; then
+        just papi-generate
+    fi


I would extract this to one step, that we can reuse, e.g. just setup-services

Suggested change

# Initialize IPFS

just ipfs-init

# Start services

just ipfs-start

just bulletin-zombienet-start

just ipfs-connect

just ipfs-reconnect-start

# Generate PAPI descriptors if needed

if [ "$API_TYPE" == "papi" ]; then

just papi-generate

fi

# Initialize IPFS

just ipfs-init

# Start services

just ipfs-start

just bulletin-zombienet-start

just ipfs-connect

just ipfs-reconnect-start

# Generate PAPI descriptors if needed

if [ "$API_TYPE" == "papi" ]; then

just papi-generate

fi

bkontur · 2025-12-08T10:57:06Z

examples/justfile

+    # Run the example
+    just run-example $API_TYPE


Let's remove run-example and trigger authorize_and_store here directly

Suggested change

# Run the example

just run-example $API_TYPE

# Run the example

if [ "$API_TYPE" == "papi" ]; then

EXAMPLE_FILE="authorize_and_store_papi.js"

else

EXAMPLE_FILE="authorize_and_store.js"

fi

node $EXAMPLE_FILE

bkontur · 2025-12-08T11:02:03Z

examples/justfile

+
+# Run the authorize-and-store example
+# Parameters: api=[papi|pjs] - choose between Polkadot API (papi) or Polkadot JS (pjs)
+run-example api="papi":


Let's remove run-example step.

At the end, we should be simply adding new examples, like:

run-store-big-data start-services="false": if [[ "$start-services" == "true" ]]; then just start-sevices fi node store_big_data.js

bkontur · 2025-12-08T11:15:35Z

examples/justfile

+    $IPFS_CMD swarm connect /ip4/127.0.0.1/tcp/10001/ws/p2p/12D3KooWQCkBm1BYtkHpocxCwMgR8yjitEeHGx8spzcDLGt2gkBm || true
+
+# Start zombienet in background
+bulletin-zombienet-start:


Please, rename. we will add later bulletin-para-zombienet-start:

Suggested change

bulletin-zombienet-start:

bulletin-solo-zombienet-start:

x3c41a · 2025-12-08T11:31:27Z

Addressed all the comments, double checked that the commands still work, PTAL

added documentation to justfile

40fbe8e

x3c41a requested a review from bkontur November 28, 2025 09:10

x3c41a mentioned this pull request Nov 28, 2025

Added justfile #111

Merged

bkontur reviewed Nov 28, 2025

View reviewed changes

examples/justfile Outdated Show resolved Hide resolved

examples/justfile Outdated Show resolved Hide resolved

added node connection to IPFS swarm

15f764f

WIP: split justfiles into sub-justs

fa67370

x3c41a added 3 commits December 4, 2025 09:37

update README and justfile

1fade05

removed #

7738f21

Merge branch 'main' into upd_just

8906016

x3c41a requested a review from bkontur December 4, 2025 09:14

x3c41a added 2 commits December 4, 2025 12:23

updated justfile

807d34a

fixed justfile commands and updated readme

73725d5

bkontur reviewed Dec 5, 2025

View reviewed changes

examples/README.md Show resolved Hide resolved

x3c41a added 2 commits December 5, 2025 09:50

added just installation commands

56709cf

added description of what just is

9db3462

x3c41a requested a review from bkontur December 5, 2025 11:31

bkontur reviewed Dec 8, 2025

View reviewed changes

justfile refactors

107154d

bkontur reviewed Dec 8, 2025

View reviewed changes

x3c41a added 2 commits December 8, 2025 12:20

removed run-example from justfile

d52d5c4

updated teardown

e2ae7bf

x3c41a added 2 commits December 8, 2025 12:28

updated doc

a435cad

fixed bug

218b84b

x3c41a requested a review from bkontur December 8, 2025 11:31

bkontur approved these changes Dec 8, 2025

View reviewed changes

bkontur merged commit de23e32 into main Dec 8, 2025
7 checks passed

bkontur deleted the upd_just branch December 8, 2025 11:59

	authorize-and-store api="papi": build npm-install
	run-authorize-and-store api="papi": build npm-install

Added documentation to justfile #125

Added documentation to justfile #125

Uh oh!

Conversation

x3c41a commented Nov 28, 2025

Uh oh!

Uh oh!

Uh oh!

bkontur commented Nov 28, 2025

Uh oh!

x3c41a commented Nov 28, 2025

Uh oh!

bkontur commented Nov 28, 2025

Uh oh!

x3c41a commented Nov 28, 2025

Uh oh!

x3c41a commented Dec 4, 2025

Uh oh!

x3c41a commented Dec 4, 2025

Uh oh!

Uh oh!

bkontur Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

bkontur Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

bkontur Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

bkontur Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

bkontur Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

x3c41a commented Dec 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants