Skip to content

README.md

Latest commit

 

History

History
83 lines (56 loc) · 2.63 KB

README.md

File metadata and controls

83 lines (56 loc) · 2.63 KB
Raw

CLI Example

This example generates sparklines by running Sparkline SVG on the Homestar runtime.

Setup

Install the following:

Build and publish compute

Build the Sparkline SVG Wasm component.

cargo build --target wasm32-unknown-unknown
wasm-tools component new ../../target/wasm32-unknown-unknown/debug/sparkline_svg.wasm -o ./sparkline_svg.wasm

The first command builds a Wasm binary, and the second command componentizes it. Creating the component is optional as the Homestar runtime will create it on the fly.

Start the IPFS Kubo daemon, and add the Wasm component.

ipfs dameon
ipfs add --cid-version 1 sparkline_svg.wasm

The ipfs add command will return a CID for the Wasm component.

Prepare workflow

workflow.json describes the computation we would like to run.

The rsc field contains the CID for the Wasm component we added to IPFS. If you have altered source code, you will want to update this CID to the one Kubo reported.

The args are the data that will be used to generate the SVG.

"args": [
  [1, 0, 5, 4, 8, 10, 20, 10, 5, 4], // data points
  "An SVG Title", // SVG title for accessibility
  "A SVG Description", // SVG description for accessibility
  500, // width
  200, // height
  "#2e4374", // line color
  "#7c81ad" // fill color, set to "transparent" for no fill
],

Update args to generate the different SVGs as desired.

Run workflow

Start the Homestar runtime.

homestar start

In a separate terminal window, run the workflow.

homestar run -w workflow.json

The CLI reports workflow information when it starts running a workflow. On first run, we won't see results, but on a second run the CLI will report a replayed receipt that contains our SVG. (A future version of the CLI will include a means for checking the status of active and completed workflows.)

After running the workflow a second time, check the replayed receipts section. Copy the cid from the receipts computed section and retrieve the associated receipt from Kubo. For example:

ipfs dag get bafyrmihk2ibe3lud2mdzbjjr2yc47ufynicomphhbhmctgewpb3uudpgia | jq ."out[1]" --raw-output > output.svg

This command uses jq to extract the SVG from the receipt out field and writes it to an output.svg file.