Skip to content

Commit

Permalink
docs second changes
Browse files Browse the repository at this point in the history
  • Loading branch information
viswa3760 committed Feb 13, 2024
1 parent abd71f6 commit 83efe45
Show file tree
Hide file tree
Showing 10 changed files with 249 additions and 185 deletions.
42 changes: 42 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
BRANCH?=$(shell git rev-parse --abbrev-ref HEAD | sed -e 's/prod/mainnet/g;s/develop/testnet/g;')
BUILDTAG?=$(shell git rev-parse --abbrev-ref HEAD | sed -e 's/prod/mainnet/g;s/develop/testnet/g;')
GITREF=$(shell git rev-parse --short HEAD)
# pull branch name from CI, if available
ifdef CI_COMMIT_BRANCH
BRANCH=$(shell echo ${CI_COMMIT_BRANCH} | sed 's/prod/mainnet/g')
BUILDTAG=$(shell echo ${CI_COMMIT_BRANCH} | sed -e 's/prod/mainnet/g;s/develop/testnet/g;s/testnet-multichain/testnet/g')
endif
VERSION=$(shell bash $(shell pwd)/../build/docker/get_next_git_tag.sh ${INCREMENT_TYPE})
TAG=$(shell date +%Y-%m-%d)
DATE=$(shell date +%Y-%m-%d)
# ------------------------------- GitHub ------------------------------- #

pull: ## Git pull repository
@git clean -idf
@git pull origin $(shell git rev-parse --abbrev-ref HEAD)

region-check:
@if [ -z "${REGION}" ]; then\
echo "add region env variable";\
exit 1;\
fi

ecr-check:
@if [ -z "${GCR}" ]; then\
echo "add gcr env variable";\
exit 1;\
fi
docker-push: ecr-check
docker push ${GCR}/${IMAGENAME}:${GITREF}_${VERSION}

docker-build: ecr-check
docker build -f ./Dockerfile -t ${GCR}/${IMAGENAME}:${GITREF}_${VERSION} .

push-tag:
@echo "Current directory: $(CURDIR)"
@bash $(shell pwd)/../build/docker/push_tag.sh ${VERSION}

release: docker-build docker-push push-tag

push-only-image: docker-build docker-push
# ------------------------------------------------------------------ #
16 changes: 8 additions & 8 deletions docs/Dojima/faucet.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,32 @@ To request tokens using the faucet.

### **1**. Before requesting TestNet tokens check the table for available faucet balances. 

