chore: payment flow restructure #37

ionutanin · 2023-12-06T12:29:26Z

update payment flow
move payment methods into separate files in preparation to apply unit tests
remove unused files and code

… unit test, remove unused code files

raducristianpopa

We do not have types at all. What's your opinion about fetching the OpenAPI schemas from the Open Payments repository and generating the types from them?
We should probably move from Axios to the Fetch API or find a way to use the OP SDK
I think that whole flow is too granular (split into too many files)

raducristianpopa · 2023-12-06T12:42:55Z

src/background/grant/confirmPayment.ts

+            if (tabId === tab.id && changeInfo.url?.includes('interact_ref')) {
+              const interactRef = changeInfo.url.split('interact_ref=')[1]
+              tabs.update(currentTabId, { active: true })
+              tabs.remove(tab.id)
+              resolve(interactRef)


Might be better to use the URL object so we can also validate the URL. This way we can avoid using split or includes and take advantage of searchParams.get from the URL object to retrieve the interaction reference.

raducristianpopa · 2023-12-07T06:52:26Z

src/background/grant/createQuote.ts

+export const createQuote = async (
+  receiver: string,
+  walletAddress: string,
+  sendingUrl: string,
+  token: string,
+  instance: AxiosInstance,
+) => {


We should use an object as a single parameter for functions that have more than 2 parameters.

raducristianpopa · 2023-12-07T06:56:33Z

src/background/grant/createQuote.ts

+    receiver,
+    walletAddress,
+    debitAmount: {
+      value: '1000000', // 0.001 USD


The amount value will need to be calculated based on the hourly rate, which the user has control on. Can the amount value be passed as a parameter. Ideally we should now the exact value before quoting (storing it somewhere) so we won't have to recalculate it every time.

raducristianpopa · 2023-12-07T06:58:00Z

src/background/grant/createQuote.ts

+      assetCode: 'USD',
+      assetScale: 9,


Asset information needs to be fetched from the sender's wallet address. Since we have a setup/on-boarding step we probably can save these values somewhere.

raducristianpopa · 2023-12-07T06:58:45Z

src/background/grant/getContinuationRequest.ts

+export const getContinuationRequest = async (
+  url: string,
+  interactRef: string,
+  token: string,
+  instance: AxiosInstance,
+) => {


Ditto above:

We should use an object as a single parameter for functions that have more than 2 parameters.

raducristianpopa · 2023-12-07T07:00:11Z

src/background/grant/getOutgoingPaymentGrant.ts

+export const getOutgoingPaymentGrant = async (
+  client: string,
+  identifier: string,
+  wallet: Record<string, any>,
+  amount: string | number,
+  instance: AxiosInstance,
+) => {


Ditto above

raducristianpopa · 2023-12-07T07:00:44Z

src/background/grant/getOutgoingPaymentGrant.ts

+      access: [
+        {
+          type: 'outgoing-payment',
+          actions: ['list', 'list-all', 'read', 'read-all', 'create'],


Suggested change

actions: ['list', 'list-all', 'read', 'read-all', 'create'],

actions: ['list', 'read', 'create'],

raducristianpopa · 2023-12-07T07:01:31Z

src/background/grant/getOutgoingPaymentGrant.ts

+              value: String(Number(amount) * 10 ** 9), // '1000000000',
+              assetScale: 9,
+              assetCode: 'USD',


Ditto above (the asset information).

raducristianpopa · 2023-12-07T07:02:13Z

src/background/grant/getQuoteGrant.ts

+export const getQuoteGrant = async (
+  client: string,
+  identifier: string,
+  wallet: Record<string, any>,
+  instance: AxiosInstance,
+): Promise<string> => {


Ditto above.

raducristianpopa · 2023-12-07T07:02:29Z

src/background/grant/rotateToken.ts

+
+import { getHeaders } from '@/background/grant/getHeaders'
+
+export const rotateToken = async (url: string, token: string, instance: AxiosInstance) => {


Ditto above.

raducristianpopa · 2023-12-12T15:32:24Z

Extension builds preview

Name	Link
Latest commit	`7aa860e`
Latest job logs	Run #7447027580
	Download
	Download
	Download
	Download

…ion into chore/payment-flow-restructure

raducristianpopa · 2023-12-14T07:41:56Z

src/background/grant/createQuote.ts

+
+type TCreateQuote = (_params: {
+  receiver: string
+  walletAddress: any


What actually gets passed in here? Let's avoid using any and create some small types until we decide how we should use the OpenAPI types.

raducristianpopa · 2023-12-14T07:42:13Z

src/background/grant/createQuote.ts

+  token: string
+  amount: string
+  instance: AxiosInstance
+}) => Promise<any>


Suggested change

}) => Promise<any>

}) => Promise<string>

raducristianpopa · 2023-12-14T07:42:22Z

src/background/grant/getContinuationRequest.ts

+
+type TGetContinuationRequest = (_params: {
+  url: string
+  interactRef: any


Suggested change

interactRef: any

interactRef: string

raducristianpopa · 2023-12-14T07:42:34Z

src/background/grant/getContinuationRequest.ts

+  interactRef: any
+  token: string
+  instance: AxiosInstance
+}) => Promise<any>


Let's type the response.

raducristianpopa · 2023-12-14T07:43:14Z

src/background/grant/getIcomingPaymentGrant.ts

+type TGetIncomingPaymentGrant = (_params: {
+  client: string
+  identifier: string
+  wallet: Record<string, any>


Ditto above.

raducristianpopa · 2023-12-14T07:43:31Z

src/background/grant/getIncomingPaymentUrlId.ts

+  walletAddress: string
+  token: string
+  instance: AxiosInstance
+}) => Promise<any>


Ditto above.

raducristianpopa · 2023-12-14T07:43:47Z

src/background/grant/getOutgoingPaymentGrant.ts

+type TGetOutgoingPaymentGrant = (_params: {
+  client: string
+  identifier: string
+  wallet: Record<string, any>


Ditto above.

raducristianpopa · 2023-12-14T07:43:54Z

src/background/grant/getOutgoingPaymentGrant.ts

+  wallet: Record<string, any>
+  amount: string | number
+  instance: AxiosInstance
+}) => Promise<any>


Ditto above.

raducristianpopa · 2023-12-14T07:44:06Z

src/background/grant/getQuoteGrant.ts

+  wallet: Record<string, any>
+  instance: AxiosInstance
+}) => Promise<any>


Ditto above.

raducristianpopa · 2023-12-14T07:44:16Z

src/background/grant/rotateToken.ts

+  url: string
+  token: string
+  instance: AxiosInstance
+}) => Promise<any>


Ditto above.

update payment flow, restructure into different files and prepare for…

6cc1bba

… unit test, remove unused code files

ionutanin added the enhancement New feature or request label Dec 6, 2023

ionutanin requested review from AlexLakatos, dianafulga and raducristianpopa December 6, 2023 12:29

ionutanin self-assigned this Dec 6, 2023

ionutanin linked an issue Dec 6, 2023 that may be closed by this pull request

Code cleaning and move all api methods into its own file (like in rafiki) #28

Closed

ionutanin changed the title ~~Payment flow restructure~~ chore: payment flow restructure Dec 6, 2023

remove console.log - move rotateToken

c9450fe

raducristianpopa reviewed Dec 7, 2023

View reviewed changes

chore: code review updates

88e090b

github-actions bot added the area: background Improvements or additions to extension background script label Dec 12, 2023

Merge branch 'main' of github.com:interledger/web-monetization-extens…

c3564cb

…ion into chore/payment-flow-restructure

raducristianpopa reviewed Dec 14, 2023

View reviewed changes

chore: rebase with main branch

7aa860e

raducristianpopa approved these changes Jan 8, 2024

View reviewed changes

raducristianpopa merged commit 4aa460a into main Jan 8, 2024
9 checks passed

raducristianpopa deleted the chore/payment-flow-restructure branch January 8, 2024 14:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: payment flow restructure #37

chore: payment flow restructure #37

ionutanin commented Dec 6, 2023

raducristianpopa left a comment •

edited

Loading

raducristianpopa Dec 6, 2023

raducristianpopa Dec 7, 2023

raducristianpopa Dec 7, 2023

raducristianpopa Dec 7, 2023

raducristianpopa Dec 7, 2023

raducristianpopa Dec 7, 2023

raducristianpopa Dec 7, 2023

raducristianpopa Dec 7, 2023

raducristianpopa Dec 7, 2023

raducristianpopa Dec 7, 2023

raducristianpopa commented Dec 12, 2023 •

edited

Loading

raducristianpopa Dec 14, 2023

raducristianpopa Dec 14, 2023

raducristianpopa Dec 14, 2023

raducristianpopa Dec 14, 2023

raducristianpopa Dec 14, 2023

raducristianpopa Dec 14, 2023

raducristianpopa Dec 14, 2023

raducristianpopa Dec 14, 2023

raducristianpopa Dec 14, 2023

raducristianpopa Dec 14, 2023

	actions: ['list', 'list-all', 'read', 'read-all', 'create'],
	actions: ['list', 'read', 'create'],


		import { getHeaders } from '@/background/grant/getHeaders'

		export const rotateToken = async (url: string, token: string, instance: AxiosInstance) => {

chore: payment flow restructure #37

chore: payment flow restructure #37

Conversation

ionutanin commented Dec 6, 2023

raducristianpopa left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raducristianpopa commented Dec 12, 2023 • edited Loading

Extension builds preview

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raducristianpopa left a comment •

edited

Loading

raducristianpopa commented Dec 12, 2023 •

edited

Loading