# bmscis-arclib2

> Nft library for fetching algorand ASA assets.

Latest version **1.2.0** (published 2023-07-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install bmscis-arclib2
pnpm add bmscis-arclib2
yarn add bmscis-arclib2
bun add bmscis-arclib2
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2023-07-14 |
| First published | 2023-07-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 2.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | BMscis |
| Maintainers | melvinwafula |
| Keywords | algorand, asa |

## Links

- npm: https://www.npmjs.com/package/bmscis-arclib2
- Repository: https://github.com/BMscis/FetchNftLibrary
- Homepage: https://github.com/BMscis/FetchNftLibrary#readme
- Issues: https://github.com/BMscis/FetchNftLibrary/issues
- Funding: algorand:<VAR734DYY2CGCAKMHLV5A2VHB35G3YOOF6ZHTGPCPKTX5LBMAAOWAUREQ4>
- npm.io page: https://npm.io/package/bmscis-arclib2

## Dependencies (8)

- [ipfs](https://npm.io/package/ipfs.md) ^0.66.1
- [dotenv](https://npm.io/package/dotenv.md) ^16.3.1
- [algosdk](https://npm.io/package/algosdk.md) ^2.4.0
- [js-sha256](https://npm.io/package/js-sha256.md) ^0.9.0
- [underscore](https://npm.io/package/underscore.md) ^1.13.6
- [@pinata/sdk](https://npm.io/package/@pinata/sdk.md) ^2.1.0
- [multiformats](https://npm.io/package/multiformats.md) ^12.0.1
- [rollup-plugin-dts](https://npm.io/package/rollup-plugin-dts.md) ^5.3.0

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2023-07-14
- 1.1.0 — 2023-07-14

## README

# bmscis-arclib

Algorand library for processing ARC3 , AR19 and ARC69 NFTs.

## Installation

### [Node.js](https://nodejs.org/en/download/)

```
$ npm install algosdk
```

> This package provides TypeScript types, but you will need [TypeScript](https://www.typescriptlang.org/) version 4.2 or higher to use them properly.

## ES module

```javascript
import bmscisArclib from 'bmscis-arclib';
// ...
```

## Config

Config takes two values '0' for 'MainNet' and '1' for 'TestNet'

## Fetch NFT

```javascript
class NFT {
    token: Token;
    metadata: Metadata;
    urlMimeType: string;
    constructor(md: Metadata, token?: Token, urlMimeType?: string);
    static fromAssetId(activeConf: number, assetId: number): Promise<NFT>;
    static fromToken(activeConf: number, t: any): Promise<NFT>;
    valid(): boolean;
    name(): string;
    id(): number;
    mediaURL(activeConf: number, small: boolean): string;
}
```

```javascript
import bmscisArclib from 'bmscis-arclib';
const nft = await bmscisArclib.NFT.fromAssetId(0, assetID);
```

## Fetch NFD Name

Given a array of addresses, return their nft domain name if any.

```javascript
lookUpNfdName(addresses: string[]): Promise<NftDomain[]>;
```

```javascript
const domainNames = await bmscisArclib.lookUpNfdName([
  'ANYY3RNQYW7UK6RNF2BFEJLE5ZRVJJIC3VLUKTABA43RVFAZK2OYGUASRQ',
  'GIWOBE2ZR3ZO4DCMRZP3UKXC4RDAHQMWZCGGR2KAI7TTVX3G6NWCNRJWH4',
  'K7XNCBUY6PS2DLBE3E6XA7KUJX4A3GA5KXDARAB3BIQJDL7WSCPX26HAYE',
  '5KZKSGWEWL5ZYT7F24YZ5E4GLCHO2IFEFPPBLBLKS3PEFNL7WEF6TJRWIA',
  'I77X4ESBWS4SE4NW5HPFWSVJARCXL7M424JWNW2F3VFJFA7E4BAI3EKF2U',
  '4LNGXTQJV6ZORSLMHNPKU6IHTLJBVDHY6RFV5JMYLVRSGPIUE45XPYAJTE',
  '2HYTI5GAB3WAJL5MZKQYUHZHYQJBEUD54OQNFZNBCPZXFPVDZOSCGUNORU',
  'WHKQNOW2IKUJ4EPPQEOWXZ2N7SDZPLCZH2AM2GVOFI3VQETJETBQQ4PZBQ',
  '5KZKSGWEWL5ZYT7F24YZ5E4GLCHO2IFEFPPBLBLKS3PEFNL7WEF6TJRWIA',
  'B2HJI7OLWGBZ4LSTKSUR6GBHRKI3MCILQIZOX2L3YRLB74VDKW2NR2DRXE'
]);
```

## GET ASSET BALANCE

Given an array of assets, return an AlgoAccount object.

```javascript
interface AssetBalance {
  amount: number;
  assetID: number;
  isFrozen: boolean;
}

interface AlgoAccount {
  address: string;
  amount: number;
  minBalance: number;
  assets: AssetBalance[];
}
```

```javascript
const c = await bmscisArclib.algo.lookUpAccount(
  0,
  'OZUUPC2B6SKD4MHNFOHZAWOBCRGBBWH7QWZJ4GREGAM7Q43RBYNO6ILW5Q',
  [1072765924, 1034854939, 387411719]
);
```

---
_Source: https://npm.io/package/bmscis-arclib2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._