You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/sdk-guides/payment/hinkal-private-payments.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
1
# Hinkal Private Payments
2
2
3
-
The Request Network SDK supports Hinkal Private Payments using ERC-20 tokens. Hinkal is a middleware and suite of smart contracts on EVM-compatible chains that leverage zero-knowledge proofs and shielded addresses to facilitate compliant and private transactions. 
3
+
The Request Network SDK supports Hinkal Private Payments using ERC-20 tokens. Hinkal is a middleware and suite of smart contracts on EVM-compatible chains that leverage zero-knowledge proofs and private addresses to facilitate compliant and private transactions. 
4
4
5
-
Each public address has exactly one Hinkal shielded address.
5
+
Each public address has exactly one Hinkal private address.
6
6
7
7
The `@requestnetwork/payment-processor` package provides functions to:
8
8
9
-
***Pay a request from a Hinkal shielded address to a public address:** such that the payment sender's public address never appears on-chain.
10
-
***Deposit to a Hinkal shielded address from a public address**: such that the payment recipient's public address never appears on-chain. Callers can choose to deposit to their own shielded address or someone else's shielded address.
9
+
***Pay a request from a Hinkal private address to a public address:** such that the payment sender's public address never appears on-chain.
10
+
***Deposit to a Hinkal private address from a public address**: such that the payment recipient's public address never appears on-chain. Callers can choose to deposit to their own private address or someone else's private address.
11
11
12
12
{% hint style="info" %}
13
-
Paying a request where the payment recipient address is a Hinkal shielded address is not supported because the Request Network payment proxy smart contracts can only send funds to public addresses. Consider using [declarative-request.md](declarative-request.md"mention") instead.
13
+
Paying a request where the payment recipient address is a Hinkal private address is not supported because the Request Network payment proxy smart contracts can only send funds to public addresses. Consider using [declarative-request.md](declarative-request.md"mention") instead.
### **Pay a request from a Hinkal shielded address**
35
+
### **Pay a request from a Hinkal private address**
36
36
37
-
To pay a request from a Hinkal shielded address to a public address, where only the payment sender's address is obfuscated, use the \``` payErc20FeeProxyRequestFromHinkalShieldedAddress()` `` function. Ensure the payment sender's Hinkal shielded address has a positive balance using[#deposit-to-a-hinkal-shielded-address](hinkal-private-payments.md#deposit-to-a-hinkal-shielded-address"mention")
37
+
To pay a request from a Hinkal private address to a public address, where only the payment sender's address is obfuscated, use the \``` payErc20FeeProxyRequestFromHinkalShieldedAddress()` `` function. Ensure the payment sender's Hinkal private address has a positive balance using[#deposit-to-a-hinkal-private-address](hinkal-private-payments.md#deposit-to-a-hinkal-private-address"mention")
38
38
39
39
{% hint style="warning" %}
40
-
Strongly consider using [encryption-and-decryption](../encryption-and-decryption/"mention") to keep the request contents private, including the payer and payee identity addresses, when paying requests from a Hinkal shielded address. Revealing the payer and payee identity addresses increases the likelihood of un-shielding the payment sender's address via on-chain analysis.
40
+
Strongly consider using [encryption-and-decryption](../encryption-and-decryption/"mention") to keep the request contents private, including the payer and payee identity addresses, when paying requests from a Hinkal private address. Revealing the payer and payee identity addresses increases the likelihood of un-shielding the payment sender's address via on-chain analysis.
See [quickstart-browser.md](../../get-started/quickstart-browser.md"mention") for how to instantiate a `RequestNetwork` and `Signer`
61
61
{% endhint %}
62
62
63
-
### Deposit to a Hinkal shielded address
63
+
### Deposit to a Hinkal private address
64
64
65
-
To deposit funds to a Hinkal shielded address from a public address, where only the payment recipient's address is obfuscated, use the `sendToHinkalShieldedAddressFromPublic()` function.  
65
+
To deposit funds to a Hinkal private address from a public address, where only the payment recipient's address is obfuscated, use the `sendToHinkalShieldedAddressFromPublic()` function.  
66
66
67
67
* Deposit to own Hinkal shielded address: omit the `recipientInfo` argument
68
68
* Deposit to someone else's Hinkal shielded address: set `recipientInfo` to the shielded address of the payment recipient.
69
69
70
70
{% hint style="info" %}
71
-
Hinkal shielded addresses must be shared out-of-band. This SDK doesn't offer functions for sharing Hinkal shielded addresses.
71
+
Hinkal private addresses must be shared out-of-band. This SDK doesn't offer functions for sharing Hinkal private addresses.
0 commit comments