# @zero-tech/zns-sdk

> ## Functionality Requirements

Latest version **0.10.2** (published 2023-01-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @zero-tech/zns-sdk
pnpm add @zero-tech/zns-sdk
yarn add @zero-tech/zns-sdk
bun add @zero-tech/zns-sdk
```

## Health

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

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

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.2 |
| Published | 2023-01-17 |
| First published | 2021-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 772.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | zero-tech |
| Maintainers | whytecrowe, joel_tulloch, ben.weider, zero-brett, jamesearle, will-hyde-zero, ryancrosszero |

## Links

- npm: https://www.npmjs.com/package/@zero-tech/zns-sdk
- Repository: git@github.com:zer0-os/zNS-sdk
- npm.io page: https://npm.io/package/@zero-tech/zns-sdk

## Dependencies (12)

- [lolex](https://npm.io/package/lolex.md) 6.0.0
- [dotenv](https://npm.io/package/dotenv.md) 16.0.1
- [consola](https://npm.io/package/consola.md) 2.15.3
- [env-var](https://npm.io/package/env-var.md) 7.1.1
- [graphql](https://npm.io/package/graphql.md) 15.5.3
- [cross-fetch](https://npm.io/package/cross-fetch.md) 3.1.4
- [coingecko-api](https://npm.io/package/coingecko-api.md) 1.0.10
- [@apollo/client](https://npm.io/package/@apollo/client.md) 3.4.10
- [@ethersproject/abi](https://npm.io/package/@ethersproject/abi.md) 5.4.1
- [@ethersproject/bytes](https://npm.io/package/@ethersproject/bytes.md) 5.4.0
- [@ethersproject/providers](https://npm.io/package/@ethersproject/providers.md) 5.4.5
- [@zero-tech/zero-contracts](https://npm.io/package/@zero-tech/zero-contracts.md) ^0.0.4

## Recent versions

- 0.10.2 (latest) — 2023-01-17
- 0.10.1 — 2023-01-03
- 0.10.0 — 2023-01-03
- 0.9.3 — 2022-12-29
- 0.9.2 — 2022-11-10
- 0.9.1 — 2022-11-07
- 0.9.0 — 2022-10-28
- 0.8.19 — 2022-10-25
- 0.8.18 — 2022-10-21
- 0.8.17 — 2022-10-17
- 0.8.16 — 2022-10-05
- 0.8.15 — 2022-09-02
- 0.8.14 — 2022-08-05
- 0.8.13 — 2022-07-28
- 0.8.12 — 2022-07-28
- … 104 more at https://npm.io/package/@zero-tech/zns-sdk/versions

## README

# zNS SDK

## Functionality Requirements

- [x] Convert domain name to id
- [x] Get Domain data by name
- [x] Get Domain by name
- [x] Get Domains by Owner
- [x] Get Subdomains of a domain (by Id)
- [x] Get Domain Events by id
- [x] Get zAuction Instance for Id
- [x] Get Trading Metrics for Subdomains (of a domain by Id)
- [x] Mint subdomain (of a domain you own)
- [ ] Get Token used for Staking on a domain
- [ ] Approve Staking Controller to spend Tokens
- [ ] Place a Staking Request on a domain
- [ ] View Staking Requests for a domain
- [ ] View Staking Requests for all domains owned by a user
- [ ] Approve Staking Request
- [ ] View All staking requests created by a user
- [ ] Fulfill Staking Request
- [x] Check Approval of zAuction to place bid
- [x] Approve zAuction to spend tokens
- [x] Place a Bid on a Domain
- [x] Check approval for zAuction to transfer domains
- [x] Approve zAuction to transfer Domains
- [x] Accept a Bid on a Domain
- [ ] Unlock Domain
- [ ] Lock Domain
- [ ] Set Domain Metadata
- [ ] Set Domain Royalty Amount

---
_Source: https://npm.io/package/@zero-tech/zns-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._