@t-0/provider-sdk 1.0.25 → 1.0.26

package/lib/esm/common/gen/tzero/v1/public/public_pb.d.ts

@@ -0,0 +1,234 @@
+import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file tzero/v1/public/public.proto.
+ */
+export declare const file_tzero_v1_public_public: GenFile;
+/**
+ * @generated from message tzero.v1.public.GetPaymentQuoteRequest
+ */
+export type GetPaymentQuoteRequest = Message<"tzero.v1.public.GetPaymentQuoteRequest"> & {};
+/**
+ * Describes the message tzero.v1.public.GetPaymentQuoteRequest.
+ * Use `create(GetPaymentQuoteRequestSchema)` to create a new message.
+ */
+export declare const GetPaymentQuoteRequestSchema: GenMessage<GetPaymentQuoteRequest>;
+/**
+ * @generated from message tzero.v1.public.GetPaymentQuoteResponse
+ */
+export type GetPaymentQuoteResponse = Message<"tzero.v1.public.GetPaymentQuoteResponse"> & {};
+/**
+ * Describes the message tzero.v1.public.GetPaymentQuoteResponse.
+ * Use `create(GetPaymentQuoteResponseSchema)` to create a new message.
+ */
+export declare const GetPaymentQuoteResponseSchema: GenMessage<GetPaymentQuoteResponse>;
+/**
+ * @generated from message tzero.v1.public.CreatePaymentIntentRequest
+ */
+export type CreatePaymentIntentRequest = Message<"tzero.v1.public.CreatePaymentIntentRequest"> & {};
+/**
+ * Describes the message tzero.v1.public.CreatePaymentIntentRequest.
+ * Use `create(CreatePaymentIntentRequestSchema)` to create a new message.
+ */
+export declare const CreatePaymentIntentRequestSchema: GenMessage<CreatePaymentIntentRequest>;
+/**
+ * @generated from message tzero.v1.public.CreatePaymentIntentResponse
+ */
+export type CreatePaymentIntentResponse = Message<"tzero.v1.public.CreatePaymentIntentResponse"> & {};
+/**
+ * Describes the message tzero.v1.public.CreatePaymentIntentResponse.
+ * Use `create(CreatePaymentIntentResponseSchema)` to create a new message.
+ */
+export declare const CreatePaymentIntentResponseSchema: GenMessage<CreatePaymentIntentResponse>;
+/**
+ * @generated from message tzero.v1.public.GetPayInDetailsRequest
+ */
+export type GetPayInDetailsRequest = Message<"tzero.v1.public.GetPayInDetailsRequest"> & {
+    /**
+     * @generated from field: string payment_id = 10;
+     */
+    paymentId: string;
+};
+/**
+ * Describes the message tzero.v1.public.GetPayInDetailsRequest.
+ * Use `create(GetPayInDetailsRequestSchema)` to create a new message.
+ */
+export declare const GetPayInDetailsRequestSchema: GenMessage<GetPayInDetailsRequest>;
+/**
+ * @generated from message tzero.v1.public.GetPayInDetailsResponse
+ */
+export type GetPayInDetailsResponse = Message<"tzero.v1.public.GetPayInDetailsResponse"> & {};
+/**
+ * Describes the message tzero.v1.public.GetPayInDetailsResponse.
+ * Use `create(GetPayInDetailsResponseSchema)` to create a new message.
+ */
+export declare const GetPayInDetailsResponseSchema: GenMessage<GetPayInDetailsResponse>;
+/**
+ * @generated from message tzero.v1.public.GetPaymentsRequest
+ */
+export type GetPaymentsRequest = Message<"tzero.v1.public.GetPaymentsRequest"> & {};
+/**
+ * Describes the message tzero.v1.public.GetPaymentsRequest.
+ * Use `create(GetPaymentsRequestSchema)` to create a new message.
+ */
+export declare const GetPaymentsRequestSchema: GenMessage<GetPaymentsRequest>;
+/**
+ * @generated from message tzero.v1.public.GetPaymentsResponse
+ */
+export type GetPaymentsResponse = Message<"tzero.v1.public.GetPaymentsResponse"> & {};
+/**
+ * Describes the message tzero.v1.public.GetPaymentsResponse.
+ * Use `create(GetPaymentsResponseSchema)` to create a new message.
+ */
+export declare const GetPaymentsResponseSchema: GenMessage<GetPaymentsResponse>;
+/**
+ * @generated from message tzero.v1.public.GetCurrentUserRequest
+ */
+export type GetCurrentUserRequest = Message<"tzero.v1.public.GetCurrentUserRequest"> & {};
+/**
+ * Describes the message tzero.v1.public.GetCurrentUserRequest.
+ * Use `create(GetCurrentUserRequestSchema)` to create a new message.
+ */
+export declare const GetCurrentUserRequestSchema: GenMessage<GetCurrentUserRequest>;
+/**
+ * @generated from message tzero.v1.public.GetCurrentUserResponse
+ */
+export type GetCurrentUserResponse = Message<"tzero.v1.public.GetCurrentUserResponse"> & {
+    /**
+     * @generated from field: string id = 10;
+     */
+    id: string;
+    /**
+     * @generated from oneof tzero.v1.public.GetCurrentUserResponse.kyc_status
+     */
+    kycStatus: {
+        /**
+         * @generated from field: tzero.v1.public.GetCurrentUserResponse.KycStatusRequired required = 100;
+         */
+        value: GetCurrentUserResponse_KycStatusRequired;
+        case: "required";
+    } | {
+        /**
+         * @generated from field: tzero.v1.public.GetCurrentUserResponse.KycStatusPending pending = 110;
+         */
+        value: GetCurrentUserResponse_KycStatusPending;
+        case: "pending";
+    } | {
+        /**
+         * @generated from field: tzero.v1.public.GetCurrentUserResponse.KycStatusDone done = 120;
+         */
+        value: GetCurrentUserResponse_KycStatusDone;
+        case: "done";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message tzero.v1.public.GetCurrentUserResponse.
+ * Use `create(GetCurrentUserResponseSchema)` to create a new message.
+ */
+export declare const GetCurrentUserResponseSchema: GenMessage<GetCurrentUserResponse>;
+/**
+ * @generated from message tzero.v1.public.GetCurrentUserResponse.KycStatusDone
+ */
+export type GetCurrentUserResponse_KycStatusDone = Message<"tzero.v1.public.GetCurrentUserResponse.KycStatusDone"> & {};
+/**
+ * Describes the message tzero.v1.public.GetCurrentUserResponse.KycStatusDone.
+ * Use `create(GetCurrentUserResponse_KycStatusDoneSchema)` to create a new message.
+ */
+export declare const GetCurrentUserResponse_KycStatusDoneSchema: GenMessage<GetCurrentUserResponse_KycStatusDone>;
+/**
+ * @generated from message tzero.v1.public.GetCurrentUserResponse.KycStatusRequired
+ */
+export type GetCurrentUserResponse_KycStatusRequired = Message<"tzero.v1.public.GetCurrentUserResponse.KycStatusRequired"> & {
+    /**
+     * @generated from field: string url = 10;
+     */
+    url: string;
+    /**
+     * or failed ... // to may be Kyc needs to be re-verified
+     *
+     * @generated from field: bool retry = 20;
+     */
+    retry: boolean;
+};
+/**
+ * Describes the message tzero.v1.public.GetCurrentUserResponse.KycStatusRequired.
+ * Use `create(GetCurrentUserResponse_KycStatusRequiredSchema)` to create a new message.
+ */
+export declare const GetCurrentUserResponse_KycStatusRequiredSchema: GenMessage<GetCurrentUserResponse_KycStatusRequired>;
+/**
+ * @generated from message tzero.v1.public.GetCurrentUserResponse.KycStatusPending
+ */
+export type GetCurrentUserResponse_KycStatusPending = Message<"tzero.v1.public.GetCurrentUserResponse.KycStatusPending"> & {};
+/**
+ * Describes the message tzero.v1.public.GetCurrentUserResponse.KycStatusPending.
+ * Use `create(GetCurrentUserResponse_KycStatusPendingSchema)` to create a new message.
+ */
+export declare const GetCurrentUserResponse_KycStatusPendingSchema: GenMessage<GetCurrentUserResponse_KycStatusPending>;
+/**
+ * this service is available as a part of public API
+ *
+ * @generated from service tzero.v1.public.PaymentService
+ */
+export declare const PaymentService: GenService<{
+    /**
+     * available without authentication. This will find a pair of best PayIn nad PayOut providers in order to
+     * provide best quote for payment
+     * TODO: should quote have a life time?
+     *
+     * @generated from rpc tzero.v1.public.PaymentService.GetPaymentQuote
+     */
+    getPaymentQuote: {
+        methodKind: "unary";
+        input: typeof GetPaymentQuoteRequestSchema;
+        output: typeof GetPaymentQuoteResponseSchema;
+    };
+    /**
+     * Creates a payment details containing all the required attributes for PayOut
+     * requires authentication and completed KYC
+     *
+     * @generated from rpc tzero.v1.public.PaymentService.CreatePaymentIntent
+     */
+    createPaymentIntent: {
+        methodKind: "unary";
+        input: typeof CreatePaymentIntentRequestSchema;
+        output: typeof CreatePaymentIntentResponseSchema;
+    };
+    /**
+     * Returns pay in details for the corresponding Payment
+     *
+     * @generated from rpc tzero.v1.public.PaymentService.GetPayInDetails
+     */
+    getPayInDetails: {
+        methodKind: "unary";
+        input: typeof GetPayInDetailsRequestSchema;
+        output: typeof GetPayInDetailsResponseSchema;
+    };
+    /**
+     * Returns history of payments
+     *
+     * @generated from rpc tzero.v1.public.PaymentService.GetPayments
+     */
+    getPayments: {
+        methodKind: "unary";
+        input: typeof GetPaymentsRequestSchema;
+        output: typeof GetPaymentsResponseSchema;
+    };
+}>;
+/**
+ * this service is available as a part of public API
+ *
+ * @generated from service tzero.v1.public.UserService
+ */
+export declare const UserService: GenService<{
+    /**
+     * @generated from rpc tzero.v1.public.UserService.GetCurrentUser
+     */
+    getCurrentUser: {
+        methodKind: "unary";
+        input: typeof GetCurrentUserRequestSchema;
+        output: typeof GetCurrentUserResponseSchema;
+    };
+}>;

package/lib/esm/common/headers.d.ts

@@ -0,0 +1,6 @@
+export declare enum NetworkHeaders {
+    PublicKey = "X-Public-Key",
+    Signature = "X-Signature",
+    SignatureTimestamp = "X-Signature-Timestamp"
+}
+export default NetworkHeaders;

package/lib/esm/examples/payment_intent/pay-in-provider-flow.d.ts

@@ -0,0 +1,4 @@
+/**
+ Example on how to interact with network using SDK
+ */
+export {};

package/lib/esm/examples/payment_intent/pay-in-provider-flow.js

@@ -0,0 +1,51 @@
+/**
+ Example on how to interact with network using SDK
+ */
+import { Blockchain, createClient, DecimalSchema, DEFAULT_ENDPOINT, PaymentMethodType } from "../../index.js";
+import { NetworkService } from "../../payment_intent/provider/index.js";
+import dotenv from 'dotenv';
+import { create } from "@bufbuild/protobuf";
+const toProtoDecimal = (unscaled, exponent) => {
+    return create(DecimalSchema, {
+        unscaled: BigInt(unscaled),
+        exponent: exponent,
+    });
+};
+async function main() {
+    dotenv.config();
+    const privateKeyHex = process.env.PROVIDER_PRIVATE_KEY;
+    const endpoint = process.env.TZERO_ENDPOINT || DEFAULT_ENDPOINT;
+    // PayIn provider will interact with the network using the NetworkServiceClient.
+    // It will use ConfirmPayment/RejectPaymentIntent rpcs to notify the network about the payment intent status.
+    // ConfirmSettlement rpc should be used to notify the network about the settlement transfer (in case of pre-settlement).
+    const networkClient = createClient(privateKeyHex, endpoint, NetworkService);
+    // PayIn provider will also implement the ProviderServiceHandler interface
+    // which has only 2 methods:
+    // 1. CreatePaymentIntent - to create a payment intent and return the list of
+    //    available payment methods along with the URL to redirect user to make the payment.
+    // 2. ConfirmPayout - to confirm the payout after the payment is completed successfully.
+    // Initialize a provider service handler using your implementation of the
+    // ProviderServiceHandler interface.
+    // The flow starts when the network call the CreatePaymentIntent method of the PayIn provider.
+    // Pay-in provider will return the list of available payment methods, and when it receives the payment from the payer,
+    // it will call the ConfirmPayout method to confirm the payout.
+    const updateResponse = await networkClient.confirmPayment({
+        paymentIntentId: 123n, // Example payment intent ID
+        paymentMethod: PaymentMethodType.CARD
+    });
+    // if the payment collection was not successful, the provider will call RejectPaymentIntent method to notify
+    //the network about the failure.
+    const rejectResponse = await networkClient.rejectPaymentIntent({
+        paymentIntentId: 123n, // Example payment intent ID
+        reason: 'Payment failed' // Example reason for rejection
+    });
+    // Next step would be to transfer the settlement amount to the pay-out provider, and
+    // then call the ConfirmSettlement endpoint
+    const resp = await networkClient.confirmSettlement({
+        paymentIntentId: [123n], // Example payment intent ID
+        blockchain: Blockchain.TRON, // Example blockchain
+        txHash: '0x123456' // Example transaction hash
+    });
+    // And the last step - ConfirmPayout rpc will be called by Network to finalize the process.
+}
+void main();

package/lib/esm/examples/payment_intent/service.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/esm/examples/payment_intent/service.js

@@ -0,0 +1,30 @@
+/**
+ Example on how to implement network notifications with SDK
+ */
+import { ProviderService } from "../../payment_intent/provider/index.js";
+import * as http from "http";
+import { createService, nodeAdapter } from "../../index.js";
+import { signatureValidation } from "../../index.js";
+import dotenv from "dotenv";
+/*
+  Providers must implement this. Please refer to docs or proto definition comments
+ */
+const CreatePaymentIntentProviderService = () => {
+    return {
+        async createPaymentIntent(req, context) {
+            // Implement your logic to create a payment intent
+            return {};
+        },
+        async confirmPayout(req, context) {
+            // Implement your logic to confirm a payout
+            return {};
+        }
+    };
+};
+async function main() {
+    dotenv.config();
+    const networkPublicKeyHex = process.env.TZERO_PUBLIC_KEY;
+    const server = http.createServer(signatureValidation(nodeAdapter(createService(networkPublicKeyHex, r => r.service(ProviderService, CreatePaymentIntentProviderService()))))).listen(8080);
+    console.log("server is listening at", server.address());
+}
+void main();

package/lib/esm/examples/server.d.ts

@@ -0,0 +1,4 @@
+/**
+  Example on how to implement network notifications with SDK
+*/
+export {};

package/lib/esm/examples/server.js

@@ -0,0 +1,55 @@
+/**
+  Example on how to implement network notifications with SDK
+*/
+import { createService, ProviderService } from "../index.js";
+import { ProviderService as PaymentIntentProviderService } from "../payment_intent/provider/index.js";
+import * as http from "http";
+import { nodeAdapter } from "../index.js";
+import { signatureValidation } from "../index.js";
+import dotenv from "dotenv";
+/*
+  Providers must implement this. Please refer to docs or proto definition comments
+ */
+const CreateProviderService = () => {
+    return {
+        async payOut(req, context) {
+            return {};
+        },
+        async updatePayment(req, context) {
+            return {};
+        },
+        async updateLimit(req, context) {
+            return {};
+        },
+        async appendLedgerEntries(req, context) {
+            return {};
+        },
+    };
+};
+/*
+  Providers must implement this. Please refer to docs or proto definition comments
+ */
+const CreatePaymentIntentProviderService = () => {
+    return {
+        async createPaymentIntent(req, context) {
+            console.log(`${req.$typeName}`);
+            // Implement your logic to create a payment intent
+            return {};
+        },
+        async confirmPayout(req, context) {
+            console.log(`${req.$typeName}`);
+            // Implement your logic to confirm a payout
+            return {};
+        }
+    };
+};
+async function main() {
+    dotenv.config();
+    const networkPublicKeyHex = process.env.TZERO_PUBLIC_KEY;
+    const server = http.createServer(signatureValidation(nodeAdapter(createService(networkPublicKeyHex, (r) => {
+        r.service(ProviderService, CreateProviderService());
+        r.service(PaymentIntentProviderService, CreatePaymentIntentProviderService());
+    })))).listen(8080);
+    console.log("server is listening at", server.address());
+}
+void main();

package/lib/esm/examples/update-quote.d.ts

@@ -0,0 +1,4 @@
+/**
+  Example on how to interact with network using SDK
+*/
+export {};

package/lib/esm/examples/update-quote.js

@@ -0,0 +1,37 @@
+/**
+  Example on how to interact with network using SDK
+*/
+import { createClient, DecimalSchema, DEFAULT_ENDPOINT, NetworkService, PaymentMethodType, QuoteType } from "../index.js";
+import dotenv from 'dotenv';
+import { create } from "@bufbuild/protobuf";
+import { randomUUID } from "node:crypto";
+import { timestampFromDate, timestampNow } from "@bufbuild/protobuf/wkt";
+async function main() {
+    dotenv.config();
+    const privateKeyHex = process.env.PROVIDER_PRIVATE_KEY;
+    const endpoint = process.env.TZERO_ENDPOINT || DEFAULT_ENDPOINT;
+    const networkClient = createClient(privateKeyHex, endpoint, NetworkService);
+    const toProtoDecimal = (unscaled, exponent) => {
+        return create(DecimalSchema, {
+            unscaled: BigInt(unscaled),
+            exponent: exponent,
+        });
+    };
+    // Update the quote
+    const updateResponse = await networkClient.updateQuote({
+        payIn: [{
+                bands: [{
+                        rate: toProtoDecimal(123, 2), // Example rate
+                        maxAmount: toProtoDecimal(1000, 0), // Example maximum amount
+                        clientQuoteId: randomUUID(),
+                    }],
+                currency: 'USD', // Example currency
+                expiration: timestampFromDate(new Date(Date.now() + 60 * 1000)), // Example expiration time (1 minute from now)
+                quoteType: QuoteType.REALTIME, // Example quote type
+                paymentMethod: PaymentMethodType.CARD,
+                timestamp: timestampNow(), // Current timestamp
+            }]
+    });
+    console.log('Update Quote Response:', updateResponse);
+}
+void main();

package/lib/esm/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./client/client.js";
+export * from "./service/service.js";
+export * from "./service/node.js";
+export { connectNodeAdapter as nodeAdapter } from "@connectrpc/connect-node";
+export type { HandlerContext } from "@connectrpc/connect";
+export * from './common/gen/tzero/v1/common/common_pb.js';
+export * from './common/gen/tzero/v1/common/payment_method_pb.js';
+export * from './common/gen/tzero/v1/payment/provider_pb.js';
+export * from './common/gen/tzero/v1/payment/network_pb.js';
+export * as PaymentIntentProvider from './common/gen/tzero/v1/payment_intent/provider/provider_pb.js';
+export * as PaymentIntentRecipient from './common/gen/tzero/v1/payment_intent/recipient/recipient_pb.js';

package/lib/esm/payment_intent/provider/index.js

@@ -0,0 +1 @@
+export * from '../../common/gen/tzero/v1/payment_intent/provider/provider_pb.js';

package/lib/esm/payment_intent/recipient/index.js

@@ -0,0 +1 @@
+export * from '../../common/gen/tzero/v1/payment_intent/recipient/recipient_pb.js';

package/lib/esm/service/node.d.ts

@@ -0,0 +1,3 @@
+import type * as http from "node:http";
+export type NodeHandlerFn = (request: http.IncomingMessage, response: http.ServerResponse) => void;
+export declare const signatureValidation: (next: NodeHandlerFn) => NodeHandlerFn;

package/lib/esm/service/service.d.ts

@@ -0,0 +1,15 @@
+import { ConnectRouter } from "@connectrpc/connect";
+import type { Interceptor } from "@connectrpc/connect";
+import type { DescService } from "@bufbuild/protobuf";
+import type { ServiceImpl } from "@connectrpc/connect";
+export declare const REQUEST_VALIDITY_MILLIS = 60000;
+interface Router {
+    service: <T extends DescService>(service: T, implementation: Partial<ServiceImpl<T>>) => void;
+}
+export declare const createService: (networkPublicKey: string | Buffer, registerRoutes: (router: Router) => void) => {
+    routes: (router: ConnectRouter) => void;
+    interceptors: Interceptor[];
+    grpcWeb: boolean;
+    contextValues: (req: any) => import("@connectrpc/connect").ContextValues;
+};
+export {};

package/lib/{service → esm/service}/service.js

@@ -1,10 +1,10 @@
 import { Code, ConnectError, createContextKey, createContextValues } from "@connectrpc/connect";
 import NetworkHeaders from "../common/headers.js";
 import * as secp from '@noble/secp256k1';
-export const REQUEST_VALIDITY_MILLIS = 60_000;
+export const REQUEST_VALIDITY_MILLIS = 60000;
 const createSignatureVerification = (networkPublicKey) => (next) => async (req) => {
     const ts = decodeNum(getHeader(req, NetworkHeaders.SignatureTimestamp));
-    if (Date.now() - ts > 60_000) {
+    if (Date.now() - ts > 60000) {
         throw new ConnectError(`${NetworkHeaders.SignatureTimestamp} must be within ${REQUEST_VALIDITY_MILLIS} milliseconds from now`, Code.InvalidArgument);
     }
     const publicKey = decodeHex(getHeader(req, NetworkHeaders.PublicKey));