@t-0/provider-starter-ts 0.1.0

package/template/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "{{PROJECT_NAME}}",
+  "version": "1.0.0",
+  "description": "Node.js service built with your SDK",
+  "main": "dist/index.js",
+  "scripts": {
+    "dev": "ts-node src/index.ts",
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "lint": "eslint src --ext .ts",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@t-0/provider-sdk": "1.0.33",
+    "dotenv": "^16.3.1",
+    "tiny-invariant": "^1.3.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "@typescript-eslint/eslint-plugin": "^6.12.0",
+    "@typescript-eslint/parser": "^6.12.0",
+    "eslint": "^8.54.0",
+
+    "ts-node": "^10.9.1",
+    "typescript": "^5.3.2"
+  }
+}

package/template/src/get_quote.ts

@@ -0,0 +1,29 @@
+import {type Client, NetworkService, PaymentMethodType, QuoteType} from "@t-0/provider-sdk";
+import {fromProtoDecimal, toProtoDecimal} from "./lib";
+
+export default async function getQuote(networkClient: Client<typeof NetworkService>) {
+  const eurgbp = await networkClient.getQuote({
+    payInCurrency: "EUR",
+    payInMethod: PaymentMethodType.SEPA,
+    payOutCurrency: "GBP",
+    payOutMethod: PaymentMethodType.SWIFT,
+    quoteType: QuoteType.REALTIME,
+    amount: {
+      amount: {
+        case: 'payInAmount',
+        value: toProtoDecimal(1000, 0)
+      },
+    }
+  })
+
+  switch (eurgbp.result.case) {
+    case 'success':
+      console.log(`EUR/GBP: ${fromProtoDecimal(eurgbp.result.value.rate!)}`)
+      break;
+    case 'failure':
+      console.error(eurgbp.result.value.reason)
+      break;
+    default:
+      console.error("unexpected result type")
+  }
+}

package/template/src/index.ts

@@ -0,0 +1,67 @@
+import dotenv from 'dotenv';
+import {
+  createClient,
+  createService,
+  NetworkService,
+  nodeAdapter,
+  ProviderService,
+  signatureValidation,
+} from "@t-0/provider-sdk";
+import invariant from 'tiny-invariant';
+import http from "http";
+import publishQuotes from "./publish_quotes";
+import CreateProviderService from "./service";
+import getQuote from "./get_quote";
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import submitPayment from "./submit_payment";
+
+dotenv.config();
+
+const privateKeyHex = process.env.PROVIDER_PRIVATE_KEY;
+const port = process.env.PORT || 3000;
+const endpoint = process.env.TZERO_ENDPOINT || "https://api-sandbox.t-0.network";
+const quotePublishingInterval: number = Number(process.env.QUOTE_PUBLISHING_INTERVAL || "5000");
+const networkPublicKeyHex = process.env.NETWORK_PUBLIC_KEY;
+
+invariant(privateKeyHex, 'Private key not set');
+invariant(quotePublishingInterval > 0, 'Interval must be positive');
+invariant(networkPublicKeyHex, 'Network public key is not set');
+
+async function main() {
+  console.log('🚀 Service starting...');
+  console.log(`📡 Port: ${port}`);
+  const networkClient = createClient(privateKeyHex!, endpoint, NetworkService);
+
+  await publishQuotes(networkClient, quotePublishingInterval)
+
+  const server = http.createServer(
+    signatureValidation(
+      nodeAdapter(
+        createService(networkPublicKeyHex!, (r) => {
+          r.service(ProviderService, CreateProviderService());
+        })))
+  ).listen(port);
+  console.log("✅ Service ready and is listening at", server.address());
+
+  // Step 1.1 is done. You successfully initialised starter template
+
+  // TODO: Step 1.2 take you generated public key from .env and share it with t-0 team
+
+  // TODO: Step 1.3 implement publishing of quotes in the ./publish_quotes.ts
+
+  // TODO: Step 1.4 check that quote for target currency is successfully received
+  await getQuote(networkClient)
+
+  // TODO: Step 2.2 deploy your integration and provide t-0 team base URL of your deployment
+
+  // TODO: Step 2.3 check that you can submit payment by revisiting ./submit_payment.ts and uncommenting following line
+  // await submitPayment(networkClient)
+
+  // TODO: Step 2.5 ask t-0 team to submit a payment which would trigger your payOut endpoint
+}
+
+main().catch((error) => {
+  console.error('❌ Error starting service:', error);
+  process.exit(1);
+});
+

package/template/src/lib.ts

@@ -0,0 +1,13 @@
+import {Decimal, DecimalSchema} from "@t-0/provider-sdk";
+import {create} from "@bufbuild/protobuf";
+
+export const toProtoDecimal = (unscaled: number, exponent: number): Decimal => {
+  return create(DecimalSchema, {
+    unscaled: BigInt(unscaled),
+    exponent: exponent,
+  });
+}
+
+export const fromProtoDecimal = (value: Decimal): number => {
+  return Number(value.unscaled) * Math.pow(10, value.exponent)
+}

