-
Notifications
You must be signed in to change notification settings - Fork 3
Conversation
@@ -38,6 +38,16 @@ Implementations: | |||
- [MintCanoncialToken Refund](/packages/bridges-starter-kit/celer/README.md#21mint-canoncial-token-refund) | |||
- [BurnCanoncialToken](/packages/bridges-starter-kit/celer/README.md#3burn-canonical-token) | |||
- [BurnCanoncialToken Refund](/packages/bridges-starter-kit/celer/README.md#31burn-canoncial-token-refund) | |||
|
|||
## DEX Module |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@naveed-klaytn Can we add some overview here ?
RPC_URL=<RPC URL here of the node you want to communicate with> | ||
# Account credentials you want to sign with | ||
PRIVATE_KEY=<Private key here> | ||
PUBLIC_KEY=<Public key here> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Possible to derive the public key from private key in the scripts?
PRIVATE_KEY=<Private key here> | ||
PUBLIC_KEY=<Public key here> | ||
|
||
CONFIRMATIONS=<here here the number of blocks confirmation required per transaction to proceed> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can give default values here. and in readme we can give explanation about all the .env params
User wont know about this.
eg: https://github.com/klaytn/klaytn-developer-sdk/tree/main/packages/bridges-starter-kit/wormhole#1token-attestation
|
||
## LIQUIDITY ENV variables | ||
### addresses of the PAIR | ||
TOKEN_0=<token0 address here> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add default value and give exp in readme so that user can change
packages/dexs-starter-kit/README.md
Outdated
@@ -0,0 +1,132 @@ | |||
# DEX Starter Kit | |||
This module of Klaytn-SDK includes the integration of [@klaytn/dex-contracts](https://www.npmjs.com/package/@klaytn/dex-contracts). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add overview and content
# Conflicts: # README.md
I have read the CLA Document and I hereby sign the CLA |
@toniya-klaytn can you check the latest changes, I've added jsDoc of each and every use-case plus core module. It explain every details & context of each functions including the params |
lint issues fixed
Description
This PR includes the integration of @klaytn/dex-contracts. Please refer to README for more details
Testing
Please refer to How to setup & How to run sections of README file to understand how to setup & test this PR