Как отправить запросы на извлечение для обновления ссылок в Blockscout

В этом руководстве показано, как найти и заменить ссылки Etherscan на Blockscout в репозиториях с открытым исходным кодом. Включает пошаговые инструкции по запросу на извлечение GitHub, примеры команд и правильное сопоставление доменов для Ethereum, Gnosis, Optimism и т. д.

post image

Инструменты с открытым исходным кодом воплощают фундаментальные принципы децентрализации и прозрачности, лежащие в основе блокчейна. Blockscout, обозреватель блокчейнов с открытым исходным кодом, иллюстрирует эти ценности, поощряя прозрачность, разработку, основанную на сообществе, и гибкость. В отличие от фирменных обозревателей, таких как Etherscan, Blockscout позволяет пользователям и разработчикам вносить вклад, настраивать и адаптировать обозреватель в соответствии с их конкретными потребностями.

Это руководство проведет вас через процесс определения и обновления ссылок на обозреватель блоков в любом публичном репозитории, а также о том, как отправить запрос на извлечение (PR) для включения ваших улучшений. Независимо от того, вносите ли вы вклад в проект, который вам нравится в пространстве DeFi, или улучшаете свой собственный, это обновление обеспечивает гибкость и способствует использованию инструментов с открытым исходным кодом.

post image

Предварительные условия

Прежде чем начать, убедитесь, что у вас есть:

  • Учетная запись GitHub

  • Git установлен локально (или используйте веб-интерфейс GitHub)

  • Знакомство с основными командами Git (или используйте интерфейс GitHub)

  • Репозиторий, в который вы хотите внести свой вклад (разветвленный или клонированный)

Шаг 1. Поиск ссылок Explorer в репозитории

Эта часть может быть сложной, поскольку в крупных монорепозиториях или экосистемах с большим количеством подрепозиториев ссылки Explorer могут быть разбросаны и их трудно найти.

Один из способов решения этой проблемы — использовать ripgrep — невероятно быстрый инструмент поиска командной строки, который по умолчанию учитывает .gitignore и идеально подходит для больших кодовых баз.

Установите ripgrep, войдите в корень своего проекта и запустите;

rg etherscan.io

💡 В большинстве репозиториев есть определенные правила отправки запросов на извлечение. Важно внимательно ознакомиться с этими рекомендациями и придерживаться установленного процесса, чтобы повысить вероятность принятия вашего запроса на включение.

Шаг 2: замените ссылки на URL-адреса

Blockscout Используйте правильный домен Blockscout для цепочки, с которой вы работаете. Вот краткое сопоставление:

СЕТЬ |       ETHERSCAN       | BLOCKSCOUT
Ethereum Mainnet: etherscan.io eth.blockscout.com
Gnosis: gnosisscan.io gnosis.blockscout.com
Optimism: optimistic.etherscan.io optimism.blockscout.com
Polygon:                polygonscan.com polygon.blockscout.com
Base:                     basescan.org. base.blockscout.com

Шаг 3: Проверьте свои изменения

Перед фиксацией:

  • Проверьте, что все ссылки работают

  • Проверьте, что целевой адрес или транзакция соответствуют правильной цепочке.

  • Убедитесь, что нет сломанных markdown, JSX или HTML-рендеринга

Шаг 4: Фиксация и отправка

Создайте новую ветку, зафиксируйте и отправьте с помощью этих команд.

git checkout -b replace-etherscan-with-blockscout
git add .
git commit -m "chore: replaced block explorer links with Blockscout"
git push origin replace-etherscan-with-blockscout

Шаг 5: Отправьте запрос на извлечение

  • Перейдите на свой форк GitHub

  • Нажмите «Сравнить и запрос на извлечение»

  • Заполните форму PR:

После отправки запроса на извлечение важно дать время сопровождающим репозитория оценить ваши предлагаемые изменения. На этом этапе проверки они могут запросить корректировки или дополнительную информацию; поэтому обязательно отвечайте быстро и вносите все необходимые обновления. После одобрения вашего запроса на извлечение он будет объединен с основной кодовой базой.

post image

💡 При выборе репозитория важно убедиться, что он активен и хорошо обслуживается. Активный репозиторий с большей вероятностью будет получать своевременные обновления и поддержку, гарантируя, что любые отправленные вами запросы на извлечение будут эффективно обработаны.

Пример — Velodrome Finance Relay

Мы обновим файл README Velodrome Finance Relay, чтобы заменить текущие ссылки Etherscan на ссылки Blockscout для токенов. Velodrome — это децентрализованная биржа, которая упрощает обмен токенами с низкой комиссией, позволяет пользователям вносить токены за вознаграждения и обеспечивает активное участие в экономике на блокчейне.

Шаг 1: Форк и клонирование репозитория

Перейдите на GitHub Velodrome Finance и форк репозитория Velodrome Relay. Затем клонируйте свой форк репозитория на локальный компьютер.

post image

Run;

git clone https://github.com/your-username/repository-name.git
cd repository-name

Шаг 2: Создайте новую ветку

Создайте и переключитесь на новую ветку для ваших изменений

Run;

git checkout -b update-blockscout-links

post image

Шаг 3: Определите ссылки Etherscan с помощью ripgrep

Используйте ripgrep для поиска всех вхождений ссылок Etherscan:

Run;

rg -uuu 'etherscan'

post image

Шаг 4: Замените ссылки Etherscan на Blockscout

Используйте sed или вручную отредактируйте файлы, чтобы заменить URL-адреса Etherscan на эквиваленты Blockscout.

Run;

sed -i 's/https:\/\/etherscan\.io/https:\/\/blockscout.com/g' $(rg -l 'https?://(www\.)?etherscan\.io')

Проверьте и убедитесь, что заменяющие URL-адреса точны и направляют пользователей на соответствующие страницы Blockscout.

post image

Шаг 5: Зафиксируйте изменения

Подготовьте и зафиксируйте изменения с четким сообщением:

Run;

git add .
git commit -m "Replace Etherscan links with Blockscout"

Шаг 6: Отправка и создание запроса на извлечение

Отправьте свою ветку в свой разветвленный репозиторий:

Run;

git push origin update-blockscout-links

post image

Перейдите к своему форку на GitHub и создайте запрос на включение изменений в исходный репозиторий Velodrome Finance.

post image

Заключение Хотя централизованные обозреватели, такие как Etherscan, эффективны и широко используются, переход на Blockscout поощряет проекты к принятию более прозрачной и открытой инфраструктуры. Это практичный способ поддерживать принципы децентрализации и ценности открытости, которые часто обсуждаются в Web3, но не всегда отражаются в выборе инструментов.

Blockscout имеет полностью открытый исходный код, поддерживает несколько цепочек EVM и может размещаться самостоятельно любым проектом или сообществом. Обновляя ссылки обозревателя, вы снижаете зависимость от закрытых сервисов и облегчаете другим аудит, расширение или запуск собственных экземпляров. Такие небольшие вклады укрепляют основу открытой и устойчивой экосистемы блокчейна.