Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kadena-community/kadena-transfer-js
Simple Javascript tools to transfer Kadena coins
https://github.com/kadena-community/kadena-transfer-js
kadena
Last synced: 2 days ago
JSON representation
Simple Javascript tools to transfer Kadena coins
- Host: GitHub
- URL: https://github.com/kadena-community/kadena-transfer-js
- Owner: kadena-community
- Created: 2019-12-12T21:00:42.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-31T09:12:05.000Z (10 months ago)
- Last Synced: 2024-08-03T09:07:33.981Z (3 months ago)
- Topics: kadena
- Language: JavaScript
- Homepage: https://transfer.chainweb.com
- Size: 15.1 MB
- Stars: 5
- Watchers: 18
- Forks: 9
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# kadena-transfer-js
Kadena Transfer Tool supports simple KDA coin transfers. The frontend is deployed here: https://transfer.chainweb.com/
To integerate an exchange backend to Kadena's blockchain ecosystem, please visit kda-exchange-integration repo: https://github.com/kadena-io/kda-exchange-integration
## Single Chain Transfer
There are two ways to transfer KDA on a single chain. Kadena Transfer Tool uses `transfer-create` by default.
1. `transfer`
2. `transfer-create`
You can learn more about KDA coin contract [here](https://github.com/kadena-io/chainweb-node/blob/master/pact/coin-contract/coin.pact).
### transfer-create
**transfer-create** is executed between:
- One EXISTING account and one NON-EXISTING account that will be created by this transaction
- Two EXISTING accounts
The function takes in the following arguments:
- Sender Account
- Receiver Account
- Receiver Guard
- Amount
and requires a signature of the sender Keypair.
You should use this function if you are creating a new account and transferring KDA coin.
If you already have the receiver account, this function is still useful if you know the guard of the receiver account.
This will be a more conservative approach than `coin.transfer` which prevents you from transferring to a wrong account by checking the receiver guard.
### transfer
**transfer** is executed between:
- Two EXISTING accounts.
The function takes in the following arguments:
- Sender Account
- Receiver Account
- Amount
and requires a signature of the sender keypair.
You should use this function ONLY IF you are completely sure about the receiver account.
## Cross Chain Transfer
Cross chain transfer is a more complex transaction than single chain transfer, in that it involves a stepwise function with two steps and SPV proof fetching. You can learn more about the concept of ["pacts"](https://pact-language.readthedocs.io/en/latest/pact-reference.html#asynchronous-transaction-automation-with-pacts), which is a sequential transactions in Pact Language. Simply speaking, user needs to make 3 requests in order to make a cross chain transfer while user can complete a single chain transfer with 1 request:
1. Initiate the transfer on the source chain. (step 1)
2. Fetch SPV proof on the source chain.
3. Complete the transfer on the target chain. (step 2)
### transfer-crosschain
**transfer-crosschain** is executed between:
- One EXISTING account on one chain and one EXISTING account on a different chain
- One EXISTING account on one chain and one NON-EXISTING account on a different chain that will be created by this transaction
The function takes in the following arguments:
- Sender Account
- Receiver Account
- Receiver Guard
- Target Chain
- Amount
and requires:
- a signature of the sender keypair on the source chain
- gas payer of the target chain
- a signature of gas payer on the target chain.
## Update ledger-os.js (Bundled dependencies)
Sometimes all ledger dependencies gets updates in their repos so we need
to get the file ledger-os.js updated as well.
To do this we need follow those steps:
- install browserify globally
- cd ledger-bundle
- npm run-script build
The desired file should appear on the util folder.
## Docker
```
docker build -t kadenatransfer .
docker run --name kadenatransfer -p 8181:80 kadenatransfer
```
Once built, visit http://localhost:8181