https://github.com/lifinance/types

Types for the LI.FI stack.
https://github.com/lifinance/types

ethereum lifi sdk types typescript web3

Last synced: 6 days ago
JSON representation

Types for the LI.FI stack.

• Host: GitHub
• URL: https://github.com/lifinance/types
• Owner: lifinance
• License: apache-2.0
• Created: 2021-10-25T04:42:16.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-04T06:37:31.000Z (13 days ago)
• Last Synced: 2024-11-04T07:27:32.911Z (13 days ago)
• Topics: ethereum, lifi, sdk, types, typescript, web3
• Language: TypeScript
• Homepage:
• Size: 10.1 MB
• Stars: 27
• Watchers: 7
• Forks: 16
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


[![license](https://img.shields.io/badge/license-Apache%202-blue)](/LICENSE.md)

[![npm latest package](https://img.shields.io/npm/v/@lifi/types/latest.svg)](https://www.npmjs.com/package/@lifi/types)

[![npm downloads](https://img.shields.io/npm/dm/@lifi/types.svg)](https://www.npmjs.com/package/@lifi/types)

[![Follow on Twitter](https://img.shields.io/twitter/follow/lifiprotocol.svg?label=follow+LI.FI)](https://twitter.com/lifiprotocol)



# LI.FI - Types

Types for the LI.FI stack.

## Summary

This package contains all common types for the [LI.FI SDK](https://github.com/lifinance/sdk).

Learn more about LI.FI on (https://li.fi).

Check out the [Changelog](./CHANGELOG.md) to see what changed in the last releases.

## Installation

```bash

yarn add @lifi/types

```

or

```bash

npm install --save @lifi/types

```

## Release

The package uses `standard-version` to generate a changelog based on semantic commit history. The `standard-version` package also handles version numbering.

Once main is up to date with the changes to be released execute the following command on the main branch to invoke `standard-version`:

```bash

yarn release

```

Then to release:

```bash

git push --follow-tags origin main

```

This will push a newly created git tag to the remote repository, which will trigger a github action which will publish the new version to npm