Examples

The guides on this site show you the calls. The examples are the same calls, wired up and runnable: a small CLI covering publishing, editing, downloading, Compute-to-Data and credential-gated access, against a real network.

They live in the nautilus repository, under examples/.

Getting them running

git clone https://github.com/deltaDAO/nautilus.git
cd nautilus
npm install && npm run build
 
cd examples
npm install
cp example.env .env

Node 22 or later. There is no build step for the examples themselves — tsx runs the TypeScript directly.

Set these variables in .env:

Optional:

example.env documents every variable inline. Your account needs funds for gas, and for any non-free asset it buys. Contact deltaDAO at contact@delta-dao.com for tokens and onboarding.

Plain http:// URLs are accepted only for localhost, 127.0.0.0/8, ::1 and *.localhost (nautilus requires https:// for OCEAN_NODE_URI, S3_ENDPOINT and IPFS_UPLOAD_URL elsewhere, and the examples have no switch to relax that). S3_NODE_ENDPOINT may be http://, since only the node connects to it.

Then check what your ocean-node actually is, and that your DDO store works, before anything else:

npm start -- check:node
npm start -- store:check     # the store's check(), what publish runs before minting; no transaction

The CLI

Every example is a named command:

npm start -- <command> [args...]
npm start -- help                # every command, grouped
npm start -- <command> --help    # one command's usage and what it needs, offline

help is generated from the command table in commands.ts, so it never drifts from what is actually there. It marks the commands that need a DDO store (S) and the ones that act as the consumer (C). The groups:

A first run, end to end:

npm start -- publish:access-dataset      # prints a did:ope:… DID
npm start -- access:price did:ope:…
npm start -- access:download did:ope:…

If a publish stops after the NFT was minted, the error prints the command to finish it on the same NFT, and the node's indexing record tells you why a change was not indexed:

npm start -- publish:resume publish:access-dataset 0xNFT… 0xDatatoken…
npm start -- asset:indexing-state 0xTxHash…   # failures are filed by transaction

Or chain the whole thing:

npm run scenario:e2e             # publish → order → download → compute → revoke
npm start -- ssi:round-trip      # the credential-gated round trip

scenario:e2e revokes the assets it published at the end (revoking is one-way); set E2E_KEEP_ASSETS=true to keep them.

Running against a local nautilus

The examples ship pointing at the nautilus in the same checkout ("@deltadao/nautilus": "file:../src"), so they exercise your working copy by default. Three scripts control it:

npm run nautilus:which   # report which is active
npm run use:local        # build ../src and link it   (the default)
npm run use:npm          # switch to the published package

A bare use:npm reads the version from ../src/package.json and installs ^<version>, so it tracks whatever the checkout is about to release. Pin something specific with --spec; then nothing outside examples/ is read, so it also works in a copy of the directory:

npm run use:npm -- --spec 2.0.0-beta.0
npm run use:npm -- --spec beta

Switching rewrites package.json and package-lock.json; that churn is not meant to be committed. And the examples need the release they were written for: they use S3RemoteStore, completePublish, getIndexingState and the throwing waitForIndexer, which 2.0.0-beta.0 does not have. Pin a version that does, or stay on use:local.

It is a dependency rewrite rather than npm link, deliberately: nothing is written to your global npm prefix.

Where to look

The examples' own README goes further on the things that most often surprise people coming from v1: publishing needing a DDO store, what to do when a publish or an edit does not end indexed, one ocean-node replacing two URLs, and what DDO v5 did to the metadata.