@fanitrade/fani-solana-tokenlist/README.md

Fanitrade Token Registry

### Installation

```bash
npm i @fanitrade/fani-solana-tokenlist
```

```bash
yarn add @fanitrade/fani-solana-tokenlist
```

### Examples

#### Query available tokens

```typescript
new TokenListProvider().resolve().then((tokens) => {
  const tokenList = tokens.filterByClusterSlug('mainnet-beta').getList();
  console.log(tokenList);
});
```


### Query available tokens on chain
```typescript
import { getTokenMetaData } from "@fanitrade/fani-solana-tokenlist";
import { Connection, clusterApiUrl } from "@solana/web3.js";

const connection = new Connection(clusterApiUrl('devnet'));

( async () => {
  const mint = "7SLdnLCBDFEBAZvzdh9vGeuoZBD165ajKfAxSgyjFjwv";

  const metadata = await getTokenMetaData(connection , mint);
  console.log(metadata);

})()
```

#### Response
```json
{
  "name": "Token NAME",
  "address": "7SLdnLCBDFEBAZvzdh9vGeuoZBD165ajKfAxSgyjFjwv",
  "symbol": "test",
  "image": "https://images.google.com/images/branding/googlelogo/1x/googlelogo_light_color_272x92dp.png",
  "extensions": {
    "website": "",
    "facebook": "",
    "twitter": "",
    "github": "",
    "discord": "",
    "telegram": ""
  }
}
```


### Adding new token
```typescript
import { addTokenToList } from "@fanitrade/fani-solana-tokenlist";


( async () => {
      const token =  await addTokenToList("YOUR_GITHUB_ACCESS_TOKEN" , {
        address : "MINT ADDRESS",
        symbol: "SYL",
         name: "TOKEN NAME",
        decimals:"0",
        logoURI:"LOG0_URL.png", 
        extensions: {
            website: "WEBSITE_URL",
            facebook: "FACEBOOK_URL",
            twitter: "TWITTER_URL",
        }
    })
    console.log(token)
})()
```

#### Response 
```javascript
{
  status: "Created",
  message: "Token Created"
}
```

```javascript
 {
  status: 'Failed',
  message: 'Error Creating Token',
  detail: 'Reference Already exist or invalid input'
}
```