![medium](https://storage.cloud.google.com/dojima_docs/faucet/faucet-table.png)
![medium](https://storage.googleapis.com/dojima_docs/faucet/faucet-table.png)

### **2**.  Select the Hermes token and copy the address.

![medium](https://storage.cloud.google.com/dojima_docs/faucet/copy-address.png)
![medium](https://storage.googleapis.com/dojima_docs/faucet/copy-address.png)

### **3**. Choose a chain for token requests.

![medium](https://storage.cloud.google.com/dojima_docs/faucet/choose-chain.png)
![medium](https://storage.googleapis.com/dojima_docs/faucet/choose-chain.png)

### **4**. Paste address in the address input or use self address checkbox.

![medium](https://storage.cloud.google.com/dojima_docs/faucet/paste-add.png)
![medium](https://storage.googleapis.com/dojima_docs/faucet/paste-add.png)

![medium](https://storage.cloud.google.com/dojima_docs/faucet/entered-add.png)
![medium](https://storage.googleapis.com/dojima_docs/faucet/entered-add.png)

### **5**. Click the "submit" button. Following submission, a popup will appear indicating whether the transaction was successful or unsuccessful. To close the popup, press anywhere. 

![medium](https://storage.cloud.google.com/dojima_docs/faucet/transfer-status.png)
![medium](https://storage.googleapis.com/dojima_docs/faucet/transfer-status.png)

### **6** If the pop-up indicates a successful transaction, you can check your test token balance on your Dojima wallet dashboard.

![medium](https://storage.cloud.google.com/dojima_docs/faucet/balance.png)
![medium](https://storage.googleapis.com/dojima_docs/faucet/balance.png)

### Stagenet

During a specified period, Stagenet tokens are accessible to users, offering a unique opportunity for participation in a limited-time token distribution.

![medium](https://storage.cloud.google.com/dojima_docs/faucet/stage-net.png)
![medium](https://storage.googleapis.com/dojima_docs/faucet/stage-net.png)
130 changes: 35 additions & 95 deletions docs/Dojima/index.md
Original file line number Diff line number Diff line change
@@ -1,98 +1,38 @@
---
id: quickstart
#title: Introduction to Dojima PoS
title: Dojima
sidebar_position: 1
hide:
- toc
---
# Introduction to Dojima PoS

!!! warning
UPDATING THE DEVELOP DOCS

The docs are being updated, enhanced, and improved. They are subject to change. Please feel free to raise an issue or pull request if you have any queries or suggestions.


Welcome to **Dojima** The most innovative and exciting platform to develop your blockchain application. Blockchain technology is poised to revolutionize how the digital world manages data and conducts business. You can join this revolution by getting a head start on Dojima's decentralized application (dApp) development.

This guide will introduce you to the Dojima ecosystem. You'll find links to valuable resources and websites that will bring you up to speed on building, not only on Dojima but also on general blockchain application development.

!!! tip
STAY IN THE KNOW

Keep up with the latest builder updates from the Dojima team and the community by subscribing to the .


## Building on Dojima

If you are an Ethereum developer, you are already a Dojima developer. Simply switch to the [Dojima RPC](https://api-test.d11k.dojima.network:8545/) and get started. All the tools you are familiar with on the Ethereum blockchain are supported on Dojima by default, such as Truffle, Remix, and Web3js.

You can deploy decentralized applications to either Dojima Testnet or the Mainnet. The Dojima Testnet connects with the Ethereum Goërli Testnet, which acts as its ParentChain. You can find all the network-related details in the **[network documentation]**.

### Wallets

To interact with the Dojima Network, you need to have an Ethereum-based wallet because Dojima runs on Ethereum Virtual Machine (EVM). You can choose to set up a Metamask or Arkane Wallet. More on wallet-related information and why you need one can be found in our wallet documentation.

### Smart Contracts

Dojima supports many services you can use to test, compile, debug, and deploy decentralized applications onto the Dojima Network. These include deployment using Alchemy, Chainstack, QuickNode, Remix, Truffle, Hardhat, and Replit.

<!-- ### Connecting to Dojima
You can add Dojima to Metamask or directly use Arkane, which allows you to connect to Dojima using RPC.
In order to connect with the Dojima Network to read blockchain information, we recommend using the Alchemy SDK.
```js
// Javascript
// Setup: npm install alchemy-sdk
const { Alchemy, Network } = require("alchemy-sdk");
const settings = {
apiKey: "demo", // Can replace with your API Key from https://www.alchemy.com
Network: Network.DOJIMA_TESTNET,
};
const alchemy = new Alchemy(settings);
async function main() {
const latestBlock = await alchemy.core.getBlockNumber();
console.log("The latest block number is", latestBlock);
}
main();
``` -->

### Building a new dApp on Dojima?

Decentralized applications (dApps) act as the bridge between users and their data privacy on the blockchain. The increasing number of dApps validates their usefulness within the blockchain ecosystem, solving challenges like executing transactions between two participants without the need for central authority via smart contracts.

Suppose you have no prior experience building decentralized applications (dApps). In that case, the below-mentioned resources will give you a head start on the tools required to build, debug, and deploy dApps on the Dojima Network.

[Full Stack dApp: Tutorial Series](https://kauri.io/full-stack-dapp-tutorial-series/5b8e401ee727370001c942e3/c)
- [Web3.js](https://www.dappuniversity.com/articles/web3-js-intro)
- [Ethers.js](https://docs.ethers.io/v5/)
- [Remix](https://docs.polygon.technology/docs/develop/remix/)
- [Truffle](https://docs.polygon.technology/docs/develop/truffle)
- [Metamask](https://docs.polygon.technology/docs/develop/metamask/overview)
- [Arkane](https://docs.polygon.technology/docs/develop/wallets/arkane/intro)
- [Develop a dApp using Fauna, Dojima and React](https://docs.polygon.technology/docs/develop/dapp-fauna-polygon-react)
### Already have a dApp?

If you already have a decentralized application (dApp) and are looking for a platform to help you scale efficiently, then you are at the right place because Dojima allows you to:

1. **Easily migrate from Ethereum Virtual Machine (EVM) based chain**: Dojima prides itself in being the ultimate Layer-2 scaling solution for Ethereum. You don't have to worry about the underlying architecture while moving or deploying your dApps to the Dojima Network as long as it is EVM-compatible

2. **Use Dojima as a faster transaction layer**: Deploying your dApp to the Dojima Mainnet allows you to leverage Dojima as a faster transaction layer for your dApp. Additionally, you can get your tokens mapped by us. You can join our technical discussions group on Telegram to learn more.

## Side Note

If this is overwhelming, that’s alright! You can jump right into the action and start hacking. Here are some notes before you start diving into resources, repositories, and docs:

1. **Beware the cost of being on the bleeding edge**: Like typical niche programming, dApps and blockchain development moves very quickly. While researching, you may find complex code repositories, 404s on a documentation site, or even no documentation. Use that opportunity to reach out to us via any social media channel.

2. **The learning curve may be daunting, but the barrier to entry is low**: The community is very open and welcoming! Projects welcome pull requests from outsiders and resolve any blockers actively. We’re working on creating a better world and contribution in any form is appreciated. We’ll be grateful to onboard you into this amazing Web3 ecosystem.

!!! info
STAY UPDATED

Decentralized application development encourages network decentralization. Follow our social media handles for more insights and updates about the Dojima ecosystem. You can find the links to all the Dojima communities here.
<style>
.git-revision-date-localized-plugin, .md-source-file, .md-content__button.md-icon {
display: none;
}
</style>

<div class="section-wrapper product-section-head">
<div class="hero-image"><img src="../img/developer-1.png" loading="lazy" class="hero-image" style="width: 40%; float: right;"></div>
<div class="hero-left">
<h1 class="hero-heading">Developers</h1>
<p class="hero-subtext">Your resource hub for seamless onboarding and support within our evolving ecosystem.</p>
</div>
</br>
</div>
<div class="grid-container">
<div class="grid-item">
<a href="/templates/omni_chain_ERC20/">
<div class="product-list-item-header">
<div class="feature-card-heading">Templates</div>
</div>
<p class="feature-paragraph">Explore our library of ready-made templates, offering instant integration of common use cases or smart contracts, streamlining your blockchain development process.</p>
</a>
</div>
<div class="grid-item">
<a href="/Dojima/faucet/">
<div class="product-list-item-header">
<div class="feature-card-heading">Faucet</div>
</div>
<p class="feature-paragraph">The Faucet is a web-based service that can send you some test tokens so that you can explore and experiment with testnet without having to pay for anything.</p>
</a>
</div>
</div>
</div>
5 changes: 1 addition & 4 deletions docs/hermes/architecture/contracts/inbound_state_sender.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,7 @@ To utilize the State Sender Contract, follow these straightforward steps:

* Retrieve the Inbound State Sender Contract address from the Dojima Chain Explorer.

>
!!! warning

**IMPORTANT:** The Inbound State Sender Contract address may vary for different chains. Ensure that you select the appropriate chain i.e. (Ethereum, Avalanche) and appropriate network i.e. (mainnet or testnet).
**⚠️ Warning:** The Inbound State Sender Contract address may vary for different chains. Ensure that you select the appropriate chain i.e. (Ethereum, Avalanche) and the appropriate network i.e. (mainnet or testnet).

### Step 3: Register the Destination Contract
Before you can send state transaction to the Dojima Chain, you need to register the destination contract. This is done using the `register` function in the State Sender Contract. This function takes two parameters:
Expand Down
81 changes: 41 additions & 40 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
hide:
- navigation
- toc
- navigation
- toc
---

<style>
Expand All @@ -28,14 +28,14 @@ hide:
<p class="hero-subtext">Learn the methods to build and deploy dApps, launch ZK rollups and validiums as Layer 2s on Ethereum, set up nodes, and stay informed about the latest advancements in zero-knowledge research.
</p>
</div>
<div class="button-container">
<button class="getstarted-button">
Get Started
</button>
<div class="icon-background">
<img src="img/rounded-right-arrow.svg" loading="lazy" alt="">
</div>
</div>
<a class="button-container" href="/hermes/">
<button class="getstarted-button">
Get Started
</button>
<div class="icon-background">
<img src="img/rounded-right-arrow.svg" loading="lazy" alt="">
</div>
</a>
<!-- <p class="hero-subtext"> Learn how to build and deploy dApps, launch ZK rollups and validiums as Layer 2s on Ethereum, spin up nodes, and find out about the latest in zero-knowledge research.<p> -->
</div>
<div class="hero-right"><img src="img/rightimage.svg" loading="lazy" alt="" class="hero-image"></div>
Expand All @@ -49,15 +49,15 @@ hide:
<div class="div-card">
<div class="div-card-header">
<img src="img/hermes.svg" loading="lazy" alt="">
<h3>Omnichain Layer</h3>
<h3>Core</h3>
</div>
<p class="div-leftcard-p">Connect a smart contract to any API and run custom Web3 computation.</p>
<p class="div-leftcard-p">Unveiling Dojima Network's essence, highlighting the innovative infrastructure of Hermes and Dojima chains.</p>
<div class="div-card-button-container">
<a class="div-card-button">
Try out Testnet <img src="img/rightuparrow.svg" loading="lazy" alt="">
<a class="div-card-button" href="/hermes/what-is-dojima-network/">
What is Dojima Network? <img src="img/rightuparrow.svg" loading="lazy" alt="">
</a>
<a class="div-card-button">
Stagenet is coming <img src="img/rightuparrow.svg" loading="lazy" alt="">
<a class="div-card-button" href="/hermes/architecture/hermeschain/">
Hermes Chain <img src="img/rightuparrow.svg" loading="lazy" alt="">
</a>
</div>
</div>
Expand All @@ -66,15 +66,15 @@ hide:
<div class="div-card">
<div class="div-card-header">
<img src="img/hermes.svg" loading="lazy" alt="">
<h3>Developer DashBoard</h3>
<h3>Developers</h3>
</div>
<p class="div-leftcard-p">Navigate and Optimize Your Journey with Dojima Network's Developer Dashboard.</p>
<p class="div-leftcard-p">Your resource hub for seamless onboarding and support within our evolving ecosystem.</p>
<div class="div-card-button-container">
<a class="div-card-button">
Build <img src="img/rightuparrow.svg" loading="lazy" alt="">
<a class="div-card-button" href="/templates/omni_chain_ERC20/">
Templates <img src="img/rightuparrow.svg" loading="lazy" alt="">
</a>
<a class="div-card-button">
Explorer<img src="img/rightuparrow.svg" loading="lazy" alt="">
<a class="div-card-button" href="/Dojima/faucet/">
Faucet<img src="img/rightuparrow.svg" loading="lazy" alt="">
</a>
</div>
</div>
Expand All @@ -86,44 +86,45 @@ hide:
<img src="img/hermes.svg" loading="lazy" alt="">
<h3>Tools</h3>
</div>
<p class="first-p">Connect a smart contract to any API and run custom Web3 computation.</p>
<a class="middle-p">
<p class="first-p">Explore our versatile tools section featuring a cross-chain wallet, innovative FAAS solution, and developer dashboard for seamless integration.</p>
<a class="middle-p" href="/wallet/">
<div class="right-grid-a">
<p class="right-p">Cross-chain Wallet</p>
<p class="right-p ">Dojima Wallet</p>
<img src="img/rightuparrow.svg" loading="lazy" alt="">
</svg>
<div class="live">Live</div>
<!-- <div class="live">Live</div> -->
</div>
<p style="margin-top:8px">Connect a smart contract to any API and run custom Web3 computation.</p>
<p style="margin-top:8px">Dojima wallet lets you organise major layer 1 tokens in one place.</p>
</a>
<a class="middle-p">
<a class="middle-p" href="/dojima-faas/">
<div class="right-grid-a">
<p class="right-p">Cross Chain Block Explorer</p>
<p class="right-p">Dojima Fass</p>
<img src="img/rightuparrow.svg" loading="lazy" alt="">
<div class="live">Live</div>
<!-- <div class="live">Live</div> -->
</div>
<p style="margin-top:8px">Dive into the seamless connectivity of Dojima Network's Cross Chain Block Explorer.</p>
<p style="margin-top:8px">Dojima FAAS offers blockchain services like transaction signing and history viewing.</p>
</a>
<a class="last-p">
<div class="right-grid-a">
<p class="right-p">Cross Chain Block Explorer</p>
<a class="last-p" href="/developer-dashboard/login/">
<div class="right-grid-a" >
<p class="right-p ">Developer Dashboard</p>
<img src="img/rightuparrow.svg" loading="lazy" alt="">
<div class="live">Live</div>
<!-- <div class="live">Live</div> -->
</div>
<p style="margin-top:8px">Dive into the seamless connectivity of Dojima Network's Cross Chain Block Explorer.</p>
<p style="margin-top:8px">Empower your development journey with our intuitive developer dashboard, offering insights, tools, and resources for efficient blockchain integration and application management.</p>
</a>
</div>
<div class="right-card-container">
<div class="div-card-header">
<img src="img/hermes.svg" loading="lazy" alt="">
<h3>Run Validator Node</h3>
<h3>Validator</h3>
</div>
<p>Navigate and Optimize Your Journey with Dojima Network's Developer Dashboard.</p>
<p>Unlock the path to becoming a valued validator with our comprehensive documentation, empowering you to safeguard the integrity of our blockchain network.</p>
</div>
</div>
</div>

<!-- <section class="section">
<!-- <section class="section">
<div class="container-global">
<div class="section-wrapper">
<div class="flexbox-2-col">
Expand Down Expand Up @@ -346,6 +347,6 @@ hide:
</div>
</div>
</div>
</section> -->
</section> -->

</div>
Loading

0 comments on commit 83efe45

Please sign in to comment.