Skip to content

Instantly share code, notes, and snippets.

@HashWarlock

HashWarlock/Phala-Hackathon-Guide.md

Last active September 19, 2024 19:04
Show Gist options
  • Save HashWarlock/10dabcb2f11bc16d59c3843e6618ff30 to your computer and use it in GitHub Desktop.
Save HashWarlock/10dabcb2f11bc16d59c3843e6618ff30 to your computer and use it in GitHub Desktop.
Download ZIP
Phala Hackathon Guide
Raw
Phala-Hackathon-Guide.md

Phala Hackathon Guide at ETHGlobal Singapore

Welcome to the Phala Hackathon Guide! This guide will provide you with all the necessary information to get started building on our platform. Whether you're a seasoned developer or new to the ecosystem, this guide will help you navigate through the essential steps and resources for build on Phala's Agent Contract.

Check out the an Agent Contract we deployed called the TEE Cheat Sheet!

If you want to know how to host HTML pages with hono, check out the Agent Contract template here.

Table of Contents

  1. Introduction
  2. Prizes
  3. Important Dates
  4. Getting Started
  5. Get API Key on RedPill
  6. Set Up Your First Agent Contract
  7. Getting Rugged By The WiFi?!
  8. Resources
  9. Support

Introduction

Welcome to the Hackathon guide for Phala's Agent Contracts. We are offering you the key to connecting to multiple sponsor's bounties through our general-purpose program executing in a TEE (Trusted Execution) on Phala Network at ZERO cost & NO new wallet required.

Why is Agent Contract Built DIFFERENT?!

  • 💨 Ship Fast: Build and ship with familiar toolchain in minutes
  • ⛑️ Secure: Execution guarded by rock solid TEE / Intel SGX
  • 🔒 Private: Host API keys and user privacy at ease
  • 💎 Unstoppable: Powered by IPFS and Phala's 35k+ decentralized TEE workers
  • 🔥 hono/tiny Support: a small, simple, and ultrafast web framework built on Web Standards.
  • 🧪: Vite Test Framework: Vite Testing Framework support, but your free to change the test framework to your desire.

NOTICE

We recommend using @hono/tiny to avoid a large bundle size and the 20MB final artifact limitation.

Here are our feature templates:

  • RedPill Agent Contract - Get your FREE RedPill API Key and access top LLMs from OpenAI, Anthropic, Meta, Gwen, Mistral, and Google to create a Web3 x AI project for the hackathon.
  • Viem SDK Agent Contract - Learn about a new paradigm in transacting onchain with the Viem SDK Agent Contract Template with key features to:
    • Derive an ECDSA account within a TEE
    • Sign/Verify Data with the derived account
    • Transact on any EVM chain

Prizes

We have exciting prizes for the top project:

  1. 1st Place: $3,000 + Ledger Nano X
  2. 2nd Place: $1,500 + TEE Swag
  3. 3rd Place: $500 + TEE Swag

Bonus Bounty: Reach the ETHGlobal finals, and you’ll snag another Ledger Nano X on us!

How to qualify for as a top project?

  • (Strong Consideration) Integrate Agent Contract with the Viem SDK to interact on-chain with any EVM Chain or other sponsor projects at ETHGlobal to create a unique product.
  • (Strong Consideration) Build an AI x Web3 product with RedPill Agent Contract Template or any other AI related templates we support located in our docs
  • Build a Farcaster Frame with Agent Contract for Web3 Social

Each winner will get access to a Tier 2 Swag Bag provided by the Phala Team

Important Dates

  • Hackathon Start: September 20th
  • Submission Deadline: September 22nd 9am
  • Judging Period: 2 Hours and 30 Minutes
  • Winners Announcement: September 22nd

Getting Started

To get started with Phala Network, follow these steps:

  • Take the RedPill and access top AI LLMs: Get an API Key on RedPill. (This requires a code to get access. Reach out to the Phala Team to get access. In the meantime, use the free developer API key that is rate limited.)
  • Try a New Paradigm in Transacting Onchain: Build on the viem Agent Contract Template where you can derive an account within a TEE and utilize the account to transact on any EVM chain.
  • Choose from a List of Agent Contract Templates or build a custom Agent Contract that connect to any API or uses an SDK of your choosing!
  • Explore Documentation: Familiarize yourself with our Developer Documentation.
  • Join the Community: Connect with other developers on our Discord Server.

Get API Key on RedPill

If you want to use the global hackathon RedPill API key, here are the details:

Before you start building, you'll need to set up your development environment. Here are the prerequisites:

  1. Node.js: Install the latest version of Node.js from nodejs.org.
  2. Code Editor: Any code editor will work. We recommend using Visual Studio Code.

Test RedPill API

curl https://api.red-pill.ai/v1/chat/completions
-H "Content-Type: application/json"
-H "Authorization: Bearer <YOUR_REDPILL_API_KEY>"
-d '{ "model": "gpt-3.5-turbo", "messages": [ { "role": "user", "content": "Hello world!" } ], "temperature": 1 }'

Set Up Your First Agent Contract

To set up your first Agent Contract, you can follow these resources:

Getting Rugged By The WiFi?!

Run a local testnet with docker support. All you need to do to get a local testnet started is run:

WARNING

Running the local testnet may return an error if port 8000 is already in use.

npm run dev

Make a Request to Your Local Build

# GET request
curl http://127.0.0.1:8000/local
# GET request with URL queries
curl http://127.0.0.1:8000/local?query1=one&query2=two
# POST request
curl http://127.0.0.1:8000/local -X POST -H 'content-type: application/json' -d '{"foo": "bar"}'

Add Secrets to Your Local Build

curl http://127.0.0.1:8000/vaults -H 'Content-Type: application/json' -d '{"cid": "local", "data": {"secretKey":"secretValue"}}'

Check The Logs of Your Local Build

curl 'http://127.0.0.1:8000/logs/all/local'

Resources

Here are some additional resources to assist you:

Support

If you need help, we're here for you:

  • Discord: Join our Discord Server for real-time support.
  • Forum: Post your questions on our Community Forum.
  • FAQ: Agent Contract development FAQ

We can't wait to see what you build at the Phala Hackathon. Happy coding!

Best Practices

To ensure a smooth development experience and to make the most out of the Phala platform, consider the following best practices:

  1. Modular Code: Write modular and reusable code to enhance maintainability.
  2. Security First: Always prioritize security, especially when dealing with sensitive data.
  3. Documentation: Document your code and APIs thoroughly to help others understand and contribute.
  4. Testing: Implement comprehensive testing to catch bugs early and ensure reliability.
  5. Community Engagement: Engage with the community to get feedback and improve your project.

Submission Guidelines

To submit your project for the hackathon, follow these steps:

  1. Prepare Your Project: Ensure your project is complete and well-documented.
  2. Create a Repository: Host your project on GitHub or any other version control platform.
  3. Demo Video: Include a short demo video showcasing your project and its features.

Judging Criteria

Projects will be judged based on the following criteria:

  1. Technical excellence: How smoothly everything works
  2. UX and design: How great everything feels
  3. Potential impact: How it is going to make the world a better place
  4. Wow factor: How it would become the next big thing
  5. Business model: How it would generate ROI

Contact Us

If you have any questions or need further assistance, feel free to reach out:

Thank you for participating in the Phala Hackathon. We look forward to seeing your innovative solutions and wish you the best of luck!

Phala Network Team

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment