Giter VIP home page Giter VIP logo

web's Introduction

Base

Base Web

Base is a secure, low-cost, developer-friendly Ethereum L2 built to bring the next billion users onchain. It's built on Optimism’s open-source OP Stack.

GitHub contributors GitHub commit activity GitHub Stars GitHub repo size GitHub

Website base.org Blog Docs Discord Twitter Base

GitHub pull requests by-label GitHub Issues

Setup

  1. Ensure nvm is installed.
  2. Clone the repository.
  3. If nvm doesn't auto-load the Node.js environment when changing to the repo directory, run nvm use.
  4. Enable Yarn by running corepack enable.

Getting started

After cloning the repository begin by installing dependencies at the root.

yarn
yarn build

Local development

To start a development server on localhost, run yarn workspace @app/<project> dev.

For example, to start the web app locally, you would run yarn workspace @app/web dev.

Projects

There are three projects which can be run individually.

Web

yarn workspace @app/web dev

Docs

yarn workspace @app/base-docs dev

Bridge

yarn workspace @app/bridge dev

Contribution

We welcome contributions to Base! To contribute, please see CONTRIBUTING.md.

web's People

Contributors

brendan-defi avatar briandoyle81cb avatar carlaiau avatar chrischang avatar crypto-jones avatar danyalprout avatar hughescoin avatar ilikesymmetry avatar jacob-moore-cb avatar jennyg0 avatar jfrankfurt avatar joalavedra avatar katsnow08 avatar kirkas avatar latechwriter avatar lucacurrancb avatar lukasrosario avatar mbeutt-cb avatar mdehoog avatar neodaoist avatar omahs avatar omkarb avatar rcbgr avatar renierc avatar ricardomogg avatar rohit-710 avatar taycaldwell avatar twynne20 avatar wbnns avatar zencephalon avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

web's Issues

Bug: Invalid links for 3 Base apps

Describe the bug

The following Base applications from the Ecosystem page do not load: Seamless, Showtime, Base Treasure Hunt

Steps

  1. Go to https://base.org/ecosystem
  2. Search for application by name
  3. Click link

Expected behavior

The links should take the user to the respective Base application.

Additional info

No response

Environment

No response

Docs Request: Fix Relative URL Path Resolution in Production Environment in Linked Minting Frame

What is the issue you are encountering with the docs?

In the production environment of the documentation site (https://docs.base.org/), relative links that are supposed to navigate within the guides section are incorrectly appending to the current path instead of navigating relative to the current directory level. This behavior is inconsistent with the local development environment, where the same relative links function correctly.

For example, a link defined as [advanced behavior]: ./advanced-frame-behavior in the markdown files correctly resolves to http://localhost:3000/building-with-base/guides/advanced-frame-behavior locally, but leads to an incorrect URL https://docs.base.org/building-with-base/guides/linked-minting-frame/advanced-frame-behavior in production, creating a 404 error since the page does not exist at the nested path.

Links to Impacted Docs

Describe the solution you'd like to see.

I would like the relative links in the documentation to resolve consistently between the local development environment and the production environment. This may involve ensuring that the documentation site's URL routing and base paths are correctly configured to interpret relative paths correctly. Alternatively, converting relative paths to root-relative paths (starting with /) might be a solution to ensure consistent behavior across environments.

Additional context

This issue leads to a poorer user experience, as readers encounter 404 errors when attempting to navigate the documentation. It could be beneficial to review the site's routing configurations or the static site generator's settings to identify and rectify the discrepancy between local and production URL resolutions.
image

[Onchain Squad] Add missing tooling and / or libraries

Context

Developers can use a variety of different tooling and libraries when building their onchain apps on Base. Although we try to list and cover as many as we can within our Developer Docs, we might have missed some along the way!

Ask

Identify popular developer tooling for building onchain apps (dapps) that are compatible with Base, but missing or not listed within our documentation, and add it to the appropriate section / category.

Source code for the Base Developer Docs site can be found under /apps/base-docs. The documentation site is built using Docusaurus.

Determine where categories like "NFT Minting" and/or "NFT Checkouts" should fit within docs

Describe the bug

I created a PR that added an NFT Checkout section over 6 months ago. This is missing from the docs. I also created a doc page for NFT Minting which is also missing from the doc. It seems like these two pages have been removed for some reason.

Steps

Two of the below PRs have been removed after they were merged:

  1. #471 - fully removed
  2. #235 - nft-checkout.md was removed from this PR.

The old links were:
https://docs.base.org/docs/tools/nft-checkout/#crossmint
https://docs.base.org/docs/tools/nft-minting/#crossmint

Can someone please address this issue? It would be helpful to understand why these two pages were removed and how can I add it back.

Expected behavior

The links should open the respective doc pages mentioned above.

Additional info

I work as a DevRel Engineer for Crossmint. These PRs were created after getting approval from the Base team so we could reference our product offering on Base's documentation.

Environment

No response

Docs Request: Fix typo in Smart Contract Development Overview

What is the issue you are encountering with the docs?

There's a sentence on page

- Describe constraints related to assignment of structs depending on the types the contain
that's missing a character:

Describe constraints related to assignment of structs depending on the types the contain

instead of

Describe constraints related to assignment of structs depending on the types they contain

on line 65

Links to Impacted Docs

https://docs.base.org/base-camp/docs/introduction-to-solidity/introduction-to-solidity-overview/#objectives

Describe the solution you'd like to see.

Add the missing "y" letter: "they contain" instead of "the contain"

Additional context

No response

Docs Request: HOW TO DEPLOY SMART CONTRACT ON BASE (Newbie guide)

What is the issue you are encountering with the docs?

I have been trying to deploy smart contact on base but I haven’t seen a guild on how to do

Links to Impacted Docs

No response

Describe the solution you'd like to see.

I would appreciate if I guide is given as a reply to this issue

Additional context

No response

Docs Request: ERC721 Exercise suggestion

What is the issue you are encountering with the docs?

NFT exercise is great but it seems closer to standard solidity exercise vs showcasing NFTs.

Links to Impacted Docs

https://docs.base.org/base-camp/docs/erc-721-token/erc-721-exercise

Describe the solution you'd like to see.

One idea can be to slightly modify the exercise so that it becomes more end-to-end and the final version can be viewed in Opensea - for example asking to implement tokenUri that returns NFT metadata and renders haiku lines as SVG.

Additional context

No response

Is the bridge part reusable in another existing op stack instance?

What is the issue you are encountering with the docs?

Is the bridge part dedicated for base's own usage, or it can also support another existing op stack instance?

Links to Impacted Docs

No response

Describe the solution you'd like to see.

If the bridge is also supposed to be reusable in another existing op stack instance(which would be very helpful), I'd like to see the detailed documents.

Additional context

No response

[Onchain Squad] Create a new developer guide around building on Base

Context

We're continually adding new developer guides and tutorials to the Base Developer Docs for developers to learn new concepts and tooling when building on Base.

Ask

Write a new guide around building onchain apps (dapps) on Base using your favorite tooling, or take one of the existing guides and improve the existing content to make it more digestible and easier to learn!

Source code for the Base Developer Docs site can be found under /apps/base-docs. The documentation site is built using Docusaurus.

Feature Request: Localization of main website of Base

Is your feature request related to a problem? Please describe.

Currently if any developer or users came to Base website who doesn't have English as an Native language faces difficulty to explore the Website

Describe the solution you'd like

I would do the multiLingual Localization or make a button where will be more languages than just english which will help other users to explore the website or Docs. This is done by lot of web3 orgs. this can be done by using i18n

Describe alternatives you've considered

No response

Additional context

I have already done it for push protocol (https://push.org/) and got some bounty price. I would like to add this feature on Base too. so let's have a conversation on it

Docs Request: Correction Needed for Complex Onchain NFTs Guide Link in Minting an NFT in a Frame Guide

What is the issue you are encountering with the docs?

Issue Description:
The link to the Complex Onchain NFTs guide in the documentation contains a typo that could lead to confusion and hinder users from accessing the correct resource. The current link is duplicated with an extra "https://" prefix, making it non-functional.

Current Incorrect Link:
https://https://docs.base.org/building-with-base/guides/complex-onchain-nfts

Expected Correct Link:
https://docs.base.org/building-with-base/guides/complex-onchain-nfts

Links to Impacted Docs

nft-minting-frame.md

Describe the solution you'd like to see.

Please correct the URL by removing the redundant "https://" prefix to ensure the link directs users to the intended guide without errors. This will improve the documentation's usability and accessibility, allowing developers to more easily find and utilize the Complex Onchain NFTs guide.

Additional context

No response

Docs Request: Foundry deploy tutorial

What is the issue you are encountering with the docs?

No tutorial coverage for deploying to Base using Foundry

Links to Impacted Docs

https://docs.base.org/guides/deploy-smart-contracts

Describe the solution you'd like to see.

What — Beginner tutorial that describes how to deploy a contract to Base with Foundry (using forge and cast).

Why — Foundry is an industry standard for modern smart contract programming. It's important to have Foundry educational material in the Base docs to contribute to the mission of onboarding more developers to the Base ecosystem.

Additional context

No response

Bug: No jobs available on Jobs page

Describe the bug

The jobs page is empty even though jobs are available

Steps

  1. Go to https://www.base.org/
  2. Press About > Jobs
  3. The page is empty with no jobs available, even though there are jobs available
  4. Refresh the page
  5. Jobs are available

Expected behavior

The jobs page should load jobs if available

Additional info

Navigating to jobs page:

Screen Shot 2024-04-20 at 2 41 38 PM

After refresh:
Screen Shot 2024-04-20 at 2 41 44 PM

Environment

Chrome

Feature Request: Update Cafe to use usePrepareContractWrite

Is your feature request related to a problem? Please describe.

The current usage of wagmi doesn't capture the error and doesn't trigger an error until after the user submits.

Describe the solution you'd like

The newer versions of wagmi now output readable errors, we should use that.

Describe alternatives you've considered

No response

Additional context

No response

Docs Request: Unit Testing Module

What is the issue you are encountering with the docs?

We need a module just for understanding the testing suite, code formatting/following a style guide for writing functions. I've got a good handle on many concepts, but the way tests are expecting exact lettering for functions is holding me back from getting those NFT stickers.

Information that's missing:

  • How to find the Unit Tests
  • FAQ answer to common error "Something is wrong with the contract at the address you are trying to submit"
    "It is likely that your function signatures do not match what is expected." which has been asked over 10 times in the Base Discord

Describe the solution you'd like to see.

Modifying the order of information for a better workflow for participants

|- Introduction to Ethereum
|- Smart Contract Development
|-- Git, VS Code, Hardhat or Foundry Setup
|-- Unit Testing
|--- Basic Math

Feature Request: Imports article needs relative imports

Is your feature request related to a problem? Please describe.

No response

Describe the solution you'd like

Explain and demo import "./myfile.sol";

Describe alternatives you've considered

No response

Additional context

No response

Bug: AI chatbot blocks navigation on mobile

Describe the bug

AI chatbot widget blocks the "Next" link.

Steps

  1. Go to https://docs.base.org/
  2. Scroll to the bottom of the page
  3. Try to click the "Next" link
  4. Link is unclickable due to the AI chatbot widget

Expected behavior

The "Next" link is clickable

Additional info

image

Environment

  • OS: Android
  • Browser: Firefox
  • Device: Pixel 7a

[Onchain Squad] Docs Request: Contract to Contract Exercise

What is the issue you are encountering with the docs?

This is a very advanced issue. Please do not start without first discussing with @briandoyle81CB! Tag me here if you are interested, and we can discuss on Discord

The Contract to Contract lessons are missing an exercise with a smart contract graded unit test awarding an NFT. This exercise should match the others in terms of scope and complexity, and require the learner to demonstrate mastery of the learning objectives for this section.

It should inherit from the Cafe smart contract and contain tests written in the same format as the others.

Links to Impacted Docs

https://docs.base.org/base-camp/docs/interfaces/contract-to-contract-interaction

Describe the solution you'd like to see.

A focused exercise testing against the learning objectives for this section.

Additional context

Example of a unit test: https://sepolia.basescan.org/address/0x15534ed3d1dba55148695b2ba4164f147e47a10c#code#F18#L1

[Onchain Squad] Address any bugs / typos within the Base Developer Docs

Context

We're constantly updating the Base Developer Docs with new content for Base developers, and there may be some bugs or typos.

Ask

Read through the Base Developer Documentation, and if you come across any bugs, typos, mistakes, broken links, etc. please create a pull request (PR) with a fix.

Source code for the Base Developer Docs site can be found under /apps/base-docs. The documentation site is built using Docusaurus.

Docs Request: Incorrect Issue Links in CONTRIBUTING.md for Suggesting Enhancements Section

What is the issue you are encountering with the docs?

In the "Suggesting Enhancements" section of the CONTRIBUTING.md file, the links provided for checking existing issues and creating new issues point to the wrong repository. They direct users to https://github.com/base-org/base/issues and https://github.com/base-org/base/issues/new instead of the correct links for the Base repository, which should be https://github.com/base-org/web/issues and https://github.com/base-org/web/issues/new, respectively. This inconsistency could lead contributors to the wrong repository, potentially causing confusion and misdirecting contributions.

Links to Impacted Docs

CONTRIBUTING.md

Describe the solution you'd like to see.

To rectify this discrepancy and ensure contributors are directed to the appropriate repository for their contributions, the links should be updated to the correct paths:

  • For checking existing enhancements, the link should be updated to: https://github.com/base-org/web/issues
  • For creating a new enhancement issue, the link should be updated to: https://github.com/base-org/web/issues/new

These updates will ensure that the contribution process is streamlined and contributors are guided to the correct repository for their issues and enhancements related to Base.

Additional context

No response

Docs Request: Balance between too much info, and arbitrary ordering of structs breaking erc-20

What is the issue you are encountering with the docs?

typeof.eth — 04/05/2024 8:49 PM
Minor feedback: one of my mentees was having trouble with the ERC20 exercise due to one of her function signatures being off due to the Issue struct.

IMO, explaining how function selectors work and how structs are really just tuples is probably not worth it for new peeps, so I wonder if it would help to provide the expected struct upfront rather than describe the structs and assume they’ll be defined in the order that they’re described.

Because the unit tests expect a specific ABI, I’d probably choose to provide the whole interface that has the methods and structs that the tests expect, but idk, that might be giving away too much.

Links to Impacted Docs

https://docs.base.org/base-camp/docs/erc-20-token/erc-20-exercise/

Describe the solution you'd like to see.

Brian needs to find a better balance here

Additional context

No response

Use @eth-optimism/tokenlist for asset list

Is your feature request related to a problem? Please describe.

You described that you are using the token list from @eth-optimism/tokenlist in your docs

Follow the instructions in the [GitHub repository](https://github.com/ethereum-optimism/ethereum-optimism.github.io) and submit a PR containing the required details for your token. You must specify in your token's data.json file a section for ‘base-goerli’ and/or ‘base’ . The change you need to submit is particularly simple if your token has already been added to the Optimism token list. For example, [this PR](https://github.com/ethereum-optimism/ethereum-optimism.github.io/commit/27ab9b2d3388f7feba3a152e0a0748c73d732a68) shows the change required for cbETH, which was already on Optimism's token list and relies on the Base standard bridge.

However, you have just dedicated assets.ts and no clue how to add a token to them.

Describe the solution you'd like

Please update it manually or change to automatically usage the token list from the optimism repo.

Describe alternatives you've considered

No response

Additional context

No response

Unreviewed commit on master!

Unreviewed commit(s) COMPARE was merged to master by zencephalon.

Comment with appropriate number of 👍 to approve.


Reviewed requirements satisfied? No
Ancestors reviewed? Yes

Docs Request: Error in Error Triage Exercise exemplar comments

What is the issue you are encountering with the docs?

The popWithReturn description incorrectly states it should return the array. It should NOT return the array

Links to Impacted Docs

https://docs.base.org/base-camp/docs/error-triage/error-triage-exercise/

Describe the solution you'd like to see.

Update the comment to read:

/**
 * Pop the last element from the supplied array, and return the popped
 * value (unlike the built-in function)
 */

Additional context

No response

Bug: Broken links in Base Camp Progress

Describe the bug

The Base Camp Progress exercises link to 404 pages

Steps

  1. Go to https://docs.base.org/base-camp/progress/
  2. Click on any of the exercises
  3. Observe the 404 at URL https://docs.base.org/base-camp/progress/docs/control-structures/control-structures-exercise

Expected behavior

Each exercise link should not contain /progress subdirectory, ie:

Additional info

Screenshot 2023-12-09 at 9 36 31 AM

Environment

  • OS: macOS 14.1.1
  • Browser: Brave
  • Wallet: MetaMask

Docs Request: Create Contract to Contract Interactions Exercise/Videos and Move to Smart Contract Development Section

What is the issue you are encountering with the docs?

Contract to Contract Interactions is currently housed in the hardhat section. This feels like a critical section that should be moved to the smart contract development section and given an exercise/video explanations.

Links to Impacted Docs

https://docs.base.org/base-camp/docs/interfaces/contract-to-contract-interaction

Describe the solution you'd like to see.

Create a Contract to Contract Interaction exercise and move it to the smart contract development section.

Additional context

No response

[Onchain Squad] Docs Request: Update Verification with Hardhat

What is the issue you are encountering with the docs?

Etherscan Verify has been deprecated, so the existing method of verification no longer works.

It should still be possible to verify multiple contracts with a single command without having to manually enter addresses, constructor arguments, etc., but I can't find documentation or answers on how.

Links to Impacted Docs

https://docs.base.org/base-camp/docs/hardhat-verify/hardhat-verify-sbs

Describe the solution you'd like to see.

Update the above article to use the new, built-in method. Ideally, this should be done via a single command that can "automatically" verify all the contracts in the deployment folder.

Additional context

No response

Bug:

Describe the bug

the site takes a lot of time to load and respond, makes it looks so buggy and laggy

Steps

go to the web

Expected behavior

the website should respond very fast.

Additional info

No response

Environment

No response

Bug: Tutorial Pages render TOC below the content on 14" MBP screen

Describe the bug

Tutorial Pages render TOC below the content on 14" MBP screen

Steps

  1. Go to https://docs.base.org/tutorials/deploy-with-fleek with a wide monitor
  2. Reduce the width
  3. Observe that the TOC remains on the right side of the screen
  4. Open https://docs.base.org/tutorials/deploy-with-fleek on the screen of a 14" MBP
  5. Observe that the TOC is rendered on the bottom
  6. On a 14" MBP, open a Base Learn page, such as https://docs.base.org/base-learn/docs/hardhat-deploy/hardhat-deploy-sbs/
  7. Observe that the TOC renders correctly on the side

Expected behavior

Breakpoints for Tutorials should match those for Learn content

Additional info

No response

Environment

14" MBP with Sonoma

Support bridging custom tokens by contract addresses

Is your feature request related to a problem? Please describe.

No response

Describe the solution you'd like

Since you are not bulk-whitelisting tokens from the unified token list, the bridge page should allow bridging custom tokens by entering their addresses. Optimism bridge does this.

Projects are being forced to deploy their forked bridge UI or use 3rd party bridges.

image

Describe alternatives you've considered

No response

Additional context

No response

Bug: Code boxes are not using correct monospace font

Describe the bug

Code boxes are not using correct monospace font

Steps

It's easies to see on pages that have a text table in a code box: https://docs.base.org/hardhat-tools-and-testing/hardhat-profiling-gas/

Here, the lack of monospace font breaks the table formatting because periods and dashes take up vastly different widths.

It's present in all code boxes, which makes them look subtly sloppy.

Expected behavior

Code boxes should use Coinbase Sans monospace

Additional info

No response

Environment

No response

Docs Request: Update web3.js v4 link and import

What is the issue you are encountering with the docs?

web3.js v4 was launched a few months ago, we plan to stop supporting v1.x in a few months.
To follow the best practices, it's recommended to switch to version 4 and update all the docs, thank u!

Links to Impacted Docs

No response

Describe the solution you'd like to see.

update the link to point to web3js.org (v4) and update the import with the curly brackets

Additional context

No response

Docs Request: Deprecation Warning and Syntax Recommendation for npx hardhat and .env File Usage in Documentation

What is the issue you are encountering with the docs?

Deprecated Usage of npx hardhat for Project Initialization
In the current documentation under the section "Creating a project," the guide suggests initializing a new Hardhat project with the command npx hardhat. However, upon executing this command, Hardhat displays a deprecation warning advising the use of npx hardhat init instead for project initialization. Continuing to use the deprecated method could lead users to rely on outdated practices, potentially leading to compatibility issues with future versions of Hardhat.

Syntax Recommendation for .env File
Additionally, in the section discussing the creation of a .env file for storing sensitive information such as WALLET_KEY, the current recommendation is to format it as:
WALLET_KEY=<YOUR_PRIVATE_KEY>
Given that the value for WALLET_KEY is consumed as a string in the configuration file (accounts: [process.env.WALLET_KEY as string]), it's advisable to include the private key within quotes to ensure correct parsing as a string, especially in scenarios where the environment variable parsing mechanism might interpret certain characters in a way that could lead to errors or unexpected behavior.

Links to Impacted Docs

deploy-smart-contracts.mdx

Describe the solution you'd like to see.

Update Project Initialization Instructions
To align with current best practices and Hardhat recommendations, the documentation should be updated to instruct users to initialize new Hardhat projects using npx hardhat init. This change will help avoid confusion and ensure users are following the recommended approach for project setup

Update .env File Syntax Recommendation
To ensure clarity and correct handling of environment variables, it's recommended to update the guide to suggest enclosing the private key value in quotes:
WALLET_KEY="<YOUR_PRIVATE_KEY>"
This minor adjustment will help prevent potential issues with environment variable parsing and make the documentation more robust and error-proof for new developers following the guide to set up their development environment.

Additional context

No response

Docs Request: Imports exercise is unclear for return of shruggie haiku

What is the issue you are encountering with the docs?

Shruggie Haiku
shruggieHaiku should use the library to add 🤷 to the end of line3. It must not modify the original haiku.

It's unclear what the return of this function should be

Links to Impacted Docs

https://docs.base.org/base-camp/docs/imports/imports-exercise#shruggie-haiku

Describe the solution you'd like to see.

The above should specify that the function shruggieHaiku should return a Haiku

Additional context

No response

Docs Request: Improve user guidance for Base Camp Invalid chain ID error

What is the issue you are encountering with the docs?

The error message displayed when connecting to the wrong network while tracking progress with Base Camp is not clear and informative enough. The current error message does not provide sufficient guidance to the user on how to resolve the issue.

Links to Impacted Docs

https://github.com/base-org/web/blob/master/apps/base-docs/src/utils/nft-exercise-data.js

Describe the solution you'd like to see.

To improve the user experience, I suggest updating the error message to clearly communicate the following:

  • The user is connected to an unsupported network.
  • The specific chain ID of the unsupported network.
  • The need to switch to the Base Sepolia network to proceed.

Proposed error message:
"Invalid network detected (Chain ID: <chain_id>). Connect using the Base Sepolia network."

The updated error message should be concise and actionable, guiding the user to take the necessary steps to resolve the issue.

Additional context

  • Currently working on a future fix that utilizes the useSwitchNetwork hook from the wagmi library. This fix aims to handle the network switching process more seamlessly and improve the overall user experience.
  • The useSwitchNetwork hook allows us to programmatically switch the user's network to Base Sepolia when an unsupported network is detected. This will streamline the process and reduce friction for the user.
  • For the current release, I recommend focusing on improving the error message to provide clear guidance to the user on how to manually switch to the Base Sepolia network. Will continue to work on the useSwitchNetwork implementation and include it in a future update to further enhance the user experience.

Docs Request: [Test] Demonstrating how to open an issue

What is the issue you are encountering with the docs?

Insert text with a concise description of the above.

Links to Impacted Docs

...

Describe the solution you'd like to see.

Be specific.

Additional context

No response

Docs Request: Click to reveal code snippets

What is the issue you are encountering with the docs?

Suggesting a modification to the lesson structure. Instead of immediately showing the expected result after instructing people to code something on their own, I propose making some of the code blocks "click to reveal." This means learners would have the option to see the solution only when they choose to, creating a more engaging and interactive learning experience.

Describe the solution you'd like to see.

There are a lot of different ways to do this but a simple solution would be a collapsible section written in markdown.

https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections#creating-a-collapsed-section

Docs Request: TOML Parse Error in Tutorial for Using Pyth Price Feeds

What is the issue you are encountering with the docs?

Problem:
While following the tutorial on using Pyth Price Feeds on the Base testnet, I encountered a TOML parse error during the setup process described in the "Installing Pyth smart contracts" section. The error occurred when updating the foundry.toml file with the provided remappings line for Pyth SDK Solidity:
remappings = ['@pythnetwork/pyth-sdk-solidity/=lib/pyth-sdk-solidity’]

The error message was:

Error: 
failed to extract foundry config:
foundry.toml error: TOML parse error at line 5, column 71
  |
5 | remappings = ['@pythnetwork/pyth-sdk-solidity/=lib/pyth-sdk-solidity’]
  |                                                                       ^
invalid literal string
 in foundry.toml TOML file

This appears to be caused by mismatched quotation marks in the remappings line provided in the tutorial.

Links to Impacted Docs

using-pyth-price-feeds.md

Describe the solution you'd like to see.

To prevent this error for others following the tutorial, the documentation should be updated to ensure that the quotation marks used in the foundry.toml code snippet are consistent. The corrected line should use matching single quotes (') or double quotes (") around the remapping path:
remappings = ['@pythnetwork/pyth-sdk-solidity/=lib/pyth-sdk-solidity']

This minor correction will help future readers smoothly follow the tutorial without encountering parse errors in their foundry.toml configuration.

Additional context

No response

Support for Sepolia testnet in the toolchains guide

We need to introduce support for the Sepolia testnet in our documentation. As Sepolia is now recommended for smart contract development, and with Goerli having been deprecated in Q1 2023 with support ending in Q4 2023, it's important we make this update where Goerli occurs.

I've updated the toolchains guide for Hardhat and submitted a PR to include the Sepolia network settings with the appropriate endpoints on base, but I'll take a look at other parts of the documentation (the Foundry section could be a bit more robust).

It's probably a smart idea to retain Goerli for the time being too, with the plan of phasing its documentation out gradually.

Bug: Stuck on base bridge

Describe the bug

After bridging token is not arriving on base

Steps

  1. Go to base bridge contract ( https://etherscan.io/address/0x3154cf16ccdb4c6d922629664174b904d80f2c35#writeProxyContract#F2)

  2. try to bridge token
    3)Token doesn’t arrive on base network

  3. Relay message fails on base network

Expected behavior

Expected if token is not available on base to either mint a custom token or to revert the token back to main net or to allow to bridge back

Additional info

I have send a bridge from ethereum main net to base chain using the contract bridgeerc20to, however when it arrived on base it shows FailedRelayedMessage but does not proceed further. Now I have a stuck bridge and I’m unable to go forward and unable to revert. What is the handling for this error? I see previously if the message failed it gets reverted back to main net

https://etherscan.io/tx/0x14c77dc75bf19e5eba3c6c5a853ad34430368f0746b4589d3ebfbbc57b8147b7

https://basescan.org/tx/0x3e2ec42e03d20aa8c3c06a38f1b55a502078dcaa80e5113936387eab47c90f28#eventlog

Environment

No response

Docs Request: Add initial Base Sepolia node providers; Fix URL typo

What is the issue you are encountering with the docs?

  • Noticed that 2 node providers now support Base Sepolia (GetBlock, QuickNode)
  • Noticed that the Chainstack URL was incorrectly linking to GetBlock

Links to Impacted Docs

https://docs.base.org/tools/node-providers/

Describe the solution you'd like to see.

  • Add Base Sepolia (testnet) support to these 2 node providers
  • Fix Chainstack URL typo

Additional context

I'm not sure that no other listed node providers support Base Sepolia yet, but these two I was able to confirm on an initial pass

[Onchain Squad] Address any bugs / typos within Base Camp

Context

We have our own educational curriculum for becoming a full-fledge blockchain dev and Base builder known as Base Camp!

Ask

Read through the Base Camp content, and if you come across any bugs, typos, mistakes, broken links, etc. please create a pull request (PR) with a fix. (We'll also consider general improvements to the content itself.)

Source code for the Base Camp can be found under /apps/base-docs/base-camp. The site is built alongside the developer documentation and uses Docusaurus.

[Onchain Squad] Docs Request: Add Keywords to Frontmatter for All Base Camp Docs

What is the issue you are encountering with the docs?

The Base Camp docs are missing the keywords section in the frontmatter. This section helps search engines find the content.

This should be added one folder at a time!

Links to Impacted Docs

https://raw.githubusercontent.com/base-org/web/master/apps/base-docs/base-camp/docs/contracts-and-basic-functions/hello-world-step-by-step.md

And every other doc under /base-camp/

Describe the solution you'd like to see.

Add a keywords section with appropriate keywords.

Example: https://raw.githubusercontent.com/base-org/web/master/apps/base-docs/docs/building-with-base/guides/account-abstraction-with-biconomy.md

Additional context

IMPORTANT: Please check for PRs before making one for a given doc. A PR should only contain updates for the files in a single folder of content.

We don't want to have several people trying to do all of them all at once, resulting in wasted effort!

Bug: Path collision when cloning repository

Describe the bug

When cloning this repository there is a warning displaying that multiple paths have collided

Steps

  1. Clone repository
  2. See error:
warning: the following paths have collided (e.g. case-sensitive paths
on a case-insensitive filesystem) and only one from the same
colliding group is in the working tree:

  'apps/web/public/images/partners/Blocknative.png'
  'apps/web/public/images/partners/blocknative.png'
  'apps/web/public/images/partners/Bonfire.png'
  'apps/web/public/images/partners/bonfire.png'
  'apps/web/public/images/partners/Sablier.png'
  'apps/web/public/images/partners/sablier.png'
  'apps/web/public/images/partners/Truflation.png'
  'apps/web/public/images/partners/truflation.png'

Expected behavior

The repository should clone without warnings.

Additional info

No response

Environment

MacOS Ventura 13.6

Unreviewed commit on master!

Unreviewed commit(s) COMPARE was merged to master by zencephalon.

Comment with appropriate number of 👍 to approve.


Reviewed requirements satisfied? No
Ancestors reviewed? Yes

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.