feat: liquidity webhooks

localenv/cloud-nine-wallet/seed.yml

@@ -7,16 +7,20 @@ assets:
   - code: USD
     scale: 2
     liquidity: 1000000
+    liquidityThreshold: 100000
   - code: EUR
     scale: 2
     liquidity: 1000000
+    liquidityThreshold: 100000
   - code: MXN
     scale: 2
     liquidity: 1000000
+    liquidityThreshold: 100000
 peers:
   - initialLiquidity: '100000'
     peerUrl: http://happy-life-bank-backend:3002
     peerIlpAddress: test.happy-life-bank
+    liquidityThreshold: 10000
 accounts:
   - name: 'Grace Franklin'
     path: accounts/gfranklin

localenv/happy-life-bank/seed.yml

@@ -7,16 +7,20 @@ assets:
   - code: USD
     scale: 2
     liquidity: 1000000
+    liquidityThreshold: 100000
   - code: EUR
     scale: 2
     liquidity: 1000000
+    liquidityThreshold: 100000
   - code: MXN
     scale: 2
     liquidity: 1000000
+    liquidityThreshold: 100000
 peers:
   - initialLiquidity: '1000000000000'
     peerUrl: http://cloud-nine-wallet-backend:3002
     peerIlpAddress: test.cloud-nine-wallet
+    liquidityThreshold: 100000
 accounts:
   - name: 'Philip Fry'
     path: accounts/pfry

localenv/mock-account-servicing-entity/app/lib/parse_config.server.ts

