Page cover image

Vertex Typescript SDK

Welcome to the Vertex Typescript SDK. This guide will help you navigate the Typescript SDK to interact with Vertex Protocol.

Public repo: https://github.com/vertex-protocol/vertex-typescript-sdk

The TypeScript SDK contains five packages:

  • @vertex-protocol/client: top level client package for the majority of use cases.

  • @vertex-protocol/contracts: base functions called on Vertex contracts.

  • @vertex-protocol/engine-client: interactions with the offchain sequencer.

  • @vertex-protocol/indexer-client: query historical data. e.g: candlesticks, events, etc.

  • @vertex-protocol/utils: utility library; e.g. numbers, dates.

Last updated