https://github.com/kitzen-io/assets

A thorough and contemporary compilation of information on thousands of cryptocurrency tokens
https://github.com/kitzen-io/assets

Last synced: 5 days ago
JSON representation

A thorough and contemporary compilation of information on thousands of cryptocurrency tokens

• Host: GitHub
• URL: https://github.com/kitzen-io/assets
• Owner: kitzen-io
• License: mit
• Created: 2023-08-06T09:21:45.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-19T09:49:42.000Z (12 months ago)
• Last Synced: 2024-01-19T11:05:12.450Z (12 months ago)
• Language: JavaScript
• Size: 105 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @kitzen/assets

[![npm version](https://img.shields.io/npm/v/@kitzen/assets?color=green)](https://www.npmjs.com/package/@kitzen/assets)

[![from kitzen with Love](https://img.shields.io/badge/from%20kitzen%20with-%F0%9F%A4%8D-red)](https://kitzen.io/)

The Kitzen token repository offers an extensive and current database encompassing thousands of cryptocurrency tokens. 

Projects, including Kitzen, utilize the token logos sourced from here. 

Each token comes with a logo and the possibility of supplementary details, which are not accessible on-chain. 

Maintaining this vast compilation is a communal endeavor, so contributions by adding your token are welcome.

## Getting started

````

yarn add @kitzen/assets

````

## Usage

You can access list of all metadata object just

````

import { AssetsMetadata, IAssetMetadata } from '@kitzen/assets';

const network = 'bitcoin';

const identifier = 'coin';

const asset: IAssetMetadata = AssetsMetadata.find((metadata: IAssetMetadata) => metadata.network === network && metadata.identifier === identifier); 

````

Or you can access metadata of asset without iteration O(1) just by key:

````

import { AssetsMetadataObject, IAssetMetadata } from '@kitzen/assets';

const network = 'bitcoin';

const identifier = 'coin;

const asset: IAssetMetadata = AssetsMetadataObject[network][identifier]; 

````

## Versioning

This lib use [semantic-release](https://github.com/semantic-release/semantic-release#how-does-it-work) library.

Please, set valid commit message, to increment the right version

### To increase path (x.y.Z) version

`````fix: your commit message...`````

### To increase minor (x.Y.z) version

`````feat: your commit message...`````

### To increase version (X.y.z) version

`````perf: your commit message...`````

# Logos

 - All logos must be in SVG format to avoid the need for mobile apps to support multiple image assets, which would significantly increase app size and frontend complexity

 - All logos should have a fixed size of 36x36

# Contributing

We deeply appreciate the valuable contributions made by our community. 

To provide feedback or report bugs, [kindly open a GitHub issue](https://github.com/kitzen-io/api-dto/issues/new).

For code contributions, explore our "Contributing" guidelines and become part of our open-source community. 

Thank you to all the dedicated individuals who contribute; your passion drives our success. Together, we shape the future of web3 industry.