Skip to content

Files

Latest commit

 Cannot retrieve latest commit at this time.

History

History
75 lines (47 loc) · 1.54 KB

README.md

File metadata and controls

75 lines (47 loc) · 1.54 KB

Hop v1 SDK

The Hop Protocol v1 TypeScript SDK

Documentation License NPM version

Demo

https://sdk-demo.hop.exchange/

Install

pnpm --filter @hop-protocol/sdk... install

CDN

jsDelivr CDN

<script src="https://cdn.jsdelivr.net/npm/@hop-protocol/sdk@latest/hop.js"></script>

unpkg CDN

<script src="https://unpkg.com/@hop-protocol/sdk@latest/hop.js"></script>

Documentation

For getting started and examples, see docs.hop.exchange/v/developer-docs/js-sdk/js-sdk

For sdk API reference, see sdk-docs.hop.exchange

Development

Install dependencies

pnpm install

Run build watcher

pnpm run dev

Build sdk

pnpm run build

Generate documentation

pnpm run docs

The markdown API reference docs are generated in docs/. There's is also a generated website for API reference the docs at docs-ui/.

Test

pnpm test

License

MIT