Skip to content

Commit 0ef3c12

Browse files
committed
docs(resources): update FAQ and Glossary with legacy-aligned content and accurate links
Refine `faq.mdx` and `glossary.mdx` to keep legacy structure/content while removing migration artifacts and fixing outdated references. - removed AI-generated warning banners from both pages - preserved legacy FAQ/Glossary layout and core definitions - updated FAQ answers that were no longer accurate (notably crypto-to-fiat support) - replaced generic or confusing references with feature-specific links where appropriate - cleaned old `docs.request.network` dependencies and moved to current internal/docs links where possible - fixed inconsistent link behavior in FAQ responses to improve readability and navigation
1 parent 6f231b0 commit 0ef3c12

2 files changed

Lines changed: 21 additions & 38 deletions

File tree

faq.mdx

Lines changed: 15 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,61 +4,57 @@ description: "Frequently Asked Questions and Common Misconceptions"
44

55
---
66

7-
<Warning>
8-
**AI-Generated Content** – This page was generated with AI assistance and may contain inaccuracies. While likely close to accurate, please verify critical details with the [stable documentation](https://docs.request.network) or [contact support](https://github.com/orgs/RequestNetwork/discussions).
9-
</Warning>
10-
117
<Info>
128
If your question is not answered below, please consider posting it to the [Request Network Discussions](https://github.com/orgs/RequestNetwork/discussions) page on Github.
139
</Info>
1410

1511
<AccordionGroup>
1612
<Accordion title="Is Request Network a blockchain, smart contract platform, or L2 scaling solution?">
17-
No. Request Network is not a blockchain, smart contract platform, or scaling solution. Rather, it's a protocol for storing payment requests, facilitating onchain payments, and reconciling those payments with the requests. It stores payment requests in [IPFS](https://www.ipfs.com/) and CID hashes on [Gnosis Chain](https://www.gnosis.io/). It uses [The Graph](https://thegraph.com/) for onchain event indexing. It processes payments across a variety of [supported payment chains](https://docs.request.network/get-started/supported-chains).
13+
No. Request Network is not a blockchain, smart contract platform, or scaling solution. Rather, it's a protocol for storing payment requests, facilitating onchain payments, and reconciling those payments with the requests. It stores payment requests in [IPFS](https://www.ipfs.com/) and CID hashes on [Gnosis Chain](https://www.gnosis.io/). It uses [The Graph](https://thegraph.com/) for onchain event indexing. It processes payments across a variety of [supported payment chains](/resources/supported-chains-and-currencies).
1814
</Accordion>
1915

2016
<Accordion title="What is the difference between Request Network and Request Finance?">
2117
Request Network is an open-source protocol. Request Finance is a product built on top of Request Network. Request Finance has spun off from Request Network, and they are now two separate teams.
2218
</Accordion>
2319

2420
<Accordion title="Do I need to create a request on the same chain that I want to receive payment?">
25-
No. Requests are created on Gnosis Chain (or Sepolia for testing), even if the payment will happen on a different chain. Payment(s) can occur on any of our [supported payment chains](https://docs.request.network/get-started/supported-chains#payments).
21+
No. Requests are created on Gnosis Chain (or Sepolia for testing), even if the payment will happen on a different chain. Payment(s) can occur on any of our [supported payment chains](/resources/supported-chains-and-currencies).
2622

27-
To help builders get started quickly, the Request Network Foundation operates [Request Node Gateways](https://docs.request.network/get-started/request-node-gateways) that are free for anyone to use. These gateways offer endpoints for creating and retrieving requests.
23+
To help builders get started quickly, the Request Network Foundation operates Request Node Gateways that are free for anyone to use. These gateways offer endpoints for creating and retrieving requests.
2824

2925
Requests created on Gnosis Chain are "real" and will exist forever. Requests created on Sepolia are "test" requests and will exist only as long as Sepolia continues to operate.
3026
</Accordion>
3127

3228
<Accordion title="Is the address that creates a request the same address that receives the payment?">
33-
It can be, but not necessarily. The [Signer Identity](https://docs.request.network/glossary#signer-identity) that signs to create a request is defined by the `signer` parameter. This is separate from the [Payment Recipient](https://docs.request.network/glossary#payment-recipient) which is defined by the `paymentNetwork.parameters.paymentAddress` parameter. They can be the same or different.
29+
It can be, but not necessarily. The [Signer Identity](/glossary#signer-identity) that signs to create a request is defined by the `signer` parameter. This is separate from the [Payment Recipient](/glossary#payment-recipient) which is defined by the `paymentNetwork.parameters.paymentAddress` parameter. They can be the same or different.
3430

3531
This design allows for a single payee identity to have potentially multiple payment recipient addresses.
3632

37-
See [Parties of a Request](https://docs.request.network/glossary#parties-of-a-request) for details.
33+
See [Parties of a Request](/glossary#parties-of-a-request) for details.
3834
</Accordion>
3935

4036
<Accordion title="Are requests in Request Network stored fully onchain?">
4137
No. Request Network is a hybrid onchain/offchain protocol storing the majority of request contents in IPFS. Only the content-addressable ID (CID) is stored onchain, on Gnosis Chain.
4238
</Accordion>
4339

4440
<Accordion title="Can I make a payment before creating a request?">
45-
Yes. Payments are linked to requests via a [Payment Reference](https://docs.request.network/advanced/request-network-sdk/sdk-guides/request-client/payment-reference) derived from the request contents. Therefore, it is possible to calculate the `paymentReference` and execute a payment *before* creating the corresponding request.
41+
Yes. Payments are linked to requests via a [Payment Reference](/glossary#payment-reference) derived from the request contents. Therefore, it is possible to calculate the `paymentReference` and execute a payment *before* creating the corresponding request.
4642
</Accordion>
4743

4844
<Accordion title="Does Request Network support requests for fiat currency?">
4945
Yes and No.
5046

51-
Requests can be *denominated* in fiat currencies like USD, EUR, etc. ([ISO 4217 currencies](https://en.wikipedia.org/wiki/ISO_4217)) but our payment smart contracts only support payments in cryptocurrencies. We call these [Conversion Payment](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/conversion-request)s, in which the requested fiat amount is converted to the appropriate cryptocurrency amount using onchain price feeds at the moment of payment.
47+
Requests can be *denominated* in fiat currencies like USD, EUR, etc. ([ISO 4217 currencies](https://en.wikipedia.org/wiki/ISO_4217)) but our payment smart contracts only support payments in cryptocurrencies. We call these [Conversion Payment](/glossary#conversion-payment)s, in which the requested fiat amount is converted to the appropriate cryptocurrency amount using onchain price feeds at the moment of payment.
5248

5349
It is possible to implement fiat payments using Declarative Requests, where the payer declares that the payment was sent and the payee declares that the payment was received.
5450
</Accordion>
5551

5652
<Accordion title="Does Request Network support crypto-to-fiat (off-ramp) or fiat-to-crypto (on-ramp) payments?">
57-
Not currently, but we're working on it.
53+
Crypto-to-fiat payments are supported via the Request Network API. See [Crypto-to-fiat Payments](/api-features/crypto-to-fiat-payments).
5854
</Accordion>
5955

6056
<Accordion title="Does Request Network support crypto payments from centralized exchanges (CEX) or custodians?">
61-
Yes. See [Single Request Forwarder](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/single-request-forwarder)
57+
Yes. See [Single Request Forwarder](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/single-request-forwarder).
6258
</Accordion>
6359

6460
<Accordion title="Can a Request Node modify a request's contents before persisting it to IPFS and onchain?">
@@ -68,15 +64,6 @@ If your question is not answered below, please consider posting it to the [Reque
6864
<Accordion title="Can I create a request via the Request Network SDK without using a Request Node?">
6965
No. Today, a Request Node is required to interact with the Request Network IPFS Network. That said, it is possible to make the end-user pay the protocol fee when creating a request instead of the Request Node. To do this, inject an `HttpMetaMaskDataAccess` into the frontend `RequestNetwork` instance.
7066

71-
<Warning>
72-
⚠️ **Security Warning**: The code example below uses `process.env.PRIVATE_KEY` for demonstration purposes only. **Never expose private keys in client-side code or commit them to version control.**
73-
74-
**For production applications, use one of these secure alternatives:**
75-
1. **Web3 wallet signature providers** (MetaMask, WalletConnect) - Let users sign with their own wallets
76-
2. **Server-side signing** - Keep private keys on your backend and expose a signing API
77-
3. **Hardware wallet integration** - Use Ledger or Trezor for key management
78-
</Warning>
79-
8067
```javascript
8168
const requestNetwork = new RequestNetworkBase({
8269
dataAccess: new HttpMetaMaskDataAccess({
@@ -92,7 +79,7 @@ If your question is not answered below, please consider posting it to the [Reque
9279
</Accordion>
9380

9481
<Accordion title="Can I access a user's historical invoices created via Request Finance?">
95-
Yes. It is possible to request access to a user's Request Finance invoices using the [`add-stakeholder` web component](https://docs.request.network/learn-request-network/components/add-stakeholder) which is just a thin wrapper around the [Request Finance Add Stakeholders API](https://docs.request.finance/faq#i-am-integrating-the-request-network.-can-i-get-access-to-users-data-on-request-finance). They display a dialog that prompts the end-user to grant access to 1 invoice at a time.
82+
Yes. It is possible to request access to a user's Request Finance invoices using the add-stakeholder web component which is just a thin wrapper around the [Request Finance Add Stakeholders API](https://docs.request.finance/faq#i-am-integrating-the-request-network.-can-i-get-access-to-users-data-on-request-finance). They display a dialog that prompts the end-user to grant access to 1 invoice at a time.
9683

9784
Details:
9885

@@ -103,18 +90,18 @@ If your question is not answered below, please consider posting it to the [Reque
10390
<Accordion title="Does Request Network support crosschain payments where the payer sends funds on one chain and the payee receives funds on a different chain?">
10491
Yes, via the **Request Network API only**. Crosschain payments are not supported by the Request Network SDK or protocol directly. When using the API, payers can fund requests using assets on different chains and tokens, and the payee receives the requested asset on the request's chain. For example, you can pay a USDC-on-Base request using USDT from Optimism.
10592

106-
See <Card title="Crosschain Payments" icon="link" href="/api-features/crosschain-payments">Learn how to implement crosschain payment flows</Card> for implementation details.
93+
See [Crosschain Payments](/api-features/crosschain-payments) for implementation details.
10794
</Accordion>
10895

10996
<Accordion title="Does Request Network support private requests?">
11097
Yes. See:
11198

11299
- [Private Requests using Encryption](https://docs.request.network/advanced/protocol-overview/private-requests-using-encryption)
113-
- [Encrypt with a wallet signature using Lit Protocol](https://docs.request.network/advanced/request-network-sdk/sdk-guides/encryption-and-decryption/handle-encryption-with-a-web3-wallet)
100+
- [Handle Encryption with a Web3 Wallet](https://docs.request.network/advanced/request-network-sdk/sdk-guides/encryption-and-decryption/handle-encryption-with-a-web3-wallet)
114101
</Accordion>
115102

116103
<Accordion title="Does Request Network support private payments?">
117-
Yes. See [Hinkal Private Payments](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/hinkal-private-payments)
104+
Yes. See [Hinkal Private Payments](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/hinkal-private-payments).
118105
</Accordion>
119106

120107
<Accordion title="Can I create a request via a smart contract call?">
@@ -124,6 +111,6 @@ If your question is not answered below, please consider posting it to the [Reque
124111
</Accordion>
125112

126113
<Accordion title="Can I use Request Network requests even if I have my own payment infrastructure?">
127-
Yes. See [Single Request Forwarder](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/single-request-forwarder)
114+
Yes. See [Single Request Forwarder](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/single-request-forwarder).
128115
</Accordion>
129-
</AccordionGroup>
116+
</AccordionGroup>

glossary.mdx

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,7 @@
22
title: "Glossary"
33
---
44

5-
<Warning>
6-
**AI-Generated Content** – This page was generated with AI assistance and may contain inaccuracies. While likely close to accurate, please verify critical details with the [stable documentation](https://docs.request.network) or [contact support](https://github.com/orgs/RequestNetwork/discussions).
7-
</Warning>
8-
9-
## Parties of a Request
5+
## Parties of a Request
106

117
### Payee Identity
128

@@ -104,19 +100,19 @@ A payment network is generally related to one currency, but it's not always the
104100

105101
### Payment Reference
106102

107-
In the Reference-based Payment Networks, Payments are linked to Requests via a `paymentReference` which is derived from the `requestId` and payment recipient address. For details see [Payment Reference](https://docs.request.network/advanced/request-network-sdk/sdk-guides/request-client/payment-reference)
103+
In the Reference-based Payment Networks, Payments are linked to Requests via a `paymentReference` which is derived from the `requestId` and payment recipient address. For details see [SDK (Legacy)](/sdk-legacy/overview).
108104

109105
### Conversion Payment
110106

111-
A "conversion" request is denominated in one currency but paid in another currency. This is facilitated by on-chain price feeds provided by oracles. The typical use case is to denominate a request in fiat like USD and pay the request in stablecoins like USDC or DAI. For details see [Conversion Payment](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/conversion-request)
107+
A "conversion" request is denominated in one currency but paid in another currency. This is facilitated by on-chain price feeds provided by oracles. The typical use case is to denominate a request in fiat like USD and pay the request in stablecoins like USDC or DAI. For details see [Conversion Payments](/api-features/conversion-payments).
112108

113109
### Swap-to-pay Payment
114110

115-
A "swap-to-pay" payment is where the payment sender sends one currency but the payment recipient receives a different currency. For details see [Swap-to-Pay Payment](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/swap-to-pay-request)
111+
A "swap-to-pay" payment is where the payment sender sends one currency but the payment recipient receives a different currency. For details see [SDK (Legacy)](/sdk-legacy/overview).
116112

117113
### Swap-to-Conversion Payment
118114

119-
A "swap-to-conversion" payment is where the request is denominated in currency A, the payer sends currency B and the payee receives currency C. For details see [Swap-to-Conversion Payment](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/swap-to-conversion-request)
115+
A "swap-to-conversion" payment is where the request is denominated in currency A, the payer sends currency B and the payee receives currency C. For details see [SDK (Legacy)](/sdk-legacy/overview).
120116

121117
## Ecosystem
122118

@@ -154,4 +150,4 @@ Multi-signature (multisig) wallets allow multiple parties to require more than o
154150

155151
### Private Key
156152

157-
A private key is a large number that allows you to sign or decrypt messages. Private keys can be thought of as a password; private keys must never be revealed to anyone but you, as they allow you to spend the funds from your wallet through a cryptographic signature.
153+
A private key is a large number that allows you to sign or decrypt messages. Private keys can be thought of as a password; private keys must never be revealed to anyone but you, as they allow you to spend the funds from your wallet through a cryptographic signature.

0 commit comments

Comments
 (0)