chore: add help target to Makefile to display the usage of all targets
#125
Conversation
WalkthroughThe Makefile has been significantly enhanced to streamline various development, testing, and deployment processes. This includes adding new targets for formatting code, updating submodules, building and testing smart contracts, deploying these contracts to the NEAR testnet, and managing Docker images for different components. Additionally, there are new targets for executing ERC20 transfers and a help command to provide users with information on available commands. Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant Makefile
participant NEAR Testnet
participant Docker
participant CDK Node
Developer->>Makefile: run build-contracts
Makefile->>Makefile: Create blob store contract
Developer->>Makefile: run test-contracts
Makefile->>Makefile: Create blob store contract and run tests
Developer->>Makefile: run deploy-contracts
Makefile->>NEAR Testnet: Deploy near-da-blob-store contract
Developer->>Makefile: run da-rpc-docker
Makefile->>Docker: Build Docker image for da-rpc
Developer->>Makefile: run cdk-devnet-up
Makefile->>CDK Node: Start cdk-validium-node development network
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- Makefile (2 hunks)
Additional comments not posted (14)
Makefile (14)
4-6: LGTM!The
formattarget correctly formats the code usingtaploandcargo fmt.
9-11: LGTM!The
submodulestarget correctly updates submodules.
18-20: LGTM!The
build-contractstarget correctly builds thenear-da-blob-storecontract.
22-24: LGTM!The
test-contractstarget correctly builds thenear-da-blob-storecontract and runs tests.
27-29: LGTM!The
deploy-contractstarget correctly deploys thenear-da-blob-storecontract to the NEAR testnet.
35-37: LGTM!The
da-rpc-dockertarget correctly builds the Docker image.
40-45: LGTM!The
da-rpc-sys-unixtarget correctly copies the compiledda-rpclibrary from the Docker image to the local filesystem.
48-54: LGTM!The
cdk-imagestarget correctly pulls and tags thecdk-validium-contractsandcdk-validium-nodeDocker images.
56-58: LGTM!The
cdk-devnet-uptarget correctly starts thecdk-validium-nodedevelopment network and explorer.
61-63: LGTM!The
cdk-devnet-downtarget correctly stops thecdk-validium-nodedevelopment network.
66-68: LGTM!The
cdk-nodetarget correctly builds thecdk-validium-node.
71-73: LGTM!The
send-cdk-transferstarget correctly runs the ERC20 transfers script.
76-78: LGTM!The
cdk-devnet-redeploy-testtarget correctly builds and starts thecdk-validium-nodedevelopment network, then tests the ERC20 transfers script.
80-84: LGTM!The
helptarget correctly displays the help message.
Similar to near/nearcore pulls#11784
The
helptarget will be helpful for new developers begin to contribute for this project.This change is
Summary by CodeRabbit