Merge pull request #1105 from ethereum-optimism/viem-link

Replace the SDK link with viem
ethereum-optimism · Nov 15, 2024 · fba54c2 · fba54c2
2 parents 7512eb2 + fe3e7ce
commit fba54c2
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 38 deletions.
diff --git a/pages/builders/app-developers/bridging/basics.mdx b/pages/builders/app-developers/bridging/basics.mdx
@@ -28,7 +28,7 @@ All of this is easily accessible with a simple, clean API.
 Ready to start bridging?
 Check out these tutorials to get up to speed fast.
 
-*   [Learn how to bridge ERC-20 tokens with the Optimism SDK](/builders/app-developers/tutorials/cross-dom-bridge-erc20)
-*   [Learn how to bridge ETH with the Optimism SDK](/builders/app-developers/tutorials/cross-dom-bridge-eth)
+*   [Learn how to bridge ERC-20 tokens with viem](/builders/app-developers/tutorials/cross-dom-bridge-erc20)
+*   [Learn how to bridge ETH with viem](/builders/app-developers/tutorials/cross-dom-bridge-eth)
 *   [Learn how to create a standard bridged token](/builders/app-developers/tutorials/standard-bridge-standard-token)
 *   [Learn how to create a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-token)
diff --git a/pages/builders/app-developers/bridging/standard-bridge.mdx b/pages/builders/app-developers/bridging/standard-bridge.mdx
@@ -199,8 +199,8 @@ Users simply need to trigger and send ETH to the [`bridgeETH`](https://github.co
 
 ## Tutorials
 
-*   [Learn how to bridge ERC-20 tokens with the Optimism SDK](/builders/app-developers/tutorials/cross-dom-bridge-erc20)
-*   [Learn how to bridge ETH with the Optimism SDK](/builders/app-developers/tutorials/cross-dom-bridge-eth)
+*   [Learn how to bridge ERC-20 tokens with viem](/builders/app-developers/tutorials/cross-dom-bridge-erc20)
+*   [Learn how to bridge ETH with viem](/builders/app-developers/tutorials/cross-dom-bridge-eth)
 *   [Learn how to create a standard bridged token](/builders/app-developers/tutorials/standard-bridge-standard-token)
 *   [Learn how to create a custom bridged token](/builders/app-developers/tutorials/standard-bridge-custom-token)
 

diff --git a/pages/builders/app-developers/overview.mdx b/pages/builders/app-developers/overview.mdx
@@ -51,17 +51,17 @@ The Standard Token Bridge for OP Mainnet even uses this same message-passing inf
 If you're a bit more familiar with OP Mainnet and Ethereum, you can try walking through one of the tutorials put together by the Optimism community.
 They'll help you get a head start when building your first Optimistic project.
 
-| Tutorial Name                                                                                             | Description                                                                                                                               | Difficulty Level |
-| --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
-| [Deploying Your First Contract on OP Mainnet](tutorials/first-contract)                                   | Learn how to deploy your first contract to OP Mainnet with Remix and MetaMask.                                                            | 🟢 Easy          |
-| [Bridging ETH With the Optimism SDK](tutorials/cross-dom-bridge-eth)                                      | Learn how to use the Optimism SDK to transfer ETH between Layer 1 (Ethereum or Sepolia) and Layer 2 (OP Mainnet or OP Sepolia).           | 🟢 Easy          |
-| [Bridging ERC-20 Tokens With the Optimism SDK](tutorials/cross-dom-bridge-erc20)                          | Learn how to use the Optimism SDK to transfer ERC-20 tokens between Layer 1 (Ethereum or Sepolia) and Layer 2 (OP Mainnet or OP Sepolia). | 🟢 Easy          |
-| [Bridging your Standard ERC-20 token using the Standard Bridge](tutorials/standard-bridge-standard-token) | Learn how to bridge your standard ERC-20 token to layer 2 using the standard bridge.                                                      | 🟡 Medium        |
-| [Bridging your Custom ERC-20 token using the Standard Bridge](tutorials/standard-bridge-custom-token)     | Learn how to bridge your custom ERC-20 token to layer 2 using the standard bridge.                                                        | 🟡 Medium        |
-| [Tracing Deposits and Withdrawals With the Optimism SDK](tutorials/sdk-trace-txns)                        | Learn how to use the Optimism SDK to trace deposits and withdrawals.                                                                      | 🟢 Easy          |
-| [Viewing Deposits and Withdrawals by Address With the Optimism SDK](tutorials/sdk-view-txns)              | Learn how to use the Optimism SDK to view deposits and withdrawals by address.                                                            | 🟢 Easy          |
-| [Estimating Transaction Costs With the Optimism SDK](tutorials/sdk-view-txns)                             | Learn how to use the Optimism SDK to estimate the cost of a transaction on OP Mainnet.                                                    | 🟢 Easy          |
-| [Sending OP Mainnet Transactions from Ethereum](tutorials/send-tx-from-eth)                               | Learn how to send transactions to OP Mainnet from Ethereum.                                                                               | 🟢 Easy          |
+| Tutorial Name                                                                                             | Description                                                                                                                   | Difficulty Level |
+| --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------- |
+| [Deploying Your First Contract on OP Mainnet](tutorials/first-contract)                                   | Learn how to deploy your first contract to OP Mainnet with Remix and MetaMask.                                                | 🟢 Easy          |
+| [Bridging ETH With viem](tutorials/cross-dom-bridge-eth)                                                  | Learn how to use viem to transfer ETH between Layer 1 (Ethereum or Sepolia) and Layer 2 (OP Mainnet or OP Sepolia).           | 🟢 Easy          |
+| [Bridging ERC-20 Tokens With viem](tutorials/cross-dom-bridge-erc20)                                      | Learn how to use viem to transfer ERC-20 tokens between Layer 1 (Ethereum or Sepolia) and Layer 2 (OP Mainnet or OP Sepolia). | 🟢 Easy          |
+| [Bridging your Standard ERC-20 token using the Standard Bridge](tutorials/standard-bridge-standard-token) | Learn how to bridge your standard ERC-20 token to layer 2 using the standard bridge.                                          | 🟡 Medium        |
+| [Bridging your Custom ERC-20 token using the Standard Bridge](tutorials/standard-bridge-custom-token)     | Learn how to bridge your custom ERC-20 token to layer 2 using the standard bridge.                                            | 🟡 Medium        |
+| [Tracing Deposits and Withdrawals with  viem](tutorials/sdk-trace-txns)                                   | Learn how to use viem to trace deposits and withdrawals.                                                                      | 🟢 Easy          |
+| [Viewing Deposits and Withdrawals by address with viem](tutorials/sdk-view-txns)                          | Learn how to use viem to view deposits and withdrawals by address.                                                            | 🟢 Easy          |
+| [Estimating Transaction Costs With the viem](tutorials/sdk-view-txns)                                     | Learn how to use viem to estimate the cost of a transaction on OP Mainnet.                                                    | 🟢 Easy          |
+| [Sending OP Mainnet Transactions from Ethereum](tutorials/send-tx-from-eth)                               | Learn how to send transactions to OP Mainnet from Ethereum.                                                                   | 🟢 Easy          |
 
 You can also [suggest a new tutorial](https://github.com/ethereum-optimism/docs/issues/new?assignees=\&labels=tutorial%2Cdocumentation%2Ccommunity-request\&projects=\&template=suggest_tutorial.yaml\&title=%5BTUTORIAL%5D+Add+PR+title) if you have something specific in mind. We'd love to grow this list!
 

diff --git a/pages/builders/app-developers/tutorials.mdx b/pages/builders/app-developers/tutorials.mdx
@@ -8,16 +8,16 @@ import { Card, Cards } from 'nextra/components'
 
 # Tutorials
 
-This section provides information on bridging erc 20 tokens to op mainnet with the optimism sdk, bridging eth to op mainnet with the optimism sdk, communicating between op mainnet and ethereum in solidity, deploying your first contract on op mainnet, estimating transaction costs on op mainnet, tracing deposits and withdrawals, viewing deposits and withdrawals by address, triggering op mainnet transactions from ethereum, bridging your custom erc 20 token using the standard bridge and bridging your standard erc 20 token using the standard bridge. You'll find tutorial to help you understand and work with these topics.
+This section provides information on bridging erc 20 tokens to op mainnet with viem, bridging eth to op mainnet with viem, communicating between op mainnet and ethereum in solidity, deploying your first contract on op mainnet, estimating transaction costs on op mainnet, tracing deposits and withdrawals, viewing deposits and withdrawals by address, triggering op mainnet transactions from ethereum, bridging your custom erc 20 token using the standard bridge and bridging your standard erc 20 token using the standard bridge. You'll find tutorial to help you understand and work with these topics.
 
 <Cards>
-  <Card title="Bridging erc 20 tokens to op mainnet with the optimism sdk" href="/builders/app-developers/tutorials/cross-dom-bridge-erc20" />
+  <Card title="Bridging erc 20 tokens to OP Stack with viem" href="/builders/app-developers/tutorials/cross-dom-bridge-erc20" />
 
-  <Card title="Bridging eth to op mainnet with the optimism sdk" href="/builders/app-developers/tutorials/cross-dom-bridge-eth" />
+  <Card title="Bridging eth to op mainnet with viem" href="/builders/app-developers/tutorials/cross-dom-bridge-eth" />
 
-  <Card title="Communicating between op mainnet and ethereum in solidity" href="/builders/app-developers/tutorials/cross-dom-solidity" />
+  <Card title="Communicating between OP Stack and ethereum in solidity" href="/builders/app-developers/tutorials/cross-dom-solidity" />
 
-  <Card title="Estimating transaction costs on op mainnet" href="/builders/app-developers/tutorials/sdk-estimate-costs" />
+  <Card title="Estimating transaction costs on OP Stack" href="/builders/app-developers/tutorials/sdk-estimate-costs" />
 
   <Card title="Tracing deposits and withdrawals" href="/builders/app-developers/tutorials/sdk-trace-txns" />
 

diff --git a/pages/builders/app-developers/tutorials/_meta.json b/pages/builders/app-developers/tutorials/_meta.json
@@ -1,7 +1,7 @@
 {
   "cross-dom-solidity": "Communicating between chains in Solidity",
-  "cross-dom-bridge-eth": "Bridging ETH with Viem",
-  "cross-dom-bridge-erc20": "Bridging ERC-20 tokens with the Optimism SDK",
+  "cross-dom-bridge-eth": "Bridging ETH with viem",
+  "cross-dom-bridge-erc20": "Bridging ERC-20 tokens with viem",
   "standard-bridge-custom-token": "Bridging your custom ERC-20 token to OP Mainnet",
   "standard-bridge-standard-token": "Bridging your standard ERC-20 token to OP Mainnet",
   "sdk-view-txns": "Viewing deposits and withdrawals by address",

diff --git a/pages/builders/app-developers/tutorials/standard-bridge-custom-token.mdx b/pages/builders/app-developers/tutorials/standard-bridge-custom-token.mdx
@@ -114,7 +114,7 @@ _SYMBOL:      "MCL2T"
 ## Bridge some tokens
 
 Now that you have an L2 ERC-20 token, you can bridge some tokens from L1 to L2.
-Check out the tutorial on [Bridging ERC-20 tokens with the Optimism SDK](./cross-dom-bridge-erc20) to learn how to bridge your L1 ERC-20 to L2s using the Optimism SDK.
+Check out the tutorial on [Bridging ERC-20 tokens with viem](./cross-dom-bridge-erc20) to learn how to bridge your L1 ERC-20 to L2s using viem.
 Remember that the withdrawal step will *not* work for the token you just created!
 This is exactly what this tutorial was meant to demonstrate.
 

diff --git a/pages/builders/app-developers/tutorials/standard-bridge-standard-token.mdx b/pages/builders/app-developers/tutorials/standard-bridge-standard-token.mdx
@@ -96,7 +96,7 @@ The resulting L2 ERC-20 token address is printed to the console.
 ## Bridge some tokens
 
 Now that you have an L2 ERC-20 token, you can bridge some tokens from L1 to L2.
-Check out the tutorial on [Bridging ERC-20 tokens with the Optimism SDK](./cross-dom-bridge-erc20) to learn how to bridge your L1 ERC-20 to L2s using the Optimism SDK.
+Check out the tutorial on [Bridging ERC-20 tokens with viem](./cross-dom-bridge-erc20) to learn how to bridge your L1 ERC-20 to L2s using viem.
 
 ## Add to the Superchain Token List
 

diff --git a/pages/builders/chain-operators/tutorials.mdx b/pages/builders/chain-operators/tutorials.mdx
@@ -10,7 +10,7 @@ import { Card, Cards } from 'nextra/components'
 
 # Tutorials
 
-This section provides information on adding attributes to the derivation function, adding a precompile, creating your own l2 rollup testnet, integrating a new da layer with alt da, modifying predeployed contracts and using the optimism sdk. You'll find overview, tutorial, guide to help you understand and work with these topics.
+This section provides information on adding attributes to the derivation function, adding a precompile, creating your own l2 rollup testnet, integrating a new da layer with alt da, modifying predeployed contracts and using viem. You'll find overview, tutorial, guide to help you understand and work with these topics.
 
 <Cards>
   <Card title="Adding attributes to the derivation function" href="/builders/chain-operators/tutorials/adding-derivation-attributes" />
@@ -23,5 +23,5 @@ This section provides information on adding attributes to the derivation functio
 
   <Card title="Modifying predeployed contracts" href="/builders/chain-operators/tutorials/modifying-predeploys" />
 
-  <Card title="Using the optimism sdk" href="/builders/chain-operators/tutorials/sdk" />
+  <Card title="Using viem" href="/builders/chain-operators/tutorials/sdk" />
 </Cards>
diff --git a/pages/builders/tools/overview.mdx b/pages/builders/tools/overview.mdx
@@ -50,7 +50,7 @@ If you are already familiar with [building on OP Mainnet](/chain/getting-started
 
   <Card title="Superchain Bridges" href="https://app.optimism.io/bridge" icon={<img src="/img/icons/shapes.svg" />} />
 
-  <Card title="Optimism SDK" href="https://sdk.optimism.io/" icon={<img src="/img/icons/shapes.svg" />} />
+  <Card title="Viem" href="https://viem.sh/op-stack/" icon={<img src="/img/icons/shapes.svg" />} />
 
   <Card title="Superchain Faucet" href="https://console.optimism.io/faucet?utm_source=docs" icon={<img src="/img/icons/shapes.svg" />} />
 

diff --git a/pages/connect/contribute/style-guide.mdx b/pages/connect/contribute/style-guide.mdx
@@ -69,7 +69,7 @@ Write in a friendly, yet professional tone. We are upbeat, knowledgeable, and **
 
 See below for when to use title or sentence case.
 
-*   Avoid using all caps as it slows down reading comprehension. 
+*   Avoid using all caps as it slows down reading comprehension.
 
 *   Capitalize proper nouns in sentences. <br />
     **Example**: I use Visual Studio on my local machine.
@@ -320,15 +320,15 @@ Developers trust that we will lead them to sites or pages related to their readi
 
 Content types help manage technical content by defining the purpose and common structure for each file type. All content types used in these technical docs have attributes or properties, as defined below.
 
-| Document type      | Purpose                                                                                                            | Examples                                                                                                  |
-| ------------------ | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- |
-| Overviews          | General introduction to a product or feature, provides a happy-path for readers                                    | [Smart Contract Overview](/stack/smart-contracts)                                                         |
-| Guides             | Explain what things are and how they work                                                                          | [Standard Bridge Guide](/builders/app-developers/bridging/standard-bridge)                                |
-| Quick Start Guides | Briefly explain how to "minimally" get started with a product, often in 30 minutes or less                         | [Superchain App Quick Start](/builders/app-developers/quick-start)                                        |
-| Tutorials          | Provide task-oriented guidance with step-by-step "learn by doing" instructions                                     | [Bridging ERC-20 tokens with the Optimism SDK](/builders/app-developers/tutorials/cross-dom-bridge-erc20) |
-| FAQs               | Address frequently asked questions                                                                                 | [FAQ: OP Mainnet Security Model](/chain/security/faq)                                                     |
-| Troubleshooting    | List common troubleshooting scenarios and solutions                                                                | [Troubleshooting: Run a Node](/builders/node-operators/management/troubleshooting)                        |
-| Reference          | Provide deep, theoretical knowledge of the internal workings of a system, such as API endpoints and specifications | [Node and RPC Providers](/builders/tools/connect/rpc-providers)                                           |
+| Document type      | Purpose                                                                                                            | Examples                                                                                      |
+| ------------------ | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- |
+| Overviews          | General introduction to a product or feature, provides a happy-path for readers                                    | [Smart Contract Overview](/stack/smart-contracts)                                             |
+| Guides             | Explain what things are and how they work                                                                          | [Standard Bridge Guide](/builders/app-developers/bridging/standard-bridge)                    |
+| Quick Start Guides | Briefly explain how to "minimally" get started with a product, often in 30 minutes or less                         | [Superchain App Quick Start](/builders/app-developers/quick-start)                            |
+| Tutorials          | Provide task-oriented guidance with step-by-step "learn by doing" instructions                                     | [Bridging ERC-20 tokens with viem](/builders/app-developers/tutorials/cross-dom-bridge-erc20) |
+| FAQs               | Address frequently asked questions                                                                                 | [FAQ: OP Mainnet Security Model](/chain/security/faq)                                         |
+| Troubleshooting    | List common troubleshooting scenarios and solutions                                                                | [Troubleshooting: Run a Node](/builders/node-operators/management/troubleshooting)            |
+| Reference          | Provide deep, theoretical knowledge of the internal workings of a system, such as API endpoints and specifications | [Node and RPC Providers](/builders/tools/connect/rpc-providers)                               |
 
 ### Overviews
 
@@ -405,7 +405,7 @@ When writing tutorials or quick starts, steps should be written in parallel styl
 
 ### FAQs
 
-Whenever possible, we should avoid using FAQs due to their lack of readability and difficulty of maintenance. 
+Whenever possible, we should avoid using FAQs due to their lack of readability and difficulty of maintenance.
 
 FAQs address common questions developers have/might ask about a product, feature, or service. FAQs should be written from the developer's perspective. If there are more than two steps in the answer, use a numbered list. Place FAQs onto their own separate pages, whenever possible, and link to the FAQ from within the respective guide or tutorial.