https://github.com/project-serum/serum-ts

Project Serum TypeScript monorepo
https://github.com/project-serum/serum-ts

Last synced: about 1 month ago
JSON representation

Project Serum TypeScript monorepo

• Host: GitHub
• URL: https://github.com/project-serum/serum-ts
• Owner: project-serum
• License: apache-2.0
• Created: 2020-10-22T18:31:05.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-31T07:12:58.000Z (7 months ago)
• Last Synced: 2024-10-20T18:03:34.275Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://projectserum.com
• Size: 21.5 MB
• Stars: 272
• Watchers: 12
• Forks: 246
• Open Issues: 112
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - project-serum/serum-ts - Project Serum TypeScript monorepo (TypeScript)

README

        


  


  
serum-ts


  


    Project Serum Monorepo

  


  


    

    

    

  


  


    Website

     | 

    Academy

     | 

    Awesome

     | 

    DEX

     | 

    Rust

  



## Packages

| Package                                             | Version                                                                                                                   | Description                                             |

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

| [`@project-serum/borsh`](/packages/borsh)           | [![npm](https://img.shields.io/npm/v/@project-serum/borsh.svg)](https://www.npmjs.com/package/@project-serum/borsh)           | Borsh serialization primitives |

| [`@project-serum/common`](/packages/common)           | [![npm](https://img.shields.io/npm/v/@project-serum/common.svg)](https://www.npmjs.com/package/@project-serum/common)           | Common utilities |

| [`@project-serum/serum`](/packages/serum)                 | [![npm](https://img.shields.io/npm/v/@project-serum/serum.svg)](https://www.npmjs.com/package/@project-serum/serum)                 | Library for interacting with the Serum DEX |

| [`@project-serum/pool`](/packages/pool)             | [![npm](https://img.shields.io/npm/v/@project-serum/pool.svg)](https://www.npmjs.com/package/@project-serum/pool)             | Client for interacting with Pools |

| [`@project-serum/spl-token-swap`](/packages/spl-token-swap) | [![npm](https://img.shields.io/npm/v/@project-serum/spl-token-swap.svg)](https://www.npmjs.com/package/@project-serum/spl-token-swap)                 | Client for interacting with the SPL Token Swap Program |

| [`@project-serum/swap`](/packages/swap)                 | [![npm](https://img.shields.io/npm/v/@project-serum/swap.svg)](https://www.npmjs.com/package/@project-serum/swap)                 | Client for swapping on the Serum DEX |

| [`@project-serum/tokens`](/packages/tokens)                 | [![npm](https://img.shields.io/npm/v/@project-serum/tokens.svg)](https://www.npmjs.com/package/@project-serum/tokens)                 | Solana token addresses |

## Contributing

### Installing

To get started first install the required build tools:

```

npm install -g lerna

npm install -g yarn

```

Then bootstrap the workspace:

```

yarn

```

### Building

To build the workspace:

```

yarn build

```

### Testing

To run all tests:

```

yarn test

```

### Linting

To lint:

```

yarn lint

```

To apply lint fixes:

```

yarn lint:fix

```