Skip to content
This repository has been archived by the owner on Jul 12, 2024. It is now read-only.

Commit

Permalink
Begin writing readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jefflau committed Sep 28, 2020
1 parent f776d46 commit e1d26ff
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 3 deletions.
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,44 @@
# ENS.js V2

Todo
## Overview of the API

### Setup

```
import ENS, { getEnsAddress } from '@ensdomains/ensjs2'
const ens = new ENS({ provider, ensAddress: getEnsAddress('1') })
ens.name('resolver.eth').getAddress() // 0x123
```

### exports

```
default - ENS
getEnsAddress
getResolverContract
getENSContract
namehash
labelhash
```

### ENS Interface

```
name(name: String) => Name
```

```
resolver(address: String)
```

```
async getName(address: String) => String
```

```
async setReverseRecord(name: String) => EthersTxObject
```
21 changes: 19 additions & 2 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ let registries = {
5: '0x112234455c3a32fd11230c42e7bccd4a84e02010',
}

function getEnsAddress(networkId) {
return registries[networkId]
}

function getResolverContract({ address, provider }) {
return new ethers.Contract(address, resolverContract, provider)
}
Expand Down Expand Up @@ -256,6 +260,13 @@ class Name {
}

async setAddress(key, address) {
if (!key) {
throw new Error('No coinId provided')
}

if (!address) {
throw new Error('No address provided')
}
const resolverAddr = await getResolverAddr()
return setAddrWithResolver({
name: this.name,
Expand Down Expand Up @@ -385,9 +396,15 @@ export default class ENS {
console.log(`Error getting name for reverse record of ${address}`, e)
}
}
setReverseRecord() {
setReverseRecord(name) {
//TODO
}
}

export { namehash, labelhash, getENSContract, getResolverContract }
export {
namehash,
labelhash,
getENSContract,
getResolverContract,
getEnsAddress,
}

0 comments on commit e1d26ff

Please sign in to comment.