Skip to content

Commit f94d975

Browse files
MantisClonegitbook-bot
authored andcommitted
GITBOOK-119: change request with no subject merged in GitBook
1 parent 2111aff commit f94d975

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/sdk-guides/payment/hinkal-private-payments.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Hinkal Private Payments
22

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. 
44

5-
Each public address has exactly one Hinkal shielded address.
5+
Each public address has exactly one Hinkal private address.
66

77
The `@requestnetwork/payment-processor` package provides functions to:
88

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.
1111

1212
{% 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.
1414
{% endhint %}
1515

1616
## Benefits
@@ -32,12 +32,12 @@ npm install @requestnetwork/payment-processor
3232

3333
## Usage
3434

35-
### **Pay a request from a Hinkal shielded address**
35+
### **Pay a request from a Hinkal private address**
3636

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")
3838

3939
{% 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.
4141
{% endhint %}
4242

4343
```typescript
@@ -60,15 +60,15 @@ const relayerTx = await payErc20FeeProxyRequestFromHinkalShieldedAddress(
6060
See [quickstart-browser.md](../../get-started/quickstart-browser.md "mention") for how to instantiate a `RequestNetwork` and `Signer`
6161
{% endhint %}
6262

63-
### Deposit to a Hinkal shielded address
63+
### Deposit to a Hinkal private address
6464

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.  
6666

6767
* Deposit to own Hinkal shielded address: omit the `recipientInfo` argument
6868
* Deposit to someone else's Hinkal shielded address: set `recipientInfo` to the shielded address of the payment recipient.
6969

7070
{% 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.
7272
{% endhint %}
7373

7474
{% code overflow="wrap" %}

0 commit comments

Comments
 (0)