Skip to content

Commit

Permalink
add ci + license + readme (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
buffalu committed Jul 25, 2024
1 parent 3e12dbc commit b0e2934
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Rust Clippy CI
name: ci

on:
push:
Expand Down
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TODO
72 changes: 71 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,71 @@
# Hello world
# Jito Staking Manager (JSM)

[![Build Status](https://github.com/jito-labs/jsm/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/jito-labs/jsm/actions)
[![License](https://img.shields.io/badge/License-BSL%201.1-blue.svg)](https://mariadb.com/bsl11/)
[![codecov](https://codecov.io/gh/jito-labs/jsm/branch/master/graph/badge.svg?token=Q28COAGZ89)](https://codecov.io/gh/jito-labs/jsm)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

Jito Staking Manager (JSM) is a next-generation restaking platform for Solana and SVM environments.

**This project is currently under development and is not yet ready for production use.
Expect breaking changes.**

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Running Tests](#running-tests)
- [Contributing](#contributing)
- [License](#license)

## Features

- Universal framework for staking, restaking, and liquid restaking
- LRT construction and management
- Customizable slashing conditions
- Flexible AVS and operator management

## Installation

```bash
$ git clone https://github.com/jito-labs/jsm.git
$ cd jsm
$ cargo-build-sbf
```

## Usage

### Building the software

```bash
$ cargo-build-sbf
```

## Running Tests

### Outside of SVM

```bash
$ cargo nextest run
```

### Testing using the SVM environment

```bash
$ cargo-build-sbf && SBF_OUT_DIR=$(pwd)/target/sbf-solana-solana/release cargo nextest run
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

* Fork the project
* Create your feature branch (git checkout -b username/feature_name)
* Commit your changes (git commit -m 'Add some feature')
* Push to the branch (git push origin username/feature_name)
* Open a Pull Request

## License

This project is licensed under the Business Source License 1.1 - see the [LICENSE](LICENSE) file for details.

0 comments on commit b0e2934

Please sign in to comment.