Skip to content

Commit 13cfd53

Browse files
committed
test: new ur
1 parent 7f83628 commit 13cfd53

948 files changed

Lines changed: 55073 additions & 9 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.yalc/@ensdomains/ensjs/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 ENS Labs Limited
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

.yalc/@ensdomains/ensjs/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# ![ENSjs](https://user-images.githubusercontent.com/11844316/161689061-98ea01ee-b119-40ac-a512-5370eb8b4107.svg)
2+
3+
The ultimate ENS javascript library, with [viem](https://github.com/wagmi-dev/viem) under the hood.
4+
5+
## Features
6+
7+
- Super fast response times
8+
- Easy call batchability
9+
- Written in TypeScript
10+
- Supports the most cutting edge ENS features
11+
- Full tree-shaking support
12+
13+
## Installation
14+
15+
Install @ensdomains/ensjs, alongside [viem](https://github.com/wagmi-dev/viem).
16+
17+
```sh
18+
npm install @ensdomains/ensjs viem
19+
```
20+
21+
## Getting Started
22+
23+
The most simple way to get started is to create a public ENS client, with a supported
24+
chain and transport imported from viem. The public client has all the read functions available on it,
25+
as well as all subgraph functions.
26+
27+
```ts
28+
// Import viem transport, viem chain, and ENSjs
29+
import { http } from 'viem'
30+
import { mainnet } from 'viem/chains'
31+
import { createEnsPublicClient } from '@ensdomains/ensjs'
32+
33+
// Create the client
34+
const client = createEnsPublicClient({
35+
chain: mainnet,
36+
transport: http(),
37+
})
38+
39+
// Use the client
40+
const ethAddress = client.getAddressRecord({ name: 'ens.eth' })
41+
```
42+
43+
## Docs
44+
45+
Docs can be found [here](https://github.com/ensdomains/ensjs-v3/tree/main/docs). Full docs site coming soon.

0 commit comments

Comments
 (0)