https://github.com/hirosystems/clarity-examples

https://github.com/hirosystems/clarity-examples

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/hirosystems/clarity-examples
• Owner: hirosystems
• Created: 2022-11-02T20:13:52.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-27T23:09:17.000Z (3 months ago)
• Last Synced: 2024-03-28T00:23:43.706Z (3 months ago)
• Language: JavaScript
• Size: 1.46 MB
• Stars: 5
• Watchers: 7
• Forks: 9
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stacks-chain - Example Contracts - A collection of sample smart contracts to serve as a starting point for writing your own. (Clarity Resources / Example Contracts)

README

        
# Welcome to Clarity Examples

The Clarity Examples repository includes a collection of reusable [Clarity](https://clarity-lang.org/) smart contracts. These examples can help developers rapidly kickstart their journey onto the Stacks blockchain.

Furthermore, [Hiro Platform](https://platform.hiro.so/) allows developers to discover these smart contracts, clone, extend, and deploy the customized contracts—in a few clicks—all from the browser.

> **NOTE**: The examples provided in this repository are for educational purposes and have not been security audited.

## Available Examples

| Clarity Example                                     | Description                                                                                                                               |

| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |

| [hello-world](/examples/hello-world/)               | A beginner smart contract with examples of commonly used Clarity expressions and data structures                                          |

| [blank-project](/examples/blank-project)            | Create a project from scratch: Start from a blank scaffold for your next Clarity contract                                                 |

| [stx-defi](/examples/stx-defi)                      | Demonstrates a DeFi protocol with deposits of STX, borrowing and repaying the STX-based loan, and interest and yield calculations         |

| [counter](/examples/counter/)                       | Demonstrates how to use and interact with "variables" in Clarity by incrementing a 32-bit unsigned integer                                |

| [clarity-bitcoin](/examples/clarity-bitcoin/)       | Demonstrates how to parse Bitcoin transactions and block headers, and to verify Bitcoin transactions                                      |

| [fungible-token](/examples/fungible-token/)         | Demonstrates a basic fungible token that conforms to the SIP-010 FT standard                                                              |

| [non-fungible-token](/examples/non-fungible-token/) | Demonstrates a basic NFT collection that conforms to the SIP-009 NFT standard                                                             |

| [nft-marketplace](/examples/nft-marketplace/)       | Demonstrates a minimalistic NFT marketplace that allows users to list NFT for sale                                                        |

| [lightning-swaps](/examples/lightning-swaps/)       | Demonstrates LNSwap's submarine swaps between Stacks and Bitcoin                                                                          |

| [ordyswap](/examples/ordyswap/)                     | Demonstrates trustless atomic swaps between Ordinals and Stacks                                                                           |

## Logistics

All examples include a README and some have pointers to real-world projects in the Stacks blockchain.

Each example also includes unit tests under the `/tests` directory to help guide developers to familiarize themselves with testing concepts.

Additionally, each example can run in Clarinet as-is. In a terminal of choice and with [Clarinet](https://docs.hiro.so/clarinet/getting-started) installed, developers can go to the respective example folder, run `clarinet check`, `clarinet integrate`, and explore other [Clarinet features](https://docs.hiro.so/clarinet/introduction).

Alternatively, you can skip setting up your development environment on your laptop and instead go to https://platform.hiro.so to let Hiro Platform do all the heavy lifting of setting it up on your behalf. You can select the example of choice, explore the code, customize it, or deploy it to Stacks blockchain in a few clicks.

With Hiro Platform, we want to encourage developers to focus on shipping their business models to Stacks blockchain, ship often and happily, and not get caught up with unboxing and infrastructure overhead.

## Contributing

Contributions are welcome!

To prepare the project for development, run `npm i` from the root of your local clone/fork.

This project contains a pre-commit script that will generate a new `metadata.json` file and new contents of the `zips` folder based on your changes. This script will run automatically pre-commit, or you can run it manually using the command `npm run build`.