feat: decorate clients with actions #77

jxom · 2023-02-18T06:07:46Z

After some research, it seems like decorating clients with their respective actions won't add too much to the bundle size. For example, adding public actions onto the public client only added 4kB (gzipped) for the createPublicClient import. I think the trade-off of losing tree-shaking here is okay since we gain a massive DX improvement (no extraneous imports + autocomplete of actions on the client).

Example:

import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'
-import { getBlockNumber } from 'viem/public'

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
})

- const blockNumber = await getBlockNumber(client)
+ const blockNumber = await client.getBlockNumber()

Tree-shaking escape hatch

If a consumer wants to be pedantic about bundle size, we also provide the escape hatch for them to leverage tree-shaking (the previous approach), using the base client (the base client does not attach any actions) – will need to document this.

import { 
-createPublicClient,
+createClient, 
  http 
} from 'viem'
import { mainnet } from 'viem/chains'
import { getBlockNumber } from 'viem/public'

-const client = createPublicClient({
+const client = createClient({
  chain: mainnet,
  transport: http(),
})

const blockNumber = await getBlockNumber(client)

TODO

changeset-bot · 2023-02-18T06:07:49Z

🦋 Changeset detected

Latest commit: 91db4b7

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2023-02-18T06:07:51Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated
viem-playground	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Feb 20, 2023 at 8:03PM (UTC)
viem-site	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Feb 20, 2023 at 8:03PM (UTC)

github-actions · 2023-02-18T06:09:14Z

Size Change: +2.46 kB (+7%) 🔍

Total Size: 40.1 kB

Filename	Size	Change
`dist/chains.js`	1.3 kB	-2 B (0%)
`dist/chunk-LT3TMHSU.js`	0 B	-5.74 kB (removed)	🏆
`dist/chunk-X5J5H2UR.js`	0 B	-1.63 kB (removed)	🏆
`dist/chunk-XPJ4VYLC.js`	0 B	-21 kB (removed)	🏆
`dist/contract.js`	475 B	+18 B (+4%)
`dist/ens.js`	355 B	-1.44 kB (-80%)	🏆
`dist/index.js`	4.29 kB	+1.61 kB (+60%)	🆘
`dist/public.js`	473 B	+7 B (+2%)
`dist/test.js`	518 B	-856 B (-62%)	🏆
`dist/utils/index.js`	868 B	-1 B (0%)
`dist/wallet.js`	295 B	+1 B (0%)
`dist/chunk-5ULIWMK3.js`	1.72 kB	+1.72 kB (new file)	🆕
`dist/chunk-GFTOFJQR.js`	21 kB	+21 kB (new file)	🆕
`dist/chunk-IVWK2BXY.js`	5.75 kB	+5.75 kB (new file)	🆕
`dist/chunk-KAPCXVQA.js`	1.38 kB	+1.38 kB (new file)	🆕
`dist/chunk-YL2PFU3G.js`	1.63 kB	+1.63 kB (new file)	🆕

ℹ️ View Unchanged

Filename	Size
`dist/window.js`	67 B

_{compressed-size-action}

codecov · 2023-02-19T06:14:54Z

Codecov upload limit reached ⚠️

This org is currently on the free Basic Plan; which includes 250 free private repo uploads each rolling month. This limit has been reached and additional reports cannot be generated. For unlimited uploads, upgrade to our pro plan.

Do you have questions or need help? Connect with our sales team today at sales@codecov.io

tmm

Looks good. Few docs suggestions. Also, wired up some missing generics in 318770c

tmm · 2023-02-20T15:09:54Z

site/docs/ens/actions/getEnsAddress.md

+::: warning
+A name must be [normalized via UTS-46 normalization](https://docs.ens.domains/contract-api-reference/name-processing) before being used with `getEnsAddress`. 
+This can be achieved by using the `normalize` utility.
+:::


Suggested change

::: warning

A name must be [normalized via UTS-46 normalization](https://docs.ens.domains/contract-api-reference/name-processing) before being used with `getEnsAddress`.

This can be achieved by using the `normalize` utility.

:::

::: warning

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`.

This can be achieved by using viem's built-in [`normalize`](/docs/ens/utilities/normalize) utility.

:::

tmm · 2023-02-20T15:12:57Z

site/docs/ens/utilities/labelhash.md

+::: warning
+A label must be [normalized via UTS-46 normalization](https://docs.ens.domains/contract-api-reference/name-processing) before being hashed with labelhash. 
+This can be achieved by using the `normalize` utility.
+:::


Suggested change

::: warning

A label must be [normalized via UTS-46 normalization](https://docs.ens.domains/contract-api-reference/name-processing) before being hashed with labelhash.

This can be achieved by using the `normalize` utility.

:::

::: warning

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize labels](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `labelhash`.

This can be achieved by using viem's built-in [`normalize`](/docs/ens/utilities/normalize) utility.

:::

tmm · 2023-02-20T15:13:37Z

site/docs/ens/utilities/namehash.md

+::: warning
+A name must be [normalized via UTS-46 normalization](https://docs.ens.domains/contract-api-reference/name-processing) before being hashed with namehash. 
+This can be achieved by using the `normalize` utility.
+:::


Suggested change

::: warning

A name must be [normalized via UTS-46 normalization](https://docs.ens.domains/contract-api-reference/name-processing) before being hashed with namehash.

This can be achieved by using the `normalize` utility.

:::

::: warning

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `namehash`.

This can be achieved by using viem's built-in [`normalize`](/docs/ens/utilities/normalize) utility.

:::

tmm · 2023-02-20T15:19:51Z

src/ens.ts

 } from './utils/ens'
+
+export { normalize } from './utils/ens/normalize'


For tree shake-ability?

tmm · 2023-02-20T17:41:29Z

src/wallet.ts

+  AddChainArgs,
  FormattedTransactionRequest,
  GetPermissionsResponse,
+  GetAccountsResponse,
+  RequestAccountsResponse,


Added a few missing args/response types for consistency

Co-authored-by: awkweb <tom@meagher.co>

* feat: fall back to getLogs if filters are not supported * Update src/actions/public/watchContractEvent.test.ts Co-authored-by: awkweb <tom@meagher.co> * pr review * feat: decode event log topics & data * wip: public * wip: add ens * docs: public actions * wip: wallet actions * docs: wallet actions * wip: test actions * wip: add utils to main entrypoint * tests: add tests * playgrounds: update * chore: changeset * test * refactor: wire up decorator generics * fix conflicts * format --------- Co-authored-by: awkweb <tom@meagher.co>

* feat: add timeout as config to transport * chore: changeset * feat: decode log `topics` + `data` & infer types for logs (#75) * feat: decode event log topics & data * docs: createContractEventFilter * pr review * feat: fall back to `getLogs` if filters are not supported (#76) * feat: fall back to getLogs if filters are not supported * Update src/actions/public/watchContractEvent.test.ts Co-authored-by: awkweb <tom@meagher.co> * pr review --------- Co-authored-by: awkweb <tom@meagher.co> * feat: decorate clients with actions (#77) * feat: fall back to getLogs if filters are not supported * Update src/actions/public/watchContractEvent.test.ts Co-authored-by: awkweb <tom@meagher.co> * pr review * feat: decode event log topics & data * wip: public * wip: add ens * docs: public actions * wip: wallet actions * docs: wallet actions * wip: test actions * wip: add utils to main entrypoint * tests: add tests * playgrounds: update * chore: changeset * test * refactor: wire up decorator generics * fix conflicts * format --------- Co-authored-by: awkweb <tom@meagher.co> --------- Co-authored-by: awkweb <tom@meagher.co>

vercel bot deployed to Preview – viem-site February 19, 2023 06:10 View deployment

vercel bot deployed to Preview – viem-playground February 19, 2023 06:11 View deployment

vercel bot deployed to Preview – viem-site February 19, 2023 06:55 View deployment

vercel bot deployed to Preview – viem-playground February 19, 2023 06:55 View deployment

vercel bot deployed to Preview – viem-playground February 19, 2023 08:02 View deployment

vercel bot deployed to Preview – viem-site February 19, 2023 08:02 View deployment

vercel bot deployed to Preview – viem-site February 19, 2023 21:14 View deployment

vercel bot deployed to Preview – viem-playground February 19, 2023 21:14 View deployment

vercel bot deployed to Preview – viem-playground February 19, 2023 21:18 View deployment

vercel bot deployed to Preview – viem-site February 19, 2023 21:18 View deployment

jxom changed the title ~~wip: decorate clients with actions~~ feat: decorate clients with actions Feb 19, 2023

vercel bot deployed to Preview – viem-site February 19, 2023 23:46 View deployment

vercel bot deployed to Preview – viem-playground February 19, 2023 23:46 View deployment

vercel bot deployed to Preview – viem-site February 20, 2023 01:48 View deployment

vercel bot deployed to Preview – viem-playground February 20, 2023 01:49 View deployment

vercel bot had a problem deploying to Preview – viem-playground February 20, 2023 17:41 Failure

vercel bot deployed to Preview – viem-site February 20, 2023 17:41 View deployment

tmm approved these changes Feb 20, 2023

View reviewed changes

tmm force-pushed the jxom/actions-on-clients branch from 318770c to 074f263 Compare February 20, 2023 17:45

vercel bot deployed to Preview – viem-playground February 20, 2023 17:45 View deployment

vercel bot deployed to Preview – viem-site February 20, 2023 17:46 View deployment

feat: fall back to getLogs if filters are not supported

daee568

jxom force-pushed the jxom/watch-event-fallback branch from ca7b490 to daee568 Compare February 20, 2023 19:47

jxom and others added 2 commits February 21, 2023 06:47

Update src/actions/public/watchContractEvent.test.ts

d2c0a77

Co-authored-by: awkweb <tom@meagher.co>

pr review

b8ed6af

Base automatically changed from jxom/watch-event-fallback to main February 20, 2023 19:52

jxom and others added 15 commits February 21, 2023 06:55

feat: decode event log topics & data

a9cb3d9

wip: public

ed00841

wip: add ens

2635f11

docs: public actions

82d2331

wip: wallet actions

52a5f75

docs: wallet actions

d1f8049

wip: test actions

848826d

wip: add utils to main entrypoint

8278aa2

tests: add tests

3052269

playgrounds: update

9e87748

chore: changeset

02d0fec

test

be2d62d

refactor: wire up decorator generics

f42adc4

fix conflicts

57d5efb

format

0600343

jxom force-pushed the jxom/actions-on-clients branch from 074f263 to 0600343 Compare February 20, 2023 20:00

vercel bot deployed to Preview – viem-playground February 20, 2023 20:00 View deployment

Merge branch 'main' into jxom/actions-on-clients

91db4b7

jxom merged commit d6a29f5 into main Feb 20, 2023

jxom deleted the jxom/actions-on-clients branch February 20, 2023 20:01

github-actions bot mentioned this pull request Feb 20, 2023

Version Packages (alpha) #78

Merged

vercel bot deployed to Preview – viem-site February 20, 2023 20:02 View deployment

vercel bot deployed to Preview – viem-playground February 20, 2023 20:03 View deployment

github-actions bot mentioned this pull request Mar 6, 2023

Version Packages #123

Merged

jxom mentioned this pull request Apr 6, 2023

feat: eip-1271 #320

Merged

tmm mentioned this pull request Apr 6, 2023

feat: tree-shakeable client types #314

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: decorate clients with actions #77

feat: decorate clients with actions #77

jxom commented Feb 18, 2023 •

edited

Loading

changeset-bot bot commented Feb 18, 2023 •

edited

Loading

vercel bot commented Feb 18, 2023 •

edited

Loading

github-actions bot commented Feb 18, 2023 •

edited

Loading

codecov bot commented Feb 19, 2023 •

edited

Loading

tmm left a comment

tmm Feb 20, 2023

tmm Feb 20, 2023

tmm Feb 20, 2023

tmm Feb 20, 2023

tmm Feb 20, 2023

		} from './utils/ens'

		export { normalize } from './utils/ens/normalize'

feat: decorate clients with actions #77

feat: decorate clients with actions #77

Conversation

jxom commented Feb 18, 2023 • edited Loading

Tree-shaking escape hatch

TODO

changeset-bot bot commented Feb 18, 2023 • edited Loading

🦋 Changeset detected

vercel bot commented Feb 18, 2023 • edited Loading

github-actions bot commented Feb 18, 2023 • edited Loading

codecov bot commented Feb 19, 2023 • edited Loading

Codecov upload limit reached ⚠️

tmm left a comment

Choose a reason for hiding this comment

tmm Feb 20, 2023

Choose a reason for hiding this comment

tmm Feb 20, 2023

Choose a reason for hiding this comment

tmm Feb 20, 2023

Choose a reason for hiding this comment

tmm Feb 20, 2023

Choose a reason for hiding this comment

tmm Feb 20, 2023

Choose a reason for hiding this comment

jxom commented Feb 18, 2023 •

edited

Loading

changeset-bot bot commented Feb 18, 2023 •

edited

Loading

vercel bot commented Feb 18, 2023 •

edited

Loading

github-actions bot commented Feb 18, 2023 •

edited

Loading

codecov bot commented Feb 19, 2023 •

edited

Loading