PushChain Examples

A comprehensive collection of example applications, SDK functions, and smart contracts to help you build on PushChain. This repository serves as a learning resource and reference implementation for developers looking to leverage PushChain's cross-chain capabilities.

Repository Structure

Apps

Complete application examples showcasing various PushChain features and integration patterns. Each app demonstrates a specific use case or implementation approach.

Available Applications

• Simulate - A transaction simulation tool that helps developers test and validate cross-chain transactions before executing them on mainnet. Includes transaction preview and gas estimation features.

Core SDK Functions

Examples of how to use PushChain's SDK for common blockchain operations, including account management, transaction handling, cross-chain communication, and more.

Available SDK Examples

• Create Universal Signer - Learn how to create and manage universal signers that work across multiple blockchains.

• Custom Universal Signer - Advanced examples of customizing universal signer behavior for specific use cases.

• Initialize EVM Client - Examples of connecting to and interacting with EVM-compatible blockchains.

• Initialize Push Chain Client - Learn how to initialize and configure the PushChain client for your applications.

• Reading Push Chain State - Examples of reading and querying state from the PushChain network.

• Send Universal Transaction - Learn how to send transactions that work across multiple blockchains using PushChain's universal transaction system.

• Speedrun - Quick start examples for rapid development and testing.

• Utility Functions - Common utility functions and helper methods for PushChain development.

• Others Contract Helpers - Additional contract interaction helpers and utilities.

Tutorials

Step-by-step guides and example projects that teach you how to build specific features using PushChain. Each tutorial includes both smart contracts and frontend code.

Available Tutorials

• Universal Counter - A demonstration of cross-chain interaction using PushChain's Universal Ethereum Account (UEA) system. This project shows how users from Ethereum, Solana, and PushChain can interact with the same application seamlessly.

Featured Examples

Universal Counter

A demonstration of cross-chain interaction using PushChain's Universal Ethereum Account (UEA) system. This project shows how users from Ethereum, Solana, and PushChain can interact with the same application seamlessly.

Go to Universal Counter Tutorial →

Getting Started

1. Choose Your Path: Browse the repository to find an example that matches your use case

   • For complete applications, start with the Apps directory
   • For SDK integration, explore the Core SDK Functions directory
   • For learning tutorials, check out the Tutorials directory

2. Follow Instructions: Each example includes detailed README instructions for setup and usage

3. Experiment: Modify the code to suit your specific needs and requirements

4. Build: Use these examples as building blocks for your own PushChain applications

Prerequisites

• Basic knowledge of blockchain development concepts
• Familiarity with JavaScript/TypeScript for frontend examples
• Understanding of Solidity for smart contract examples
• Node.js and npm/yarn for development environment

Quick Start

To get started with any example:

# Clone the repository
git clone https://github.com/pushchain/push-chain-examples.git
cd push-chain-examples

# Navigate to your chosen example
cd apps/chess  # or any other app

# Install dependencies
npm install

# Start the development server
npm run dev

Development Workflow

1. Explore Examples: Start by running the examples to understand how they work
2. Study Code: Examine the implementation details and patterns used
3. Modify: Make changes to experiment with different features
4. Build: Create your own applications using these patterns
5. Contribute: Share your improvements and new examples with the community

Resources

• PushChain Documentation
• PushChain GitHub
• PushChain Community Discord
• PushChain Portal

Contributing

Contributions are welcome! If you have an example or tutorial you'd like to add, please submit a pull request. We encourage:

• New application examples
• Additional SDK function examples
• Tutorial improvements
• Documentation enhancements
• Bug fixes and performance improvements

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

If you need help with any of these examples or have questions about PushChain development:

• Join our Discord community
• Check our documentation
• Open an issue on GitHub for bugs or feature requests