feat(backend): rename "payment pointer" tables & columns to use "wall…

…et address" (#1937) Co-authored-by: Nathan Lie <[email protected]>
interledger · Oct 12, 2023 · 5e6377d · 5e6377d
1 parent 07cff89
commit 5e6377d
Show file tree

Hide file tree

Showing 17 changed files with 199 additions and 22 deletions.
diff --git a/packages/backend/migrations/20230918113102_rename_payment_pointer_tables.js b/packages/backend/migrations/20230918113102_rename_payment_pointer_tables.js
@@ -0,0 +1,177 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function (knex) {
+  return Promise.all([
+    knex.schema.renameTable('paymentPointers', 'walletAddresses'),
+    knex.schema.alterTable('walletAddresses', function (table) {
+      table.foreign(['assetId']).references('assets.id')
+      table.unique('url')
+    }),
+    knex.raw(
+      'ALTER INDEX "paymentPointers_pkey" RENAME TO "walletAddresses_pkey"'
+    ),
+    knex.raw(
+      'ALTER INDEX "paymentpointers_url_index" RENAME TO "walletaddresses_url_index"'
+    ),
+    knex.raw(
+      'ALTER INDEX "paymentpointers_processat_index" RENAME TO "walletaddresses_processat_index"'
+    ),
+    knex.raw(
+      'ALTER TABLE "walletAddresses" DROP CONSTRAINT "paymentpointers_url_unique"'
+    ),
+    knex.raw(
+      'ALTER TABLE "walletAddresses" DROP CONSTRAINT "paymentpointers_assetid_foreign"'
+    ),
+    knex.schema.renameTable('paymentPointerKeys', 'walletAddressKeys'),
+    knex.schema.alterTable('walletAddressKeys', function (table) {
+      table.renameColumn('paymentPointerId', 'walletAddressId')
+      table.foreign('walletAddressId').references('walletAddresses.id')
+    }),
+    knex.raw(
+      'ALTER INDEX "paymentPointerKeys_pkey" RENAME TO "walletAddressKeys_pkey"'
+    ),
+    knex.raw(
+      'ALTER TABLE "walletAddressKeys" DROP CONSTRAINT "paymentpointerkeys_paymentpointerid_foreign"'
+    ),
+    knex.schema.alterTable('quotes', function (table) {
+      table.dropForeign(['paymentPointerId'])
+      table.dropIndex(['paymentPointerId', 'createdAt', 'id'])
+      table.renameColumn('paymentPointerId', 'walletAddressId')
+      table.foreign('walletAddressId').references('walletAddresses.id')
+      table.index(['walletAddressId', 'createdAt', 'id'])
+    }),
+    knex.schema.alterTable('incomingPayments', function (table) {
+      table.dropForeign(['paymentPointerId'])
+      table.dropIndex(['paymentPointerId', 'createdAt', 'id'])
+      table.renameColumn('paymentPointerId', 'walletAddressId')
+      table.foreign('walletAddressId').references('walletAddresses.id')
+      table.index(['walletAddressId', 'createdAt', 'id'])
+    }),
+    knex.schema.alterTable('outgoingPayments', function (table) {
+      table.dropForeign(['paymentPointerId'])
+      table.dropIndex(['paymentPointerId', 'createdAt', 'id'])
+      table.renameColumn('paymentPointerId', 'walletAddressId')
+      table.foreign('walletAddressId').references('walletAddresses.id')
+      table.index(['walletAddressId', 'createdAt', 'id'])
+    }),
+    knex('webhookEvents')
+      .update({
+        // renames paymentPointer keys (if any) to walletAddress in data json column
+        data: knex.raw(
+          "data::jsonb - 'paymentPointer' || jsonb_build_object('walletAddress', data::jsonb->'paymentPointer')"
+        )
+      })
+      .whereRaw("data->'paymentPointer' is not null"),
+    knex('webhookEvents')
+      .update({
+        // renames paymentPointerId keys (if any) to walletAddressId in data json column
+        data: knex.raw(
+          "data::jsonb - 'paymentPointerId' || jsonb_build_object('walletAddressId', data::jsonb->'paymentPointerId')"
+        )
+      })
+      .whereRaw("data->'paymentPointerId' is not null"),
+    knex('webhookEvents')
+      .update({
+        // renames paymentPointerUrl keys (if any) to walletAddressUrl in data json column
+        data: knex.raw(
+          "data::jsonb - 'paymentPointerUrl' || jsonb_build_object('walletAddressUrl', data::jsonb->'paymentPointerUrl')"
+        )
+      })
+      .whereRaw("data->'paymentPointerUrl' is not null"),
+    knex('webhookEvents')
+      .update({
+        // renames payment_pointer.not_found values (if any) to wallet_address.not_found for type key in data json column
+        type: knex.raw("REPLACE(type, 'payment_pointer.', 'wallet_address.')")
+      })
+      .whereLike('type', 'payment_pointer%')
+  ])
+}
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function (knex) {
+  return Promise.all([
+    knex.schema.renameTable('walletAddresses', 'paymentPointers'),
+    knex.schema.alterTable('paymentPointers', function (table) {
+      table.foreign(['assetId']).references('assets.id')
+      table.unique('url')
+    }),
+    knex.raw(
+      'ALTER INDEX "walletAddresses_pkey" RENAME TO "paymentPointers_pkey"'
+    ),
+    knex.raw(
+      'ALTER INDEX "walletAddresses_url_index" RENAME TO "paymentPointers_url_index"'
+    ),
+    knex.raw(
+      'ALTER INDEX "walletaddresses_processat_index" RENAME TO "paymentpointers_processat_index"'
+    ),
+    knex.raw(
+      'ALTER TABLE "paymentPointers" DROP CONSTRAINT "walletaddresses_url_unique"'
+    ),
+    knex.raw(
+      'ALTER TABLE "paymentPointers" DROP CONSTRAINT "walletaddreses_assetid_foreign"'
+    ),
+    knex.schema.renameTable('walletAddressKeys', 'paymentPointerKeys'),
+    knex.schema.alterTable('paymentPointerKeys', function (table) {
+      table.renameColumn('walletAddressId', 'paymentPointerId')
+      table.foreign('paymentPointerId').references('paymentPointers.id')
+    }),
+    knex.raw(
+      'ALTER INDEX "walletAddressKeys_pkey" RENAME TO "paymentPointerKeys_pkey"'
+    ),
+    knex.raw(
+      'ALTER TABLE "paymentpointerKeys" DROP CONSTRAINT "walletaddresskeys_paymentpointerid_foreign"'
+    ),
+    knex.schema.alterTable('quotes', function (table) {
+      table.dropForeign(['walletAddressId'])
+      table.dropIndex(['walletAddressId', 'createdAt', 'id'])
+      table.renameColumn('walletAddressId', 'paymentPointerId')
+      table.foreign('paymentPointerId').references('paymentPointers.id')
+      table.index(['paymentPointerId', 'createdAt', 'id'])
+    }),
+    knex.schema.alterTable('incomingPayments', function (table) {
+      table.dropForeign(['walletAddressId'])
+      table.dropIndex(['walletAddressId', 'createdAt', 'id'])
+      table.renameColumn('walletAddressId', 'paymentPointerId')
+      table.foreign('paymentPointerId').references('paymentPointers.id')
+      table.index(['paymentPointerId', 'createdAt', 'id'])
+    }),
+    knex.schema.alterTable('outgoingPayments', function (table) {
+      table.dropForeign(['walletAddressId'])
+      table.dropIndex(['walletAddressId', 'createdAt', 'id'])
+      table.renameColumn('walletAddressId', 'paymentPointerId')
+      table.foreign('paymentPointerId').references('paymentPointers.id')
+      table.index(['paymentPointerId', 'createdAt', 'id'])
+    }),
+    knex('webhookEvents')
+      .update({
+        data: knex.raw(
+          "data::jsonb - 'walletAddress' || jsonb_build_object('paymentPointer', data::jsonb->'walletAddress')"
+        )
+      })
+      .whereRaw("data->'walletAddress' is not null"),
+    knex('webhookEvents')
+      .update({
+        data: knex.raw(
+          "data::jsonb - 'walletAddressId' || jsonb_build_object('paymentPointerId', data::jsonb->'walletAddressId')"
+        )
+      })
+      .whereRaw("data->'walletAddressId' is not null"),
+    knex('webhookEvents')
+      .update({
+        data: knex.raw(
+          "data::jsonb - 'walletAddressUrl' || jsonb_build_object('paymentPointerUrl', data::jsonb->'walletAddressUrl')"
+        )
+      })
+      .whereRaw("data->'walletAddressUrl' is not null"),
+    knex('webhookEvents')
+      .update({
+        type: knex.raw("REPLACE(type, 'wallet_address.', 'payment_pointer.')")
+      })
+      .whereLike('type', 'wallet_address%')
+  ])
+}
diff --git a/packages/backend/src/graphql/resolvers/combined_payments.test.ts b/packages/backend/src/graphql/resolvers/combined_payments.test.ts
@@ -115,7 +115,7 @@ describe('Payment', (): void => {
       id: combinedOutgoingPayment.id,
       type: combinedOutgoingPayment.type,
       metadata: combinedOutgoingPayment.metadata,
-      paymentPointerId: combinedOutgoingPayment.paymentPointerId,
+      paymentPointerId: combinedOutgoingPayment.walletAddressId,
       state: combinedOutgoingPayment.state,
       createdAt: combinedOutgoingPayment.createdAt.toISOString()
     })

