Используйте Truffle Suite для Easy Web3 — и заработайте доказательство вклада POAP
11 ноября 2022 г.Введение
Одним из преимуществ Web3 является открытость, компонуемость и интероперабельность на уровне приложений. Парадигма, в которой программное обеспечение и инструменты с открытым исходным кодом позволяют другим вносить свой вклад в проекты, которые они считают ценными, в то время как проекты обеспечивают прозрачность за счет публичного размещения своих кодовых баз. Еще одна инициатива Web3 — предоставление онлайн-доказательств вклада — возможность доказать, что вы можете делать то, о чем говорите.
Одной из компаний, воплощающих эти принципы Web3, является Truffle. Мало того, что большая часть его инструментов имеет открытый исходный код, поэтому каждый может внести свой вклад, они также предоставляют POAP для тех, кто это делает.
В этой статье будет рассмотрен набор инструментов с открытым исходным кодом Truffle, что такое POAP, и вы узнаете, как внести свой первый вклад, чтобы доказать, что вы являетесь разработчиком Web3 с помощью Truffle.
Что такое трюфель?
Как следует из изображения выше, Truffle — это набор инструментов для разработки смарт-контрактов. Кроме того, это была одна из первых сетей разработчиков, созданных для Ethereum. От написания до развертывания и всего, что между ними, пакет Truffle делает процесс проще и безопаснее. И самое лучшее?
Большинство инструментов имеют открытый исходный код. Таким образом, вы можете изменить эти инструменты в соответствии со своими потребностями и поделиться своими изменениями с более широким сообществом Web3.
В состав Truffle Suite входят следующие компоненты:
Давайте рассмотрим каждый из этих инструментов, чтобы лучше понять их.
Трюфель
Truffle, флагманский инструмент в комплекте, представляет собой среду разработки, упрощающую создание проектов смарт-контрактов. Этот инструмент включает в себя автоматическое тестирование, настраиваемые конвейеры сборки, развертывание с помощью сценариев, встроенное управление сетью и многое другое.
Начать работу с Truffle легко. Введите следующие команды в своем терминале, чтобы установить инструмент, а затем инициализировать новый проект:
$ npm install -g truffle
$ truffle init
Команда truffle init создает пустой проект с необходимой структурой папок и файлом конфигурации, чтобы вы могли быстро начать сборку.
Ганаш
После разработки смарт-контракта вам необходимо протестировать его на блокчейне. Здесь на помощь приходит Ganache. Ganache — это локальный блокчейн, который имитирует Ethereum на вашем компьютере. Он позволяет вам использовать console.log в Solidity, разветвлять основную сеть (или любую другую сеть Ethereum), устанавливать параметры майнинга и выдавать себя за реальные учетные записи, среди прочего.
Ganache необходим для тестирования смарт-контрактов, чтобы понять, как они будут вести себя при развертывании в тестовой или основной сети.
Установите Ganache, а затем запустите его с помощью следующих команд:
$ npm install ganache --global
$ ganache
Примечание. Вы можете запустить Ganache с различными параметрами, используя следующий формат:
$ ganache --namespace.option="value"
Кроме того, вы можете запустить Ganache в своем браузере, включив в свой HTML-код следующее, заменив {VERSION} установленной версией Ganache:
<script src="https://cdn.jsdelivr.net/npm/ganache@{VERSION}/dist/web/ganache.min.js"></script>
Truffle для VS Code
Если вы предпочитаете редактор Visual Studio Code, Truffle имеет полезное расширение, которое позволяет создавать, компилировать, отлаживайте и развертывайте свои проекты, не выходя из редактора. Он также включает прямую интеграцию с вашей учетной записью Infura, так что вы можете легко развертывать свои проекты, используя настраиваемые конечные точки RPC, и все возможности наблюдения, которые обеспечивает Infura.
После установки расширения Truffle для VS Code вы можете начать новый проект или запустить другие команды, открыв палитру команд с помощью ctrl + shift + P и введя truffle. .
Панель управления трюфелем
Одним из самых рискованных аспектов разработки проектов смарт-контрактов является случайное раскрытие закрытых ключей вашего кошелька или мнемонических фраз. Панель инструментов Truffle устраняет этот риск, абстрагируя эту часть процесса и предоставляя графический интерфейс для взаимодействия.
После установки последней версии Truffle все, что вам нужно сделать, это настроить файл truffle-config.js, чтобы включить в объект networks следующее:
networks: {
dashboard: {
port: 24012,
}
},
Затем запуск информационной панели с помощью команды truffle dashboard отобразит графический интерфейс по адресу http://localhost:24012/rpcs< /a> в вашем браузере. Оттуда вы можете подключить свой кошелек MetaMask и выбрать сеть, в которой вы хотите развернуться. Когда вы будете готовы развернуть свой смарт-контракт, введите следующую команду, чтобы начать развертывание в подключенной сети:
$ truffle migrate --network dashboard
Коробки с трюфелями
Truffle Boxes — это шаблоны или стартовые элементы, которые задают вашему проекту определенное направление. Они состоят из кода, который поможет вам быстро начать работу, поэтому вам не придется каждый раз изобретать велосипед. Некоторые полезные блоки включают nft-box, оптимизм, arbitrum, react и polygon. Вы даже можете создавать свои трюфельные ящики!
Просто выберите ящик из списка доступных ящиков для трюфелей и выполните команду:
$ truffle unbox <box_name>
При этом создается новый проект Truffle со всеми шаблонами из выбранного Truffle Box.
Содействие Truffle
Теперь, когда вы знакомы с набором инструментов Truffle Suite, давайте узнаем, как мы можем внести свой вклад в их документацию и в процессе заработать POAP.
Что такое POAP?
Протокол подтверждения присутствия (POAP) — это платформа и инфраструктура в Web3 для выдачи токенов, подтверждающих, что кто-то что-то сделал. Это может быть посещение мероприятия, голосование в сообществе или участие в проекте. POAP — это NFT, выпущенные в соответствии со смарт-контрактом Proof of Attendance Protocol, и представляют собой цифровые записи, хранящиеся у коллекционеров, обычно для подтверждения того, что они посещали виртуальное или физическое мероприятие. В нашем случае мы получим POAP за участие в документации Truffle.
Ваш первый документальный вклад
В следующей части этой статьи мы рассмотрим шаги, необходимые для того, чтобы заработать годовой POAP участника и стать участником Truffle Contributor 2022 года. Truffle сотрудничает с GitPOAP для выдачи POAP участникам. GitPOAP — это платформа для признания участников, которая легко интегрирует выдачу POAP в GitHub. Как только мы внесем существенный вклад в документацию Truffle, мы можем отправить запрос на извлечение (PR) в репозиторий Truffle (репозиторий), чтобы объединить наш вклад. После этого мы можем войти в GitPOAP через GitHub, запросить наш POAP и просмотреть предмет коллекционирования на странице нашего профиля.
Как отправить свой вклад
Откройте новую вкладку и перейдите на страницу GitHub от Truffle.
Мы просмотрим документацию, чтобы увидеть, что мы можем сделать. Я сразу вижу, где мы можем быть полезны. Первое предложение в файле readme Truffle описывает три различных ценностных предложения программного обеспечения Truffle. Однако не хватает чего-то грамматически важного, чтобы подчеркнуть это: прекрасной оксфордской запятой. Оксфордские запятые позволяют каждому элементу массива иметь пространство имен. Хотя они носят стилистический характер (например, письмо в стиле AP, которое вы видите в журналах и газетах), они полностью полезны в технической документации.
Вступительное предложение Truffle гласит: «Truffle — это среда разработки, среда тестирования и конвейер активов для Ethereum, призванная облегчить жизнь разработчика Ethereum». На мой взгляд, это предложение читалось бы лучше, если бы в нем говорилось: «Truffle — это среда разработки, среда тестирования и конвейер активов для Ethereum, цель которых — облегчить жизнь разработчика Ethereum». Среда тестирования и конвейер ресурсов — это разные предложения, поэтому запятая будет полезна для добавления степени разделения. Давайте отправим PR команде Truffle. Процесс одинаков, независимо от вашей операционной системы.
Во-первых, давайте «разветвим» репозиторий Truffle на GitHub. Форк — это отдельная, но идентичная версия репозитория Truffle, которую мы можем использовать для отправки нашего PR. Мы можем работать в этом форке, не затрагивая основной репозиторий.
Отсюда мы можем создать нашу вилку Truffle. Я уже сделал один, как вы можете видеть ниже:
Затем мы можем «клонировать» наш новый репозиторий на нашу собственную машину. Это позволит нам работать над репозиторием в выбранной нами среде IDE, которой для меня будет VSCode. Убедившись, что мы находимся в правильном (нашем) ответвлении репозитория, давайте скопируем URL-адрес, например git@github.com:daviddoswell/truffle.git, и вставим его в окно нашего терминала.
После этого мы можем открыть проект в выбранной нами среде IDE.
В VSCode я открываю файл README.md и нахожу первое предложение, которое хочу обновить. Я меняю его, а затем отправляю изменения из моей локальной копии в мою удаленную (восходящую) копию. Вы можете увидеть мою оксфордскую запятую в строке 11:
Давайте внесем эти изменения:
Теперь программа предлагает нам создать запрос на вытягивание (PR). Мы можем вернуться к нашему репозиторию и проверить изменения. Иногда вы можете заранее связаться с сопровождающим репо и сообщить им, что вы работаете над проектом, особенно если он с открытым исходным кодом. В нашем случае специалист по сопровождению Truffle увидел наш PR и сразу же одобрил его.
Большинство проектов требуют двух или более утверждений для обеспечения ответственности. Без проблем. У нас это тоже есть.
После нескольких проверок, чтобы убедиться, что мой репозиторий соответствует всем требованиям безопасности, программного обеспечения и другим гарантиям, они могут объединить мой PR. Обычно для крупных проектов это занимает около двух часов, но может быть и раньше, или позже.
Теперь мы можем перейти на GitPOAP, чтобы узнать, выдал ли нам Truffle POAP за наш вклад. Во-первых, нам нужно подключить наш кошелек MetaMask. Нажмите кнопку Войти и выберите MetaMask.
Далее у нас есть возможность подключить нашу учетную запись Github.
К сожалению, мы пока ничего не можем отчеканить. Сначала мы должны представить наш вклад в GitPOAP. Итак, давайте начнем процесс адаптации.
Следуйте инструкциям, чтобы успешно отправить вклад.
Теперь ждем.
Как только наш POAP появится, мы сможем его отчеканить. БУМ!
Теперь мы можем вернуться к нашему профилю на веб-сайте GitPOAP и убедиться, что мы являемся официальным владельцем POAP.
И мы!
Заключение
В этой статье вы узнали о наборе инструментов Truffle, о том, что такое POAP, и о том, как получить его, внося свой вклад в документацию Truffle. Как видите, получение подтверждения вклада через POAP может быть полезным для подтверждения ваших способностей.
Кроме того, такие компании, как ConsenSys, которые делают некоторые из своих инструментов открытыми и вознаграждают участников за вклад, помогают создать экосистему, основанную на доверии и открытости. Хотя Web3 все еще находится в зачаточном состоянии, его направление выглядит многообещающим как для разработчиков, так и для пользователей.
Чтобы узнать больше о Truffle Suite или начать работу с их инструментами, ознакомьтесь с их документацией или Репозиторий Github.
Оригинал