Skip to content

Commit

Permalink
Merge branch 'main' into feat/auto-migdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Pantani authored Nov 14, 2023
2 parents e5bd249 + 57813c9 commit 6d64b94
Show file tree
Hide file tree
Showing 78 changed files with 5,877 additions and 1,211 deletions.
4 changes: 2 additions & 2 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
* @ilgooz @jeronimoalbi @Pantani @julienrbrt @Ehsan-saradar

# Docs
*.md @salmad3 @toschdev
docs/* @salmad3 @toschdev
*.md @salmad3 @toschdev @ilgooz
docs/* @salmad3 @toschdev @ilgooz
3 changes: 2 additions & 1 deletion .github/workflows/cl-enforcer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ jobs:
- uses: dangoslen/changelog-enforcer@v3
with:
changeLogPath: 'changelog.md'
missingUpdateErrorMessage: 'Please fill the changelog.md file or add the "Skip-Changelog" label'
missingUpdateErrorMessage: 'Please add an entry to the changelog.md file or add the "skip-changelog" label'
skipLabels: 'skip-changelog'
versionPattern: ''
31 changes: 31 additions & 0 deletions .github/workflows/proto-checker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Protobuf Files

on:
pull_request:
paths:
- "proto/**"

permissions:
contents: read

jobs:
lint:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@v3
- uses: bufbuild/[email protected]
- uses: bufbuild/buf-lint-action@v1
with:
input: "proto"

# TODO: Uncomment after PR#3529 is merged
# break-check:
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v3
# - uses: bufbuild/[email protected]
# - uses: bufbuild/buf-breaking-action@v1
# with:
# input: "proto"
# against: "https://github.com/${{ github.repository }}.git#branch=${{ github.event.pull_request.base.ref }},ref=HEAD~1,subdir=proto"
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
scripts/**/nodetime-*
**/testdata/**/go.sum
dist/
node_modules
.DS_Store
apps/
.idea
.vscode
docs/.vuepress/dist
Expand Down
20 changes: 20 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,26 @@ lint:

.PHONY: govet format lint

## proto-all: Format, lint and generate code from proto files using buf.
proto-all: proto-format proto-lint proto-gen

## proto-gen: Run buf generate.
proto-gen:
@echo Generating code from proto...
@buf generate --template ./proto/buf.gen.yaml --output ./

## proto-format: Run buf format and update files with invalid proto format>
proto-format:
@echo Formatting proto files...
@buf format --write

## proto-lint: Run buf lint.
proto-lint:
@echo Linting proto files...
@buf lint

.PHONY: proto-all proto-gen proto-format proto-lint

## test-unit: Run the unit tests.
test-unit:
@echo Running unit tests...
Expand Down
3 changes: 3 additions & 0 deletions buf.work.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
version: v1
directories:
- proto
15 changes: 15 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@

### Features