diff --git a/packages/backend/src/graphql/resolvers/combined_payments.ts b/packages/backend/src/graphql/resolvers/combined_payments.ts
@@ -40,7 +40,7 @@ function paymentToGraphql(payment: CombinedPayment): SchemaPayment {
     id: payment.id,
     type: payment.type,
     state: payment.state,
-    paymentPointerId: payment.paymentPointerId,
+    paymentPointerId: payment.walletAddressId,
     metadata: payment.metadata,
     createdAt: new Date(payment.createdAt).toISOString(),
     __typename: 'Payment'

diff --git a/packages/backend/src/graphql/resolvers/incoming_payment.ts b/packages/backend/src/graphql/resolvers/incoming_payment.ts
@@ -106,7 +106,7 @@ export function paymentToGraphql(
 ): SchemaIncomingPayment {
   return {
     id: payment.id,
-    paymentPointerId: payment.paymentPointerId,
+    paymentPointerId: payment.walletAddressId,
     state: payment.state,
     expiresAt: payment.expiresAt.toISOString(),
     incomingAmount: payment.incomingAmount,

diff --git a/packages/backend/src/graphql/resolvers/outgoing_payment.ts b/packages/backend/src/graphql/resolvers/outgoing_payment.ts
@@ -98,7 +98,7 @@ export function paymentToGraphql(
 ): SchemaOutgoingPayment {
   return {
     id: payment.id,
-    paymentPointerId: payment.paymentPointerId,
+    paymentPointerId: payment.walletAddressId,
     state: payment.state,
     error: payment.error,
     stateAttempts: payment.stateAttempts,

diff --git a/packages/backend/src/graphql/resolvers/quote.ts b/packages/backend/src/graphql/resolvers/quote.ts
@@ -90,7 +90,7 @@ export const getPaymentPointerQuotes: PaymentPointerResolvers<ApolloContext>['qu
 export function quoteToGraphql(quote: Quote): SchemaQuote {
   return {
     id: quote.id,
-    paymentPointerId: quote.paymentPointerId,
+    paymentPointerId: quote.walletAddressId,
     receiver: quote.receiver,
     debitAmount: quote.debitAmount,
     receiveAmount: quote.receiveAmount,

diff --git a/packages/backend/src/open_payments/payment/combined/model.ts b/packages/backend/src/open_payments/payment/combined/model.ts
@@ -19,7 +19,7 @@ export class CombinedPayment extends PaginationModel {
   // common to both incoming and outgoing payments
   public id!: string
   public state!: OutgoingPaymentState | IncomingPaymentState
-  public paymentPointerId!: string
+  public walletAddressId!: string
   public metadata?: Record<string, unknown>
   public client?: string
   public createdAt!: Date

diff --git a/packages/backend/src/open_payments/payment/incoming/model.ts b/packages/backend/src/open_payments/payment/incoming/model.ts
@@ -168,7 +168,7 @@ export class IncomingPayment
     const data: IncomingPaymentData = {
       incomingPayment: {
         id: this.id,
-        paymentPointerId: this.paymentPointerId,
+        paymentPointerId: this.walletAddressId,
         createdAt: new Date(+this.createdAt).toISOString(),
         expiresAt: this.expiresAt.toISOString(),
         receivedAmount: {

diff --git a/packages/backend/src/open_payments/payment/incoming/service.ts b/packages/backend/src/open_payments/payment/incoming/service.ts
@@ -132,7 +132,7 @@ async function createIncomingPayment(
   }
   const incomingPayment = await IncomingPayment.query(trx || deps.knex)
     .insertAndFetch({
-      paymentPointerId,
+      walletAddressId: paymentPointerId,
       client,
       assetId: paymentPointer.asset.id,
       expiresAt,

diff --git a/packages/backend/src/open_payments/payment/outgoing/model.ts b/packages/backend/src/open_payments/payment/outgoing/model.ts
@@ -119,7 +119,7 @@ export class OutgoingPayment
     const data: PaymentData = {
       payment: {
         id: this.id,
-        paymentPointerId: this.paymentPointerId,
+        paymentPointerId: this.walletAddressId,
         state: this.state,
         receiver: this.receiver,
         debitAmount: {

diff --git a/packages/backend/src/open_payments/payment/outgoing/service.ts b/packages/backend/src/open_payments/payment/outgoing/service.ts
@@ -124,7 +124,7 @@ async function createOutgoingPayment(
       const payment = await OutgoingPayment.query(trx)
         .insertAndFetch({
           id: options.quoteId,
-          paymentPointerId,
+          walletAddressId: paymentPointerId,
           metadata: options.metadata,
           state: OutgoingPaymentState.Funding,
           client: options.client,
@@ -133,7 +133,7 @@ async function createOutgoingPayment(
         .withGraphFetched('[quote.asset]')
 
       if (
-        payment.paymentPointerId !== payment.quote.paymentPointerId ||
+        payment.walletAddressId !== payment.quote.walletAddressId ||
         payment.quote.expiresAt.getTime() <= payment.createdAt.getTime()
       ) {
         throw OutgoingPaymentError.InvalidQuote

diff --git a/packages/backend/src/open_payments/payment_pointer/key/model.ts b/packages/backend/src/open_payments/payment_pointer/key/model.ts
@@ -5,7 +5,7 @@ import { Pojo } from 'objection'
 
 export class PaymentPointerKey extends BaseModel {
   public static get tableName(): string {
-    return 'paymentPointerKeys'
+    return 'walletAddressKeys'
   }
 
   public id!: string

diff --git a/packages/backend/src/open_payments/payment_pointer/model.ts b/packages/backend/src/open_payments/payment_pointer/model.ts
@@ -12,24 +12,24 @@ export class PaymentPointer
   implements ConnectorAccount, LiquidityAccount
 {
   public static get tableName(): string {
-    return 'paymentPointers'
+    return 'walletAddresses'
   }
 
   static relationMappings = () => ({
     asset: {
       relation: Model.HasOneRelation,
       modelClass: Asset,
       join: {
-        from: 'paymentPointers.assetId',
+        from: 'walletAddresses.assetId',
         to: 'assets.id'
       }
     },
     keys: {
       relation: Model.HasManyRelation,
       modelClass: PaymentPointerKey,
       join: {
-        from: 'paymentPointers.id',
-        to: 'paymentPointerKeys.paymentPointerId'
+        from: 'walletAddresses.id',
+        to: 'walletAddressKeys.paymentPointerId'
       }
     }
   })
@@ -175,7 +175,7 @@ class SubresourceQueryBuilder<
 export abstract class PaymentPointerSubresource extends BaseModel {
   public static readonly urlPath: string
 
-  public readonly paymentPointerId!: string
+  public readonly walletAddressId!: string
   public paymentPointer?: PaymentPointer
 
   public abstract readonly assetId: string
@@ -190,7 +190,7 @@ export abstract class PaymentPointerSubresource extends BaseModel {
         modelClass: PaymentPointer,
         join: {
           from: `${this.tableName}.paymentPointerId`,
-          to: 'paymentPointers.id'
+          to: 'walletAddresses.id'
         }
       }
     }

diff --git a/packages/backend/src/open_payments/quote/model.ts b/packages/backend/src/open_payments/quote/model.ts
@@ -156,7 +156,7 @@ export class Quote extends PaymentPointerSubresource {
     json = super.$formatJson(json)
     return {
       id: json.id,
-      paymentPointerId: json.paymentPointerId,
+      paymentPointerId: json.walletAddressId,
       receiver: json.receiver,
       debitAmount: {
         ...json.debitAmount,

diff --git a/packages/backend/src/open_payments/quote/service.ts b/packages/backend/src/open_payments/quote/service.ts
@@ -123,7 +123,7 @@ async function createQuote(
     return await Quote.transaction(deps.knex, async (trx) => {
       const createdQuote = await Quote.query(trx)
         .insertAndFetch({
-          paymentPointerId: options.paymentPointerId,
+          walletAddressId: options.paymentPointerId,
           assetId: paymentPointer.assetId,
           receiver: options.receiver,
           debitAmount: quote.debitAmount,

diff --git a/packages/backend/src/tests/combinedPayment.ts b/packages/backend/src/tests/combinedPayment.ts
@@ -20,7 +20,7 @@ export function toCombinedPayment(
   return CombinedPayment.fromJson({
     type,
     id: payment.id,
-    paymentPointerId: payment.paymentPointerId,
+    paymentPointerId: payment.walletAddressId,
     state: payment.state,
     metadata: payment.metadata,
     client: payment.client,

diff --git a/packages/backend/src/tests/quote.ts b/packages/backend/src/tests/quote.ts
@@ -155,7 +155,7 @@ export async function createQuote(
 
   return await Quote.query()
     .insertAndFetch({
-      paymentPointerId,
+      walletAddressId: paymentPointerId,
       assetId: paymentPointer.assetId,
       receiver: receiverUrl,
       debitAmount,