From 8570315774b6f9a7b57fe7eb253fc5526ae5678a Mon Sep 17 00:00:00 2001 From: H Date: Tue, 6 Aug 2024 02:47:45 +0800 Subject: [PATCH] docs: Update tab in decodeDeployData example and add abi import (#2585) * docs: Update tab in decodeDeployData example and add abi import for other functions * Update site/pages/docs/contract/encodeFunctionResult.md * Update site/pages/docs/contract/decodeErrorResult.md --------- Co-authored-by: awkweb --- site/pages/docs/contract/decodeDeployData.md | 3 ++- site/pages/docs/contract/decodeErrorResult.md | 1 + site/pages/docs/contract/decodeEventLog.md | 1 + site/pages/docs/contract/decodeFunctionData.md | 1 + site/pages/docs/contract/decodeFunctionResult.md | 1 + site/pages/docs/contract/encodeDeployData.md | 1 + site/pages/docs/contract/encodeErrorResult.md | 1 + site/pages/docs/contract/encodeEventTopics.md | 1 + site/pages/docs/contract/encodeFunctionData.md | 1 + site/pages/docs/contract/encodeFunctionResult.md | 1 + 10 files changed, 11 insertions(+), 1 deletion(-) diff --git a/site/pages/docs/contract/decodeDeployData.md b/site/pages/docs/contract/decodeDeployData.md index e42855a3e3..90ca9f8f13 100644 --- a/site/pages/docs/contract/decodeDeployData.md +++ b/site/pages/docs/contract/decodeDeployData.md @@ -20,6 +20,7 @@ import { decodeDeployData } from 'viem' ```ts [example.ts] import { decodeDeployData } from 'viem' +import { wagmiAbi } from './abi.ts' const { args } = decodeDeployData({ abi: wagmiAbi, @@ -29,7 +30,7 @@ const { args } = decodeDeployData({ // { args: [69420n], bytecode: '0x6080604...' } ``` -```ts +```ts [abi.ts] export const wagmiAbi = [ ... { diff --git a/site/pages/docs/contract/decodeErrorResult.md b/site/pages/docs/contract/decodeErrorResult.md index 4656b8b4f0..b3a162d6f7 100644 --- a/site/pages/docs/contract/decodeErrorResult.md +++ b/site/pages/docs/contract/decodeErrorResult.md @@ -18,6 +18,7 @@ import { decodeErrorResult } from 'viem' ```ts [example.ts] import { decodeErrorResult } from 'viem' +import { wagmiAbi } from './abi.ts' const value = decodeErrorResult({ abi: wagmiAbi, diff --git a/site/pages/docs/contract/decodeEventLog.md b/site/pages/docs/contract/decodeEventLog.md index 1bf1b56660..5495a8b607 100644 --- a/site/pages/docs/contract/decodeEventLog.md +++ b/site/pages/docs/contract/decodeEventLog.md @@ -18,6 +18,7 @@ import { decodeEventLog } from 'viem' ```ts [example.ts] import { decodeEventLog } from 'viem' +import { wagmiAbi } from './abi.ts' const topics = decodeEventLog({ abi: wagmiAbi, diff --git a/site/pages/docs/contract/decodeFunctionData.md b/site/pages/docs/contract/decodeFunctionData.md index 99b8a64f8e..72f6b81b17 100644 --- a/site/pages/docs/contract/decodeFunctionData.md +++ b/site/pages/docs/contract/decodeFunctionData.md @@ -22,6 +22,7 @@ Below is a very basic example of how to decode a function to calldata. ```ts [example.ts] import { decodeFunctionData } from 'viem' +import { wagmiAbi } from './abi.ts' const { functionName } = decodeFunctionData({ abi: wagmiAbi, diff --git a/site/pages/docs/contract/decodeFunctionResult.md b/site/pages/docs/contract/decodeFunctionResult.md index cb8c36ac8c..61c43fd925 100644 --- a/site/pages/docs/contract/decodeFunctionResult.md +++ b/site/pages/docs/contract/decodeFunctionResult.md @@ -20,6 +20,7 @@ Given an ABI (`abi`) and a function (`functionName`), pass through the encoded c ```ts [example.ts] import { decodeFunctionResult } from 'viem' +import { wagmiAbi } from './abi.ts' const value = decodeFunctionResult({ abi: wagmiAbi, diff --git a/site/pages/docs/contract/encodeDeployData.md b/site/pages/docs/contract/encodeDeployData.md index 2fe880c084..a711892b6e 100644 --- a/site/pages/docs/contract/encodeDeployData.md +++ b/site/pages/docs/contract/encodeDeployData.md @@ -20,6 +20,7 @@ Below is a very basic example of how to encode deploy data. ```ts [example.ts] import { encodeDeployData } from 'viem' +import { wagmiAbi } from './abi.ts' const data = encodeDeployData({ abi: wagmiAbi, diff --git a/site/pages/docs/contract/encodeErrorResult.md b/site/pages/docs/contract/encodeErrorResult.md index 735af9d2e5..b127ae771a 100644 --- a/site/pages/docs/contract/encodeErrorResult.md +++ b/site/pages/docs/contract/encodeErrorResult.md @@ -18,6 +18,7 @@ import { encodeErrorResult } from 'viem' ```ts [example.ts] import { decodeErrorResult } from 'viem' +import { wagmiAbi } from './abi.ts' const value = encodeErrorResult({ abi: wagmiAbi, diff --git a/site/pages/docs/contract/encodeEventTopics.md b/site/pages/docs/contract/encodeEventTopics.md index ac8514eaba..a11d0f43c1 100644 --- a/site/pages/docs/contract/encodeEventTopics.md +++ b/site/pages/docs/contract/encodeEventTopics.md @@ -20,6 +20,7 @@ Below is a very basic example of how to encode event topics without arguments. ```ts [example.ts] import { encodeEventTopics } from 'viem' +import { wagmiAbi } from './abi.ts' const topics = encodeEventTopics({ abi: wagmiAbi, diff --git a/site/pages/docs/contract/encodeFunctionData.md b/site/pages/docs/contract/encodeFunctionData.md index 049512722f..14961fa40d 100644 --- a/site/pages/docs/contract/encodeFunctionData.md +++ b/site/pages/docs/contract/encodeFunctionData.md @@ -20,6 +20,7 @@ Below is a very basic example of how to encode a function to calldata. ```ts [example.ts] import { encodeFunctionData } from 'viem' +import { wagmiAbi } from './abi.ts' const data = encodeFunctionData({ abi: wagmiAbi, diff --git a/site/pages/docs/contract/encodeFunctionResult.md b/site/pages/docs/contract/encodeFunctionResult.md index cc7238186f..f33421baba 100644 --- a/site/pages/docs/contract/encodeFunctionResult.md +++ b/site/pages/docs/contract/encodeFunctionResult.md @@ -20,6 +20,7 @@ Given an ABI (`abi`) and a function (`functionName`), pass through the values (` ```ts [example.ts] import { encodeFunctionResult } from 'viem'; +import { wagmiAbi } from './abi.ts' const data = encodeFunctionResult({ abi: wagmiAbi,