Add disclaimer about address_pool_gap address discovery in API doc #2924
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
specifications/api/swagger.yaml
Outdated
| @@ -898,6 +898,10 @@ x-walletAddressPoolGap: &walletAddressPoolGap | |||
|
|
|||
| Beside, using large gaps is **not recommended** as it may induce important performance degradations. Use at your own risks. | |||
|
|
|||
| **IMPORTANT DISCLAIMER 2:** There is no way to `import` addresses generated outside (e.g. using cardano-addresses) into the wallet. | |||
| Wallet only discovers transactions on its used and unused addresses that are within its currently seen `address_pool_gap`. | |||
| Transactions on addresses that "belong" to the wallet but happen to be beyond its `address_pool_gap` will not be visible on the wallet. See: [CIP-1852](https://github.com/cardano-foundation/CIPs/blob/master/CIP-1852/CIP-1852.md). | |||
There was a problem hiding this comment.
Suggested change
| Transactions on addresses that "belong" to the wallet but happen to be beyond its `address_pool_gap` will not be visible on the wallet. See: [CIP-1852](https://github.com/cardano-foundation/CIPs/blob/master/CIP-1852/CIP-1852.md). | |
| Transactions on addresses that "belong" to the wallet but happen to be beyond its `address_pool_gap` will not be visible to the wallet. | |
| This is a technical limitation of the industry standard [BIP-44][]. See also [CIP-1852][] | |
| [cip-1852]: https://github.com/cardano-foundation/CIPs/blob/master/CIP-1852/CIP-1852.md | |
| [bip-44]: https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki |
I suggest that we mention that it's "not our fault" by referring to an "industry standard". 😅
HeinrichApfelmus
approved these changes
Sep 27, 2021
piotr-iohk
force-pushed
the
piotr/add-address-pool-gap-warning
branch
from
c5fddc1 to
c35691b
Compare
|
bors r+ |
|
Build succeeded: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Comments
Adding this note on recommendation from Jide, who's saying that many partners are trying to generate addresses with cardano-address and than looking into importing them into Shelley wallets. We also had some questions about this on GH recently.
Issue Number