From 83efe4595fe3f7abaafb243c8a2b5beb0679c6ca Mon Sep 17 00:00:00 2001 From: viswa3760 Date: Tue, 13 Feb 2024 12:16:18 +0530 Subject: [PATCH] docs second changes --- Makefile | 42 ++++++ docs/Dojima/faucet.md | 16 +-- docs/Dojima/index.md | 130 +++++------------- .../contracts/inbound_state_sender.md | 5 +- docs/index.md | 81 +++++------ docs/wallet/index.md | 55 +++++--- docs/wallet/wallet-login.md | 37 +++-- docs/wallet/wallet-swap.md | 20 +-- get_next_git_tag.sh | 39 ++++++ push_tag.sh | 9 ++ 10 files changed, 249 insertions(+), 185 deletions(-) create mode 100644 Makefile create mode 100644 get_next_git_tag.sh create mode 100644 push_tag.sh diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..c54b14a --- /dev/null +++ b/Makefile @@ -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 +# ------------------------------------------------------------------ # diff --git a/docs/Dojima/faucet.md b/docs/Dojima/faucet.md index 2e40047..371f08b 100644 --- a/docs/Dojima/faucet.md +++ b/docs/Dojima/faucet.md @@ -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) \ No newline at end of file +![medium](https://storage.googleapis.com/dojima_docs/faucet/stage-net.png) \ No newline at end of file diff --git a/docs/Dojima/index.md b/docs/Dojima/index.md index 8ce3e77..bdc72b4 100644 --- a/docs/Dojima/index.md +++ b/docs/Dojima/index.md @@ -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. - - - -### 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. + + +
+
+
+

Developers

+

Your resource hub for seamless onboarding and support within our evolving ecosystem.

+
+
+
+
+
+ +
+
Templates
+
+

Explore our library of ready-made templates, offering instant integration of common use cases or smart contracts, streamlining your blockchain development process.

+ +
+
+ +
+
Faucet
+
+

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.

+ +
+
+ diff --git a/docs/hermes/architecture/contracts/inbound_state_sender.md b/docs/hermes/architecture/contracts/inbound_state_sender.md index 3213721..2477c58 100644 --- a/docs/hermes/architecture/contracts/inbound_state_sender.md +++ b/docs/hermes/architecture/contracts/inbound_state_sender.md @@ -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: diff --git a/docs/index.md b/docs/index.md index 39815ef..0a2bec8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,7 @@ --- hide: - - navigation - - toc + - navigation + - toc ---