Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.phylax.systems/llms.txt

Use this file to discover all available pages before exploring further.

Projects are the organizational unit in the Phylax platform. Each project represents a protocol or set of smart contracts that you want to protect with assertions.

What are Projects?

A project groups together:
  • One or more smart contract addresses
  • Assertions that protect those contracts
  • Pending and deployed releases
  • Staging and production invalidations
  • Notification settings and project events
  • Collaborators and role-based access
  • Project metadata (name, description, target chain)
Projects enable you to manage all your protocol’s assertions from a single interface. The project itself is an off-chain organizing layer; the on-chain State Oracle remains the source of truth for which assertions are active for each protected contract.

Creating a Project

To create a new project:
  1. Navigate to the “Projects” tab in the platform navigation bar
  2. Click “Create a project”
  3. Enter project details:
    • Project Name: Typically matches your protocol or contract name
    • Project Description: Brief explanation of what your project does
    • Target Chain: The blockchain where your contracts are deployed
  4. Click “Continue”
  5. Add contract addresses:
    • Enter each contract address you want to protect
    • Only contracts where your wallet is authorized can be added
    • The platform verifies admin access via the network’s admin verifier (often owner-based)
  6. Review your project details
  7. Click “Create Project” to create the project
Create project form in the Phylax platform
Only authorized admins can create a project for a contract. Most deployments use owner-based verification by default. See Ownership Verification for details.For contracts that don’t pass the default verifier, you may be able to request manual verification.

Managing Projects

Once created, you can manage your project through the project dashboard:

View Project Details

  • See all contract addresses in the project
  • View project metadata
  • See all assertions
  • See project events in the audit log, including assertion, contract, release, notification, collaborator, and invalidation activity
  • See all incidents

Add or Remove Contracts

  • Add new contract addresses to your project
  • Remove contracts that are no longer active
  • Update contract information

Deploy Assertions

  • Deploy assertions to your project via pcl apply
  • Review release changes through the platform
  • View all active assertions protecting your contracts
Deploy Assertions
For detailed instructions on deploying assertions, see the Deploy Assertions guide.

Project Settings

In the project settings tab, you can: Update Project Details: Here you can update the project name, description, and delete the project. Transfer Project Ownership: You can transfer projects and contracts (including their associated assertions) to other wallets. This allows you to transfer project ownership while maintaining all linked assertions and contracts. Protocol admin / manager wallet: The wallet that signs assertion lifecycle transactions can be separate from the day-to-day platform account. Use this separation when your team wants project collaborators to review releases and incidents without requiring routine access to the multisig or governance wallet that controls deployment. Access controls: Admins can invite collaborators by email or wallet address. Use roles to separate review work from deployment authority:
RoleTypical permissions
ViewerView incidents and project information without making changes
EditorCreate releases and configure notifications
AdminManage members, settings, and the protocol manager wallet
Analytics sharing: Detailed invalidation evidence is scoped to project members. Admins can opt in to share invalidations or transactions dropped by the node operator with Phylax support and network teams for customer support and debugging. Integrations: Set up integrations to receive notifications when incidents occur, including Slack and PagerDuty where available.
Project settings showing analytics sharing controls and integration options

Project Dashboard

The project dashboard provides a unified view of your project’s security:
  • Active Assertions: See all assertions currently protecting your contracts
  • Assertion Deployment: Deploy or remove assertions for your project
  • Ready for Deployment: Assertions submitted via pcl that need to be linked and deployed
  • Assertion Status: Monitor execution status and any triggered violations. Status shows whether assertions are marked for enforcement/staging or enforced/staged
  • Recent Incidents: View detailed incidents for your project (see Incidents)
  • Audit Log: Review project changes, assertion lifecycle events, collaborator changes, release activity, and invalidations over time
  • Project Settings: Update project details and manage contracts
Project overview showing releases, contracts, active assertions, status, and network

Audit Log

The audit log gives your team a chronological record of project activity. Use it to answer what changed, who initiated the change, what entity was affected, and when the change occurred. Audit log entries can include:
  • Project creation and profile changes
  • Contracts added or removed
  • Assertions submitted, activated, or removed
  • Production and staging release events
  • Protocol manager changes
  • Collaborator role changes
  • Invalidations and incident-related activity
Project audit log showing timestamped project, assertion, contract, manager, and invalidation events

Next Steps

Deploy Assertions

Step-by-step guide to using the platform

Writing Assertions

Learn how to write assertions for your contracts

Ownership Verification

Understand ownership requirements

pcl Reference

pcl command reference