@t-0/provider-sdk 1.0.25 → 1.0.27

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

@@ -0,0 +1,56 @@
+"use strict";
+/**
+ Example on how to interact with network using SDK
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../../index.js");
+const index_js_2 = require("../../payment_intent/provider/index.js");
+const dotenv_1 = __importDefault(require("dotenv"));
+const protobuf_1 = require("@bufbuild/protobuf");
+const toProtoDecimal = (unscaled, exponent) => {
+    return (0, protobuf_1.create)(index_js_1.DecimalSchema, {
+        unscaled: BigInt(unscaled),
+        exponent: exponent,
+    });
+};
+async function main() {
+    dotenv_1.default.config();
+    const privateKeyHex = process.env.PROVIDER_PRIVATE_KEY;
+    const endpoint = process.env.TZERO_ENDPOINT || index_js_1.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 = (0, index_js_1.createClient)(privateKeyHex, endpoint, index_js_2.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: index_js_1.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: index_js_1.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/cjs/examples/payment_intent/service.d.ts

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

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

@@ -0,0 +1,68 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ Example on how to implement network notifications with SDK
+ */
+const index_js_1 = require("../../payment_intent/provider/index.js");
+const http = __importStar(require("http"));
+const index_js_2 = require("../../index.js");
+const index_js_3 = require("../../index.js");
+const dotenv_1 = __importDefault(require("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_1.default.config();
+    const networkPublicKeyHex = process.env.TZERO_PUBLIC_KEY;
+    const server = http.createServer((0, index_js_3.signatureValidation)((0, index_js_2.nodeAdapter)((0, index_js_2.createService)(networkPublicKeyHex, r => r.service(index_js_1.ProviderService, CreatePaymentIntentProviderService()))))).listen(8080);
+    console.log("server is listening at", server.address());
+}
+void main();

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

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

package/lib/cjs/examples/server.js

@@ -0,0 +1,93 @@
+"use strict";
+/**
+  Example on how to implement network notifications with SDK
+*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../index.js");
+const index_js_2 = require("../payment_intent/provider/index.js");
+const http = __importStar(require("http"));
+const index_js_3 = require("../index.js");
+const index_js_4 = require("../index.js");
+const dotenv_1 = __importDefault(require("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_1.default.config();
+    const networkPublicKeyHex = process.env.TZERO_PUBLIC_KEY;
+    const server = http.createServer((0, index_js_4.signatureValidation)((0, index_js_3.nodeAdapter)((0, index_js_1.createService)(networkPublicKeyHex, (r) => {
+        r.service(index_js_1.ProviderService, CreateProviderService());
+        r.service(index_js_2.ProviderService, CreatePaymentIntentProviderService());
+    })))).listen(8080);
+    console.log("server is listening at", server.address());
+}
+void main();

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

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

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

@@ -0,0 +1,42 @@
+"use strict";
+/**
+  Example on how to interact with network using SDK
+*/
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../index.js");
+const dotenv_1 = __importDefault(require("dotenv"));
+const protobuf_1 = require("@bufbuild/protobuf");
+const node_crypto_1 = require("node:crypto");
+const wkt_1 = require("@bufbuild/protobuf/wkt");
+async function main() {
+    dotenv_1.default.config();
+    const privateKeyHex = process.env.PROVIDER_PRIVATE_KEY;
+    const endpoint = process.env.TZERO_ENDPOINT || index_js_1.DEFAULT_ENDPOINT;
+    const networkClient = (0, index_js_1.createClient)(privateKeyHex, endpoint, index_js_1.NetworkService);
+    const toProtoDecimal = (unscaled, exponent) => {
+        return (0, protobuf_1.create)(index_js_1.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: (0, node_crypto_1.randomUUID)(),
+                    }],
+                currency: 'USD', // Example currency
+                expiration: (0, wkt_1.timestampFromDate)(new Date(Date.now() + 60 * 1000)), // Example expiration time (1 minute from now)
+                quoteType: index_js_1.QuoteType.REALTIME, // Example quote type
+                paymentMethod: index_js_1.PaymentMethodType.CARD,
+                timestamp: (0, wkt_1.timestampNow)(), // Current timestamp
+            }]
+    });
+    console.log('Update Quote Response:', updateResponse);
+}
+void main();

package/lib/cjs/index.js

@@ -0,0 +1,50 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentIntentRecipient = exports.PaymentIntentProvider = exports.nodeAdapter = void 0;
+__exportStar(require("./client/client.js"), exports);
+__exportStar(require("./service/service.js"), exports);
+__exportStar(require("./service/node.js"), exports);
+var connect_node_1 = require("@connectrpc/connect-node");
+Object.defineProperty(exports, "nodeAdapter", { enumerable: true, get: function () { return connect_node_1.connectNodeAdapter; } });
+__exportStar(require("./common/gen/tzero/v1/common/common_pb.js"), exports);
+__exportStar(require("./common/gen/tzero/v1/common/payment_method_pb.js"), exports);
+__exportStar(require("./common/gen/tzero/v1/payment/provider_pb.js"), exports);
+__exportStar(require("./common/gen/tzero/v1/payment/network_pb.js"), exports);
+exports.PaymentIntentProvider = __importStar(require("./common/gen/tzero/v1/payment_intent/provider/provider_pb.js"));
+exports.PaymentIntentRecipient = __importStar(require("./common/gen/tzero/v1/payment_intent/recipient/recipient_pb.js"));