@@ -14,6 +14,7 @@ export interface Asset {
   code: string
   scale: number
   liquidity: number
+  liquidityThreshold: number
 }
 
 export interface Fees {
@@ -22,6 +23,7 @@ export interface Fees {
 }
 
 export interface Peering {
+  liquidityThreshold: number
   peerUrl: string
   peerIlpAddress: string
   initialLiquidity: string

localenv/mock-account-servicing-entity/app/lib/requesters.ts

@@ -27,7 +27,8 @@ export interface GraphqlResponseElement {
 
 export async function createAsset(
   code: string,
-  scale: number
+  scale: number,
+  liquidityThreshold: number
 ): Promise<AssetMutationResponse> {
   const createAssetMutation = gql`
     mutation CreateAsset($input: CreateAssetInput!) {
@@ -39,14 +40,16 @@ export async function createAsset(
           id
           code
           scale
+          liquidityThreshold
         }
       }
     }
   `
   const createAssetInput = {
     input: {
       code,
-      scale
+      scale,
+      liquidityThreshold
     }
   }
   return apolloClient
@@ -67,7 +70,8 @@ export async function createPeer(
   outgoingEndpoint: string,
   assetId: string,
   assetCode: string,
-  name: string
+  name: string,
+  liquidityThreshold: number
 ): Promise<CreatePeerMutationResponse> {
   const createPeerMutation = gql`
     mutation CreatePeer($input: CreatePeerInput!) {
@@ -79,6 +83,7 @@ export async function createPeer(
           id
           staticIlpAddress
           name
+          liquidityThreshold
         }
       }
     }
@@ -91,7 +96,8 @@ export async function createPeer(
         outgoing: { endpoint: outgoingEndpoint, authToken: `test-${assetCode}` }
       },
       assetId,
-      name
+      name,
+      liquidityThreshold
     }
   }
   return apolloClient

localenv/mock-account-servicing-entity/app/lib/run_seed.server.ts

@@ -19,8 +19,9 @@ import { Asset } from 'generated/graphql'
 
 export async function setupFromSeed(config: Config): Promise<void> {
   const assets: Record<string, Asset> = {}
-  for (const { code, scale, liquidity } of config.seed.assets) {
-    const { asset } = await createAsset(code, scale)
+  for (const { code, scale, liquidity, liquidityThreshold } of config.seed
+    .assets) {
+    const { asset } = await createAsset(code, scale, liquidityThreshold)
     if (!asset) {
       throw new Error('asset not defined')
     }
@@ -39,7 +40,8 @@ export async function setupFromSeed(config: Config): Promise<void> {
           peer.peerUrl,
           asset.id,
           asset.code,
-          peer.name
+          peer.name,
+          peer.liquidityThreshold
         ).then((response) => response.peer)
         if (!peerResponse) {
           throw new Error('peer response not defined')

localenv/mock-account-servicing-entity/app/lib/webhooks.server.ts

@@ -4,7 +4,11 @@ import type { Amount } from './transactions.server'
 import { mockAccounts } from './accounts.server'
 import { apolloClient } from './apolloClient'
 import { v4 as uuid } from 'uuid'
-import { createPaymentPointer } from './requesters'
+import {
+  addAssetLiquidity,
+  addPeerLiquidity,
+  createPaymentPointer
+} from './requesters'
 import { CONFIG } from './parse_config.server'
 
 export enum EventType {
@@ -14,7 +18,9 @@ export enum EventType {
   OutgoingPaymentCreated = 'outgoing_payment.created',
   OutgoingPaymentCompleted = 'outgoing_payment.completed',
   OutgoingPaymentFailed = 'outgoing_payment.failed',
-  PaymentPointerNotFound = 'payment_pointer.not_found'
+  PaymentPointerNotFound = 'payment_pointer.not_found',
+  LiquidityAsset = 'asset.liquidity_low',
+  LiquidityPeer = 'peer.liquidity_low'
 }
 
 export interface WebHook {
@@ -194,3 +200,17 @@ export async function handlePaymentPointerNotFound(wh: WebHook) {
     paymentPointer.url
   )
 }
+
+export async function handleLowLiquidity(wh: WebHook) {
+  const id = wh.data['id'] as string | undefined
+
+  if (!id) {
+    throw new Error('id not found')
+  }
+
+  if (wh.type == 'asset.liquidity_low') {
+    await addAssetLiquidity(id, 1000000, uuid())
+  } else {
+    await addPeerLiquidity(id, '1000000', uuid())
+  }
+}

localenv/mock-account-servicing-entity/app/routes/webhooks.ts

@@ -1,6 +1,10 @@
 import type { ActionArgs } from '@remix-run/node'
 import { json } from '@remix-run/node'
-import { handlePaymentPointerNotFound, WebHook } from '~/lib/webhooks.server'
+import {
+  handleLowLiquidity,
+  handlePaymentPointerNotFound,
+  WebHook
+} from '~/lib/webhooks.server'
 import {
   handleOutgoingPaymentCreated,
   handleOutgoingPaymentCompletedFailed,
@@ -34,6 +38,10 @@ export async function action({ request }: ActionArgs) {
       case EventType.PaymentPointerNotFound:
         await handlePaymentPointerNotFound(wh)
         break
+      case EventType.LiquidityAsset:
+      case EventType.LiquidityPeer:
+        await handleLowLiquidity(wh)
+        break
       default:
         console.log(`unknown event type: ${wh.type}`)
         return json(undefined, { status: 400 })

localenv/mock-account-servicing-entity/seed.example.yml

@@ -2,12 +2,18 @@ self:
   graphqlUrl: http://localhost:3001/graphql
   hostname: 'backend'
   mapHostname: 'primary-mase'
+assets:
+  - code: USD
+    scale: 2
+    liquidity: 1000000
+    liquidityThreshold: 100000
 peers:
   - asset: USD
     scale: 2
     initialLiquidity: '100000'
     peerUrl: http://peer-backend:3002
     peerIlpAddress: test.peer
+    liquidityThreshold: 10000
 accounts:
   - name: 'Grace Franklin'
     url: http://backend/accounts/gfranklin

packages/backend/migrations/20230912091917_add_liquidityThreshold_assets.js

@@ -0,0 +1,19 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function (knex) {
+  return knex.schema.alterTable('assets', (table) => {
+    table.bigInteger('liquidityThreshold').nullable()
+  })
+}
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function (knex) {
+  return knex.schema.alterTable('assets', (table) => {
+    table.dropColumn('liquidityThreshold')
+  })
+}

packages/backend/migrations/20230912091925_add_liquidityThreshold_peers.js

@@ -0,0 +1,19 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function (knex) {
+  return knex.schema.alterTable('peers', (table) => {
+    table.bigInteger('liquidityThreshold').nullable()
+  })
+}
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function (knex) {
+  return knex.schema.alterTable('peers', (table) => {
+    table.dropColumn('liquidityThreshold')
+  })
+}

packages/backend/src/accounting/psql/service.ts

@@ -207,6 +207,8 @@ export async function createTransfer(
     postTransfers: async (transferRefs) => postTransfers(deps, transferRefs),
     getAccountReceived: async (accountRef) =>
       getAccountTotalReceived(deps, accountRef),
+    getAccountBalance: async (accountRef) =>
+      getLiquidityAccountBalance(deps, accountRef),
     createPendingTransfers: async (transfersToCreate) => {
       const [
         sourceAccount,