- [#3544](https://github.com/ignite/cli/pull/3544) Add bidirectional communication to plugin system
- [#3561](https://github.com/ignite/cli/pull/3561) Add GetChainInfo method to plugin system API

### Changes

- [#3529](https://github.com/ignite/cli/pull/3529) Refactor plugin system to use gRPC
- [#3751](https://github.com/ignite/cli/pull/3751) Rename label to skip changelog check
- [#3745](https://github.com/ignite/cli/pull/3745) Set tx fee amount as option
- [#3748](https://github.com/ignite/cli/pull/3748) Change default rpc endpoint to a working one

## [`v0.27.1`](https://github.com/ignite/cli/releases/tag/v0.27.1)

### Features

- [#3476](https://github.com/ignite/cli/pull/3476) Use `buf.build` binary to code generate from proto files
- [#3614](https://github.com/ignite/cli/pull/3614) feat: use DefaultBaseappOptions for app.New method
- [#3536](https://github.com/ignite/cli/pull/3536) Change app.go to v2 and add AppWiring feature
Expand Down Expand Up @@ -38,6 +52,7 @@
- [#3661](https://github.com/ignite/cli/pull/3661) Change `pkg/cosmosanalysis` to find Cosmos SDK runtime app registered modules
- [#3716](https://github.com/ignite/cli/pull/3716) Fix invalid plugin hook check
- [#3725](https://github.com/ignite/cli/pull/3725) Fix flaky TS client generation issues on linux
- [#3726](https://github.com/ignite/cli/pull/3726) Update TS client dependencies. Bump vue/react template versions
- [#3728](https://github.com/ignite/cli/pull/3728) Fix wrong parser for proto package names
- [#3729](https://github.com/ignite/cli/pull/3729) Fix broken generator due to caching /tmp include folders

Expand Down
61 changes: 31 additions & 30 deletions docs/docs/02-guide/00-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,34 @@ title: Introduction
slug: /guide
---

# Introduction

Developer tutorials provide step-by-step instructions to help you build blockchain developer skills.

By following these developer tutorials you will learn how to:

* Install Ignite CLI on your local machine
* Create a new blockchain and start a node locally for development
* Make your blockchain say "Hello, World!"
* Scaffold a Cosmos SDK query
* Modify a keeper method to return a static string
* Use the blockchain CLI to make a query
* Write and read blog posts to your chain in the Blog tutorial
* Scaffold a Cosmos SDK message
* Define new types in protocol buffer files
* Write keeper methods to write data to the store
* Read data from the store and return it as a result a query
* Use the blockchain CLI to broadcast transactions
* Build a blockchain for buying and selling names in the Nameservice tutorial
* Scaffold CRUD logic with `map`
* Use other module methods in your custom module
* Send tokens between addresses
* Build a guessing game with rewards
* Use an escrow account to store tokens
* Use the Inter-Blockchain Communication (IBC) protocol
* Scaffold an IBC-enabled module
* Send and receive IBC packets
* Configure and run a built-in IBC relayer
* Build a decentralized order-book token exchange
* Build an advanced IBC-enabled module
# Introduction to Ignite's Developer Tutorials

Welcome to the Ignite Developer Tutorials, your gateway to mastering blockchain development. These comprehensive tutorials are designed for learners at all levels, from beginners to seasoned developers, offering both foundational knowledge and hands-on experience.

## What You Will Learn

- **Getting Started with Ignite CLI**: Install the Ignite CLI and set up your development environment. This foundational step is necessary for all the tutorials that follow.

- **Create and Run Your First Blockchain**: Learn to create and run your own blockchain, understanding how to start and manage a node locally for development purposes.

- **Hello World Tutorial**: Engage in the excitement of blockchain development by making your blockchain respond with "Hello, World!" This includes learning to scaffold a Cosmos SDK query and modify keeper methods.

- **Blog Tutorial**: Step into decentralized applications (dApps) with the ability to write and read blog posts on your blockchain. This tutorial covers everything from defining new types in protocol buffer files to writing and reading data from the store.

- **DeFi Loan Tutorial**: Dive into Decentralized Finance (DeFi) by building a blockchain for managing loans. Gain insights into CRUD logic, module method integration, and token transaction management.

**Token Factory Tutorial**: Master the creation and management of digital assets on your blockchain by building a token factory module, learning module development, CRUD operations without delete functionality, and native denomination integration.

- **Inter-blockchain Communication (IBC) Basics**: Explore the interconnected world of blockchains with the IBC protocol. Learn how to scaffold an IBC-enabled module, manage IBC packets, and configure a built-in IBC relayer.

- **Interchange Module**: Advance your IBC knowledge by building a module for decentralized token exchanges and order books.

- **Debugging a Blockchain**: Develop essential skills in debugging to maintain efficient and effective blockchain development.

- **Running in a Docker Container**: Learn how to use Docker to containerize your blockchain environment, ensuring consistency and portability across development stages.

- **Chain Simulation**: Understand the importance and method of simulating blockchain environments for testing and validating functionality under various scenarios.

Each tutorial builds upon the previous, enhancing your understanding and skills progressively. By completing these tutorials, you will gain a robust understanding of blockchain principles, the Cosmos SDK, and practical experience in developing and managing blockchain projects.

Embark on your journey to become a proficient blockchain developer with Ignite's Developer Tutorials!
Loading

0 comments on commit 6d64b94

Please sign in to comment.