@kimafinance/kima-transaction-api 1.4.0 → 1.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,16 +20,29 @@ import {
|
|
|
20
20
|
submitKimaTransaction,
|
|
21
21
|
SupportNetworks,
|
|
22
22
|
CurrencyOptions,
|
|
23
|
-
} from "@kimafinance/kima-transaction-
|
|
23
|
+
} from "@kimafinance/kima-transaction-api";
|
|
24
24
|
|
|
25
25
|
const txResult = await submitKimaTransaction({
|
|
26
26
|
originAddress: "0x1234123412341234123412341234123412341234",
|
|
27
27
|
originChain: "ETH",
|
|
28
|
+
originSymbol: "USDK",
|
|
28
29
|
targetAddress: "0x1234123412341234123412341234123412341234",
|
|
29
30
|
targetChain: "POL",
|
|
30
|
-
|
|
31
|
-
amount: 100,
|
|
32
|
-
fee: 0.3,
|
|
31
|
+
targetSymbol: "USDK",
|
|
32
|
+
amount: "100",
|
|
33
|
+
fee: "0.3",
|
|
34
|
+
htlcCreationHash: "", // required to send empty strings for now
|
|
35
|
+
htlcCreationVout: "",
|
|
36
|
+
htlcExpirationTimestamp: "",
|
|
37
|
+
htlcVersion: "",
|
|
38
|
+
senderPubKey: "",
|
|
39
|
+
options: {
|
|
40
|
+
signature: "", // required: generated signature from the approval message
|
|
41
|
+
feeId: "", // required: id returned from calculated fee in fcs
|
|
42
|
+
chargeFeeAtTarget: false // required: wether to deduct fees from origin or target
|
|
43
|
+
transactionIdSeed: "", // optional: used in fiat on ramp payments
|
|
44
|
+
transactionIdSignature: "", // optional: used to validate transaction idempotency
|
|
45
|
+
}
|
|
33
46
|
});
|
|
34
47
|
```
|
|
35
48
|
|
|
@@ -39,9 +52,10 @@ const txResult = await submitKimaTransaction({
|
|
|
39
52
|
|
|
40
53
|
- `originAddress`: sending address
|
|
41
54
|
- `originChain`: sending chain
|
|
55
|
+
- `originSymbol`: sending token symbol
|
|
42
56
|
- `targetAddress`: receiving address
|
|
43
57
|
- `targetChain`: receiving chain
|
|
44
|
-
- `
|
|
58
|
+
- `targetSymbol`: receiving token symbol
|
|
45
59
|
- `amount`: amount of token to transfer
|
|
46
60
|
- `fee`: amount of token that kima consumes to pay gas fee for pulling & releasing token transactions
|
|
47
61
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kimafinance/kima-transaction-api",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.2",
|
|
4
4
|
"description": "A wrapper around Kima's API, enabling sending and monitoring transactions (Beta version)",
|
|
5
5
|
"repository": "https://github.com/kima-finance/kima-transaction-api",
|
|
6
6
|
"author": "",
|