Add sagas for OnRamp to AUDIO by rickyrombo · Pull Request #1666 · AudiusProject/audius-client

rickyrombo · 2022-08-02T19:43:17Z

Description

Supercedes:

[PAY-456] Add sagas for exchanging SOL to AUDIO #1651

Main updates:

Quotes and exchanges aren't directly done via actions but instead are replaced by specific routines. Instead separate quote actions for USDC and SOL, there is one action that provides purchaseInfo, strictly information regarding the purchase of SOL for a SOL => AUDIO transaction with an estimate for how much that costs in USD (using a quote from that amount of SOL to USD.
- This allows for us to build in padding into the quote for:
  - Transaction Fees: we call the computeRoutes on Jupiter to get the swap transactions, then compile them and get associated fees via Solana's API (this is generally a constant per transaction of 0.000005 SOL, although the Jupiter transactions can vary from 1-3 depending on how large the swap transaction gets)
  - Associated Token Account (ATA) rent exemption fees: Once we have the route from Jupiter, we also have the intermediate tokens needed for the swap. We check for an existing ATA on the user's wallet for each token, and if not present, we add the rent exemption minimum (calculated by calling the Solana method with 165 bytes) to the quote to cover that fee.
  - Slippage: To help ensure that the user does not end up with less $AUDIO than the whole number they specified, we preemptively pad the quote such that if the slippage were to bottom out (ie if slippage tolerance is set to 3% and the price slips 3%), the user would still get the expected amount of $AUDIO.
    - Slight dragon here: The quote used to generate the amount of SOL to purchase is different than the quote used to exchange that SOL for AUDIO. The price could drop more than the slippage tolerance due to this and still successfully exchange (since the first quote is separate from the second, and the second quote might have a lower AUDIO amount than the first), and the user might end up with less AUDIO. In practice, this is unlikely with a high slippage tolerance + this adjustment. A good side-effect from this is that users won't see any swap failures due to slippage, which is far worse than receiving less AUDIO.
Likewise, instead of an action for directly executing an exchange, the exchange is wrapped up in a saga that gets triggered on an OnRamp completion.
I added polling on wallet balances and extracted some of the pieces to the BuyAudio.ts audius-backend file
There's now a much more easily followed BuyAudioStage enum that indicates where in the flow we are (eg. are we waiting on the user to purchase SOL? For coinbase pay's funds to show up in the wallet? For the swap to complete?)

Dragons

Is there anything the reviewer should be on the lookout for? Are there any dangerous changes?

I used Solana's API to get the real fees and ATA rent exemption minimums. This means I can do so exactly requiring no buffer amount, but I still think I might add a slight buffer amount just to be sure we don't fail due to some arithmetic rounding error or something.
Speaking of arithmetic, there's a lot of different conversions happening - there's JSBI which is used by Jupiter, there's BN which is what we use, there's u64 which is what some Solana stuff uses now (a wrapper around BN that annoyingly is lowercased so doing new u64(..) triggers our linter), and there's number which is also used by Solana. I've mixed returning SOL and lamports in this PR to some degree... could use another pass on cleaning that up probably. Ideally I'd do everything in some sort of big int type to avoid any potential float precision stuff.
Not super dragony, but mildly infuriating: We have all sorts of different conversions in the wallet utils for different things, but they all have wildly different naming conventions and uses. These conversions could use some love...

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide repro instructions & any configuration.

Tested E2E using a prototype BuyAudio modal as well as just by triggering sagas manually and using a phantom wallet. I also closed all my ATAs and ran it again to see the ATA fee estimate get higher and lower depending on if it was my first or second time onramping. So far have not seen any "Insufficient funds" errors.

How will this change be monitored?

For features that are critical or could fail silently please describe the monitoring/alerting being added.

TODO: Add amplitude monitoring.
- [PAY-540] Add analytics to buy audio flow #1673

Feature Flags

Are all new features properly feature flagged? Describe added feature flags.

