-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
16 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,99 +1,36 @@ | ||
| <div align="center"> | ||
| <img width="200" src="./logo.png" alt="Sablier Logo" /> | ||
|
|
||
| <h1>Sablier</h1> | ||
|
|
||
| <p> | ||
| <strong>Solana automation engine</strong> | ||
| </p> | ||
|
|
||
| <p> | ||
| <a href="https://github.com/sablier-xyz/sablier/actions/workflows/code-scan.yaml"><img alt="code scan" src="https://github.com/sablier-xyz/sablier/actions/workflows/code-scan.yaml/badge.svg?branch=main" /></a> | ||
| <a href="https://www.gnu.org/licenses/agpl-3.0.en.html"><img alt="License" src="https://img.shields.io/github/license/clockwork-xyz/clockwork?color=turquoise" /></a> | ||
| </p> | ||
|
|
||
| <h4> | ||
| <a href="https://sablier.dev/">Home</a> | ||
| <span> | </span> | ||
| <a href="https://docs.clockwork.xyz">Docs</a> | ||
| <span> | </span> | ||
| <a href="https://twitter.com/clockwork_xyz">Twitter</a> | ||
| </h4> | ||
| [<img alt="github" src="https://img.shields.io/badge/github-Sablier/sablier-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/AdrenaFoundation/sablier) | ||
| [<img alt="crates.io" src="https://img.shields.io/crates/v/sablier-thread-program.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/sablier-thread-program) | ||
| [<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/AdrenaFoundation/sablier/ci.yml?branch=main&style=for-the-badge" height="20">](https://github.com/AdrenaFoundation/sablier/actions/workflows/ci.yml?query=branch%3Amain) | ||
| </div> | ||
|
|
||
| # Deployments | ||
|
|
||
| | Program | Address | Devnet | Mainnet | | ||
| | --------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | ||
| | Network | `F8dKseqmBoAkHx3c58Lmb9TgJv5qeTf3BbtZZSEzYvUa` | [v2.0.15](https://explorer.solana.com/address/F8dKseqmBoAkHx3c58Lmb9TgJv5qeTf3BbtZZSEzYvUa) | [v2.0.0](https://explorer.solana.com/address/F8dKseqmBoAkHx3c58Lmb9TgJv5qeTf3BbtZZSEzYvUa) | | ||
| | Thread v2 | `CLoCKyJ6DXBJqqu2VWx9RLbgnwwR6BMHHuyasVmfMzBh` | [v2.0.18](https://explorer.solana.com/address/CLoCKyJ6DXBJqqu2VWx9RLbgnwwR6BMHHuyasVmfMzBh?cluster=devnet) | [v2.0.17](https://explorer.solana.com/address/CLoCKyJ6DXBJqqu2VWx9RLbgnwwR6BMHHuyasVmfMzBh) | | ||
| | Thread v1 | `3XXuUFfweXBwFgFfYaejLvZE4cGZiHgKiGfMtdxNzYmv` | [v1.4.2](https://explorer.solana.com/address/3XXuUFfweXBwFgFfYaejLvZE4cGZiHgKiGfMtdxNzYmv?cluster=devnet) | [v1.4.2](https://explorer.solana.com/address/3XXuUFfweXBwFgFfYaejLvZE4cGZiHgKiGfMtdxNzYmv) | | ||
|
|
||
| # SDKs | ||
|
|
||
| | Language | Description | Lib | Examples | | ||
| | ---------- | ---------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------- | | ||
| | Anchor | Anchor bindings for Solana programs. | [crates.io](https://crates.io/crates/clockwork-sdk) | [See Example Repo](https://github.com/clockwork-xyz/examples) | | ||
| | Rust | Rust bindings for clients. | [crates.io](https://crates.io/crates/clockwork-client) | [See Example Repo](https://github.com/clockwork-xyz/examples) | | ||
| | Typescript | Typescript bindings for clients and frontends. | [npm](https://www.npmjs.com/package/@clockwork-xyz/sdk) | [Explorer](https://github.com/clockwork-xyz/explorer) | | ||
|
|
||
| # Notes | ||
|
|
||
| - Sablier is under active development. All interfaces and implementations are subject to change. | ||
| - Official program deployments to Solana mainnet are secured by a 2-of-2 [multisig](https://v3.squads.so/info/7gqj7UgvKgHihyPsXALW8QKJ3gUTEaLeBYwWbAtZhoCq) and managed by the core team of software maintainers. | ||
| - To deploy a worker node on mainnet or devnet, please [install](#deploying-a-worker) the Sablier geyser plugin on your Solana validator or RPC node and request an earlybird token delegation in the workernet channel [on Discord](https://discord.gg/mwmFtU5BtA). | ||
| - Occasionally, a new software release may change the state schema and require users to migrate to a new program. These releases will be marked by a new major version upgrade (e.g. `v2.x`, `v3.x`, etc.). | ||
| - The smart-contracts in this repository are automatically scanned by [Sec3's](https://www.sec3.dev/) auto-auditing software and are currently being reviewed by the team at [Ottersec](https://osec.io/). Their audit report is in progress and will be published soon. | ||
|
|
||
| # Getting Started | ||
|
|
||
| - ["I am a developer, and I want to build a program on localnet"](#local-development) | ||
| - ["I am a node operator, and I want to deploy a Sablier worker"](#deploying-a-worker) | ||
|
|
||
| # Local Development | ||
|
|
||
| #### 1. Install sablier-cli. | ||
|
|
||
| If you are on linux, you might need to run this: | ||
|
|
||
| ```sh | ||
| sudo apt-get update && sudo apt-get upgrade && sudo apt-get install -y pkg-config build-essential libudev-dev libssl-dev | ||
| ``` | ||
|
|
||
| Install with cargo: | ||
|
|
||
| ```sh | ||
| cargo install -f --locked sablier-cli | ||
| ``` | ||
|
|
||
| #### 2. Run a localnet node. | ||
|
|
||
| ```sh | ||
| sablier localnet | ||
| ``` | ||
|
|
||
| #### 3. Stream program logs. | ||
| ## 📝 Notes | ||
|
|
||
| ```sh | ||
| solana logs --url localhost | ||
| ``` | ||
| Sablier is under active development. All interfaces and implementations are subject to change. | ||
|
|
||
| # Guides & Examples | ||
| ## 📍 Overview | ||
|
|
||
| - We have ready to run examples apps: https://github.com/clockwork-xyz/examples. | ||
| - If you are looking for walkthough, take a look at the docs: https://docs.clockwork.xyz/developers/guides. | ||
| - If you have a certain use case you would like to discuss, we are happy to [help](https://discord.com/channels/889725689543143425/1029516796304306247). | ||
| Sablier is an advanced automation engine built for the Solana blockchain ecosystem. It provides developers with powerful tools to create and manage automated, self-executing programs. | ||
|
|
||
| --- | ||
| Sablier aims to empower developers to build more sophisticated, efficient, and autonomous applications on Solana, opening up new possibilities for decentralized finance (DeFi), gaming, and other blockchain-based solutions. | ||
|
|
||
| # Deploying a worker | ||
| ## 🚀 Current Deployement | ||
|
|
||
| > If you just want to test your smart contracts on localnet, check the previous section. | ||
| See [CURRENT_DEPLOYMENT.md](./CURRENT_DEPLOYMENT.md) for the current deployment details. | ||
|
|
||
| If you are a node operator looking to deploy the clockwork plugin, please talk to us for a smooth onboarding. Here's a one pager on how to be part of the automation network: https://docs.clockwork.xyz/workernet/deploying-a-worker. | ||
| ## 🧪 Examples | ||
|
|
||
| ## Common Errors | ||
| See [examples](./examples/) for the examples. | ||
|
|
||
| Please refer to the [FAQ](https://docs.clockwork.xyz/developers/faq). | ||
|
|
||
| ## Questions | ||
| ## 📚 Documentation | ||
|
|
||
| Come build with us and ask questions on [Discord](https://discord.gg/epHsTsnUre)! | ||
| Coming soon. |
