Skip to content

Latest commit

 

History

History
143 lines (86 loc) · 9.15 KB

README.md

File metadata and controls

143 lines (86 loc) · 9.15 KB
Raw

🌺🐸 Lilypad

We have docs!

docs.lilypadnetwork.org

and a blog... lilypad.tech

Breaking Changes 1 May 2023

  • Note the events contract is now called LilypadEventsUpgradeable.sol (updated from LilypadEvents.sol)

  • The function to call from your calling contract has been renamed from runBacalhauJob -> runLilypadJob(fromContractAddress, spec, resultType) PAYABLE

  • You need to pay to perform tasks now: currently the pay is ONLY to cover the network gas costs of returning the job to your calling contract. No other fees for running the job are payable. (while we were only on testnet, this was not an issues, however, it is on mainnet :))

  • NOTE: Bacalhau also changed how it handles the "Publisher" part of a Spec. -> "Publisher": "estuary" is now "PublisherSpec": {"Type": "estuary"}

StableDiffusion example has been updated to reflect changes see this contract: https://github.com/bacalhau-project/lilypad/blob/main/examples/contracts/StableDiffusionCallerv2.sol

Or open in remix: https://remix.ethereum.org/bacalhau-project/lilypad/blob/main/examples/contracts/StableDiffusionCallerv2.sol

Deployed Lilypad Events Contracts

Chain Name LilypadEvents Contract Address RPC ChainID BlockExplorer Faucet
Filecoin Calibration Net (testnet) 0xdC7612fa94F098F1d7BB40E0f4F4db8fF0bC8820 https://api.calibration.node.glif.io/rpc/v0 314159 https://calibration.filscan.io/, https://faucet.calibration.fildev.network/
Filecoin Hyperspace (testnet) 0x489656E4eDDD9c88F5Fe863bDEd9Ed0Dc29B224c https://api.hyperspace.node.glif.io/rpc/v1, https://hyperspace.filfox.info/rpc/v1, https://filecoin-hyperspace.chainstacklabs.com/rpc/v1, https://rpc.ankr.com/filecoin_testnet 3141 https://fvm.starboard.ventures/hyperspace/explorer/tx/, https://explorer.glif.io/, https://hyperspace.yoga/#faucet
Filecoin Mainnet 0xc18879C0a781DdFa0258302467687413AaD5a4E6 https://api.node.glif.io/rpc/v1, https://filecoin-mainnet.chainstacklabs.com/rpc/v1, https://rpc.ankr.com/filecoin 314 https://fvm.starboard.ventures/, https://explorer.glif.io/, https://beryx.zondax.ch/, https://filfox.io/

About Lilypad

A simple and lightweight FVM "oracle" using Bacalhau. We're enabling calling Bacalhau jobs from smart contracts!

This project harnesses the power of onchain compute with off-chain computations including traditional Oracle jobs, AI, ML and well any Docker or WASM job you can run on Bacalhau.

The work is primarily initially focussed on FEVM contract target.

Project Lilypad in 3 mins (2)

YouTube Video Link

YouTube Video

See the examples folder for how to use this in your own contracts!

Read more here

Get help: FilecoinProject Slack #bacalhau-lilypad channel

How Stuff Works

image (15)

How do I get started on using Lilypad in my project?🧑‍💻

  1. Create a contract that implements LilypadCallerInterface. As part of this interface you need to implement 2 functions:

    • lilypadFulfilled - a callback function that will be called when the job completes successfully
    • lilypadCancelled - a callback function that will be called when the job fails

  2. To trigger a job from your contract, you need to call our LilypadEvents contract which the bridge is listening to. You will connect to Bacalhau network via this bridge. Create an instance of LilypadEvents by passing the public contract address above to the LilypadEvents constructor. See our example.

  3. To make a call to Bacalhau, call runBacalhauJob from your function. You need to pass the following parameters:

    Name Type Purpose
    _from address The address of the calling contract, to which success or failure will be passed back. You should probably use address(this) from your contract.
    _spec string A Bacalhau job spec in JSON format. See below for more information on creating a job spec.
    _resultType LilypadResultType The type of result that you want to be returned. If you specify CID, the result tree will come back as a retrievable IPFS CID. If you specify StdOut, StdErr or ExitCode, those raw values output from the job will be returned.

What do I need to know to run Bacalhau?

  • Bacalhau is language-agnostic, and supports Docker or WASM workloads. As long as you can run your executable in a container, you can run it in Bacalhau.
  • You need to supply a Bacalhau job spec. To create a job spec, you can:
    • Run a Bacalhau job successfully, and then get the job spec back using bacalhau describe <job_id> --format=json.
    • Generate a job spec without running anything, using bacalhau docker run --dry-run.
    • Writing a job spec by hand, by using our schema as a guide.
  • What can I do with Bacalhau now? You can:
    • read from IPFS, Filecoin, or URLs
    • write into Estuary or IPFS

Any Example Jobs?

We have a full complement of example jobs you can leverage on the Bacalhau Docs Site

Try out

  • YOLO
  • OCR
  • Video Editing
  • and many, many more!

More Resources

See a video of this project in action here

Read more and see the presentation slides here

See our Example Project

We've created Waterlily - an AI-Art generator that pays royalties to artists (or donations to art foundations for public works).

See it live in action waterlily.ai

Screenshot 2023-03-14 at 10 14 23 am

Get in touch

We'd also LOVE to hear about what use cases you have - contact us in the FilecoinProject Slack #bacalhau or #bacalhau-lilypad channel

Contributions to this repo would also earn you many 5/5 Stable Diffusion Rainbow Unicorns (and be gratefully recieved)!

Thanks for your interest!

❤️ Bacalhau team: off-chain filecoin-native decentralised compute ❤️

#buildwithbacalhau

image

Current Release Addresses:

Hyperspace: ChainId: 3141 RPC: https://api.hyperspace.node.glif.io/rpc/v1 Contract Implementation Address: 0x42be31473913E8932bFAD617C53C318bf36e8ba9 Contract Proxy Address: 0x489656E4eDDD9c88F5Fe863bDEd9Ed0Dc29B224c

Calibration Net: ChainId: 314159 RPC: https://api.calibration.node.glif.io/rpc/v0 Contract Implementation Address: 0x6a46ddE41c3f572A07527149552b4B1875B0361B Contract Proxy Address: 0xdC7612fa94F098F1d7BB40E0f4F4db8fF0bC8820

Mainnet: ChainId: 314 RPC: https://api.node.glif.io Contract Implementation Address: 0x45A60254785834B02B3F0c9E3136e3dd1afC23f5 Contract Proxy Address: 0xc18879C0a781DdFa0258302467687413AaD5a4E6