TODO: Add optimizely flags. (Although in the current state it's dead code)

…ruction generation to AudiusBackend, used typed version of AudiusBackend

…action

Rewrites the buy-audio sagas to make them more coherent with the actual task at hand. With the previous design, it was difficult to add the proper calculations to ensure a successful transaction due to the disconnection between the USDC quote and the SOL quote. Now, w

piazzatron

Epic PR! Really just a few minor things - let's get this merged and test the heck out of it 🚀

piazzatron · 2022-08-10T20:27:06Z

+      state.feesCache = initialState.feesCache
+    },
+    restart: (state) => {
+      state.stage = BuyAudioStage.START


Do we need to restart the purchaseInfoStatus with these stage transitions? If so, would modeling these as a discrimated union help?

piazzatron · 2022-08-10T20:28:44Z

  DeletePlaylistConfirmation: false,
-  FeatureFlagOverride: false
+  FeatureFlagOverride: false,
+  BuyAudio: true


Any reason this is true by default?

testing purposes 😅 (shouldn't even be in here oops)

piazzatron · 2022-08-10T20:44:12Z

+ * Gets a quote from Jupiter for an exchange from inputTokenSymbol => outputTokenSymbol
+ * @returns the best quote including the RouteInfo
+ */
+function* getQuote({


Maybe getQuote should take jup in as an argument to make this easier to test? Another approach would be to have a class encapsulating Jupiter and exposing this as a method on the class, but don't feel super strongly.

piazzatron · 2022-08-10T20:53:29Z

+    )
+
+    const estimatedLamports =
+      inSol + associatedAccountCreationFees + transactionFees - existingBalance


Safe to do this not using BN/JSBI?

piazzatron · 2022-08-10T20:56:46Z

+export const getRootSolanaAccount = async () => {
+  await waitForLibsInit()
+  return libs().solanaWeb3Manager.solanaWeb3.Keypair.fromSeed(
+    libs().Account.hedgehog.wallet.getPrivateKey()
+  ) as Keypair
+}
+
+export const getSolanaConnection = async () => {
+  await waitForLibsInit()
+  return libs().solanaWeb3Manager.connection as Connection
+}


A few of these feel like general Solana utils rather than something that belongs specifically in BuyAudio.ts to me

yeah where should those live?

Maybe /services/audius-backend/Solana.ts?

piazzatron · 2022-08-10T21:00:09Z

+  return tokenAccountInfo
+}
+
+export const pollForAudioBalanceChange = async ({


Maybe include a comment that this throws (do we want it to throw?)

gitguardian · 2022-08-11T21:48:01Z

⚠️ GitGuardian has uncovered 17 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	Secret	Commit	Filename
688750	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.dev.tmpl	View secret
2416684	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.dev.tmpl	View secret
2416685	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.dev.tmpl	View secret
2416686	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.dev.tmpl	View secret
2858199	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.dev.tmpl	View secret
688750	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.prod.tmpl	View secret
2460749	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.prod.tmpl	View secret
2460750	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.prod.tmpl	View secret
2460751	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.prod.tmpl	View secret
1606949	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.prod.tmpl	View secret
2111319	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.prod.tmpl	View secret
2858198	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.prod.tmpl	View secret
688750	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.stage.tmpl	View secret
2416684	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.stage.tmpl	View secret
2416685	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.stage.tmpl	View secret
2416686	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.stage.tmpl	View secret
2858199	Generic High Entropy Secret	`ad9d272`	packages/mobile/.env.stage.tmpl	View secret

🛠 Guidelines to remediate hardcoded secrets

Understand the implications of revoking this secret by investigating where it is used in your code.
Replace and store your secrets safely. Learn here the best practices.
Revoke and rotate these secrets.
If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

following these best practices for managing and storing secrets including API keys and other credentials
install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!}

audius-infra · 2022-08-12T21:54:50Z

Preview this change https://demo.audius.co/mjp-cb-onramp-sagas-v2

[0d2f211] [C-826] Move remote-config-instance to saga context (#1713) Dylan Jeffers [bcd68c7] Add sagas for OnRamp to AUDIO (#1666) Marcus Pasell [1ca2af2] Prevent showing file explorer on pressing enter (#1704) Saliou Diallo [0b6f0e4] [PAY-521] Add web dethroned notification (#1712) Michael Piazza [76b1b0e] [C-820] Move apiClient into saga context, Add WalletClient to context (#1711) Dylan Jeffers [2706cef] [C-807] Move audiusBackendInstance into context across all sagas (#1710) Dylan Jeffers [25c9433] [PAY-466] Display AAO emoji errors for failed reward claims (#1693) Reed [c2a79ff] [C-808] Don't show unnecessarily show profile option on overflow menu (#1708) Dylan Jeffers [94e188f] [C-801] Add tag search text to mobile (#1706) Dylan Jeffers [a47c2e2] [C-806] Prevent multiple overflow menus at a time (#1698) Saliou Diallo [dce8a58] [C-797] Fix track-remix-screen text color (#1705) Dylan Jeffers [1325829] Add extends null (#1707) Sebastian Klingler [51e38d6] [C-805] Fix artifact on small card (#1696) Raymond Jacobson [0a521b1] [C-798] Remove owned/created stamp from collectible tile (#1689) Sebastian Klingler [18ae0a0] [C-804] Show playlist count for non-artists in native (#1697) Dylan Jeffers [ffcf0da] Fix associated wallets (#1692) Raymond Jacobson [e287fb1] [PAY-267, C-753] Remove tipping feature flags, Fix mutuals icon (#1695) Dylan Jeffers [118102d] [C-794] Add typecheck to web ci (#1694) Sebastian Klingler [4f60a49] [C-803] Add common state and backend sagas to native (#1691) Dylan Jeffers [96d9cc8] [C-800] Add native saga context and update common sagas (#1690) Dylan Jeffers [12add4a] [C-799] Add saga context, refactor backend state (#1688) Dylan Jeffers [afdbe97] [C-796] Refactor AudiusAPIClient to work in native context (#1687) Dylan Jeffers [a185c09] [C-795] Fix user-list tag imports (#1686) Dylan Jeffers [3a8704c] [C-774] Move audius-backend to common, add native libs-instance (#1685) Dylan Jeffers

rickyrombo added 17 commits July 27, 2022 00:37

Add sagas for onramp

2ac300c

Use Audius RPC and remove retry logic for RPCs, extract transfer inst…

e8ef300

…ruction generation to AudiusBackend, used typed version of AudiusBackend

amend last commit

303600d

Move convertWAudioToWei to wallet utils

f65ee6f

Throw error if slippage too high

9861956

Make payloads better named, add output amount to successful exchange …

f558cc9

…action

Clean up state, separate quotes and exchange statuses

6b3f2cf

Better typing

8fe4a1b

Added comments

7a1226d

Ensure cleanup transaction is sent even if swap transaction fails

0060539

Pin versions

fcc026e

Throw before exchanging if userbank does not exist

0f3fe46

Add retries to polling for token account creation

d18fcf4

Use object args and async method

b9e4646

Make Stage better named, remove extraneous state

cc47eff

Move some stuff around and rename

96de7ae

pull-request-size Bot added the size/XXL label Aug 2, 2022

rickyrombo changed the base branch from main to mjp-cb-onramp-sagas August 4, 2022 19:17

rickyrombo changed the base branch from mjp-cb-onramp-sagas to main August 10, 2022 20:18

rickyrombo marked this pull request as ready for review August 10, 2022 21:33

piazzatron approved these changes Aug 10, 2022

View reviewed changes

Merge remote-tracking branch 'origin/main' into mjp-cb-onramp-sagas-v2

ad9d272

rickyrombo added 6 commits August 12, 2022 09:46

Bad merge

6920e97

Default to modal hidden

500df60

Add some min padding

f4b912a

Fix type error

61f1e56

Update peer dep for spl-token to 0.1.8

b3438e9

Bump sdk version to v0.0.34

82e8cd9

rickyrombo merged commit bcd68c7 into main Aug 12, 2022

rickyrombo deleted the mjp-cb-onramp-sagas-v2 branch August 12, 2022 22:33

rickyrombo mentioned this pull request Aug 16, 2022

[PAY-456] Add sagas for exchanging SOL to AUDIO #1651

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add sagas for OnRamp to AUDIO#1666

Add sagas for OnRamp to AUDIO#1666
rickyrombo merged 24 commits into
mainfrom
mjp-cb-onramp-sagas-v2

rickyrombo commented Aug 2, 2022 •

edited

Loading

Uh oh!

piazzatron left a comment

Uh oh!

piazzatron Aug 10, 2022

Uh oh!

piazzatron Aug 10, 2022

Uh oh!

rickyrombo Aug 10, 2022

Uh oh!

piazzatron Aug 10, 2022

Uh oh!

piazzatron Aug 10, 2022

Uh oh!

piazzatron Aug 10, 2022

Uh oh!

rickyrombo Aug 10, 2022

Uh oh!

piazzatron Aug 10, 2022

Uh oh!

piazzatron Aug 10, 2022

Uh oh!

gitguardian Bot commented Aug 11, 2022 •

edited

Loading

Uh oh!

audius-infra commented Aug 12, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

rickyrombo commented Aug 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Dragons

How Has This Been Tested?

How will this change be monitored?

Feature Flags

Uh oh!

piazzatron left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gitguardian Bot commented Aug 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ GitGuardian has uncovered 17 secrets following the scan of your pull request.

Uh oh!

audius-infra commented Aug 12, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rickyrombo commented Aug 2, 2022 •

edited

Loading

gitguardian Bot commented Aug 11, 2022 •

edited

Loading