package/template/src/publish_quotes.ts

@@ -0,0 +1,34 @@
+import {type Client, NetworkService, PaymentMethodType, QuoteType} from "@t-0/provider-sdk";
+import {toProtoDecimal} from "./lib";
+import {randomUUID} from "node:crypto";
+import {timestampFromDate} from "@bufbuild/protobuf/wkt";
+
+export default async function publishQuotes(networkClient: Client<typeof NetworkService>, quotePublishingInterval: number): Promise<void> {
+  // TODO: Step 1.3 replace this with receiving quotes from you systems and publishing them into t-0 Network. We recommend publishing at least once per 5 seconds, but not more than once per second
+  const tick =  async () => {
+    try {
+      await networkClient.updateQuote({
+        payIn: [{
+          bands: [{
+            // note that rate is always USD/XXX, os that for EUR quote should be USD/EUR
+            rate: toProtoDecimal(863, -3), // rate 0.863
+            maxAmount: toProtoDecimal(1000, 0), // maximum amount in USD, could be 1000,5000,10000 or 25000
+            clientQuoteId: randomUUID(),
+          }],
+          currency: 'EUR',
+          expiration: timestampFromDate(new Date(Date.now() + 30 * 1000)), // expiration time (30 seconds from now)
+          quoteType: QuoteType.REALTIME, // REALTIME is only one supported right now
+          paymentMethod: PaymentMethodType.SEPA,
+          timestamp: timestampFromDate(new Date()), // Current timestamp
+        }]
+      })
+    } catch (error) {
+      console.error(error);
+      return
+    }
+    console.log("quote published")
+  }
+
+  await tick()
+  setInterval(tick, quotePublishingInterval);
+}

package/template/src/service.ts

@@ -0,0 +1,50 @@
+import {
+  PayoutRequest,
+  PayoutResponse,
+  UpdatePaymentRequest,
+  UpdateLimitRequest,
+  UpdateLimitResponse,
+  AppendLedgerEntriesRequest,
+  AppendLedgerEntriesResponse,
+  UpdatePaymentResponse,
+  HandlerContext,
+} from "@t-0/provider-sdk";
+
+/*
+  Please refer to docs, proto definition comments or source code comments to understand purpose of fields
+ */
+const CreateProviderService = () => {
+  return {
+    async updatePayment(req: UpdatePaymentRequest, _: HandlerContext) {
+      // TODO: Step 2.1 implement how you handle updates of payment initiated by you
+      console.log(`Received payment update for ${req.paymentId}, payment ${req.result.case}`)
+      return {} as UpdatePaymentResponse
+    },
+
+    async payOut(req: PayoutRequest, _: HandlerContext) {
+      // TODO: Step 2.4 implement how you do payouts (payments initiated by your counterparts)
+      console.log(`Received payout request ${req.payoutId}`)
+      return {
+        result: {
+          case: "accepted",
+          value: {},
+        },
+      } as PayoutResponse
+    },
+
+    async updateLimit(req: UpdateLimitRequest, _: HandlerContext) {
+      // TODO: optionally implement updates on your limits and limits usage
+      console.log(`Received update of limits with provider ${req.limits[0].creditorId}`)
+      return {} as UpdateLimitResponse
+    },
+
+    async appendLedgerEntries(req: AppendLedgerEntriesRequest, _: HandlerContext) {
+      // TODO: optionally implement handling of new ledger transactions and new ledger entries
+      console.log(`Received ledger entries for ${req.transactions} transaction(s)`)
+      return {
+      } as AppendLedgerEntriesResponse
+    },
+  }
+};
+
+export default CreateProviderService;

package/template/src/submit_payment.ts

@@ -0,0 +1,24 @@
+import {type Client, NetworkService, PaymentMethodType} from "@t-0/provider-sdk";
+
+export default async function submitPayment(networkClient: Client<typeof NetworkService>): Promise<void> {
+  // TODO: Step 2.3 replace this with receiving quotes from you systems and publishing them into t-0 Network. We recommend publishing at least once per 5 seconds, but not more than once per second
+    await networkClient.createPayment({
+      payIn: {
+        currency: 'EUR',
+        paymentMethod: PaymentMethodType.SEPA,
+      },
+      payOut: {
+        currency: 'GBP',
+        paymentDetails: {
+          details: {
+            case: "sepa",
+            value: {
+              iban: 'GB12345567890',
+              beneficiaryName: 'Max Mustermann',
+            }
+          }
+        }
+      }
+
+    })
+}

package/template/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "moduleResolution": "node"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}