package/lib/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

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

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../../common/gen/tzero/v1/payment_intent/provider/provider_pb.js"), exports);

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

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../../common/gen/tzero/v1/payment_intent/recipient/recipient_pb.js"), exports);

package/lib/cjs/service/node.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signatureValidation = void 0;
+const sha3_1 = require("@noble/hashes/sha3");
+const signatureValidation = (next) => (req, resp) => {
+    const hasher = sha3_1.keccak_256.create();
+    req.hasher = hasher;
+    req.on("data", (chunk) => {
+        if (chunk instanceof Buffer) {
+            hasher.update(chunk);
+        }
+    });
+    next(req, resp);
+};
+exports.signatureValidation = signatureValidation;

package/lib/cjs/service/service.js

@@ -0,0 +1,112 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createService = exports.REQUEST_VALIDITY_MILLIS = void 0;
+const connect_1 = require("@connectrpc/connect");
+const headers_js_1 = __importDefault(require("../common/headers.js"));
+const secp = __importStar(require("@noble/secp256k1"));
+exports.REQUEST_VALIDITY_MILLIS = 60000;
+const createSignatureVerification = (networkPublicKey) => (next) => async (req) => {
+    const ts = decodeNum(getHeader(req, headers_js_1.default.SignatureTimestamp));
+    if (Date.now() - ts > 60000) {
+        throw new connect_1.ConnectError(`${headers_js_1.default.SignatureTimestamp} must be within ${exports.REQUEST_VALIDITY_MILLIS} milliseconds from now`, connect_1.Code.InvalidArgument);
+    }
+    const publicKey = decodeHex(getHeader(req, headers_js_1.default.PublicKey));
+    if (networkPublicKey.compare(publicKey) !== 0) {
+        throw new connect_1.ConnectError(`${headers_js_1.default.PublicKey} value is not network public key`, connect_1.Code.Unauthenticated);
+    }
+    const signature = decodeHex(getHeader(req, headers_js_1.default.Signature));
+    const hasher = req.contextValues.get(kHash);
+    const tsBuf = Buffer.alloc(8);
+    tsBuf.writeBigUInt64LE(BigInt(ts)); // 64‑bit little‑endian timestamp
+    const hash = hasher
+        .update(tsBuf)
+        .digest();
+    let signatureValid = false;
+    try {
+        signatureValid = secp.verify(signature, hash, publicKey);
+    }
+    catch (e) {
+        throw new connect_1.ConnectError(`${headers_js_1.default.Signature} has invalid signature or public key format`, connect_1.Code.Unauthenticated);
+    }
+    if (!signatureValid) {
+        throw new connect_1.ConnectError(`${headers_js_1.default.Signature} has invalid signature`, connect_1.Code.Unauthenticated);
+    }
+    return await next(req);
+};
+const createService = (networkPublicKey, registerRoutes) => {
+    if (typeof networkPublicKey == "string") {
+        networkPublicKey = decodeHex(networkPublicKey);
+    }
+    return {
+        routes: (router) => {
+            registerRoutes(router);
+        },
+        interceptors: [createSignatureVerification(networkPublicKey)],
+        grpcWeb: false,
+        contextValues: (req) => {
+            return (0, connect_1.createContextValues)().set(kHash, req.hasher);
+        }
+    };
+};
+exports.createService = createService;
+const kHash = (0, connect_1.createContextKey)(undefined);
+function getHeader(req, header) {
+    const raw = req.header.get(header);
+    if (!raw) {
+        throw new connect_1.ConnectError(`missing required header '${header}'`, connect_1.Code.InvalidArgument);
+    }
+    return raw;
+}
+function decodeHex(value) {
+    value = value.startsWith('0x') ? value.slice(2) : value;
+    try {
+        return Buffer.from(value, "hex");
+    }
+    catch (e) {
+        throw new connect_1.ConnectError(`invalid header format. '${value}' must be hex encoded`, connect_1.Code.InvalidArgument);
+    }
+}
+function decodeNum(value) {
+    try {
+        return parseInt(value);
+    }
+    catch (e) {
+        throw new connect_1.ConnectError(`invalid header format. '${value}' must be a number`, connect_1.Code.InvalidArgument);
+    }
+}

package/lib/esm/client/client.d.ts

@@ -0,0 +1,16 @@
+import { DescService } from "@bufbuild/protobuf";
+export declare const DEFAULT_ENDPOINT = "https://api.t-0.network";
+export declare function createClient<T extends DescService>(signer: string | Buffer | ((data: Buffer) => Promise<Signature>) | Buffer<ArrayBufferLike>, endpoint: string | undefined, svc: T): import("@connectrpc/connect").Client<T>;
+/**
+ * Signature with metadata for particular request
+ */
+export interface Signature {
+    signature: Buffer;
+    publicKey: Buffer;
+}
+/**
+ * Signature function for signing requests to T-0 API. Accepts any data in string format and return signature
+ * with metadata
+ */
+export type SignerFunction = (data: Buffer) => Promise<Signature>;
+export default createClient;

package/lib/esm/client/signer.d.ts

@@ -0,0 +1,3 @@
+import { Signature } from "./client.js";
+export declare const CreateSigner: (privateKey: string | Buffer) => (data: Buffer) => Promise<Signature>;
+export default CreateSigner;