Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Build server-side Minmo Partner integrations in TypeScript.
[Minmo](https://www.minmo.to) Partner API. It gives you one Partner-bound
interface for bringing Bitcoin and local-currency workflows into your own
services: quote rates, coordinate OTC swaps and agents, operate wallets and
escrow, create Minmo Pay stores and invoices, and consume live domain events.
escrow, create Minmo Pay stores and invoices, connect payment service
providers, generate accounting reports, and consume live domain events.

Create a client with your Partner ID and API key, then start calling
Partner-scoped resources. The production API is configured by default, so
Expand Down Expand Up @@ -66,6 +67,8 @@ the `X-API-Key` header. Calls such as `account.get()`, `settings.get()`, and
| --- | --- | --- |
| Partner operations | `account`, `settings`, `analytics`, `members`, `invitations`, `apiKeys`, `referrals` | Manage the Partner account, team access, reporting, API keys, and referrals |
| Minmo Pay | `integrations.pay` | Create stores and invoices, connect settlement wallets, read authoritative invoice state, and subscribe to Pay events |
| Payment service providers | `integrations.psp` | Connect providers, collect and disburse funds, inspect liquidity and statements, reconcile transactions, and subscribe to PSP events |
| Accounting | `integrations.accounting` | List accounting sources, manage reporting templates, and generate CSV reports |
| OTC | `otc.rates`, `otc.swap`, `otc.agents` | Quote Bitcoin and local-currency rates, coordinate swaps, and operate an agent network |
| Wallets | `wallet` | Create and manage wallets, receive or send funds, transfer balances, and inspect wallet activity |
| Escrow | `escrow` | Create and reconcile escrows, verify funding, release or refund funds, and manage disputes |
Expand All @@ -88,6 +91,23 @@ const [quote, stores] = await Promise.all([
]);
```

For payment-provider and accounting integrations, use the same Partner-bound
client:

```ts
import { MinmoClient, SourceType } from "@minmoto/sdk";

const minmo = new MinmoClient({
partnerId: process.env.MINMO_PARTNER_ID!,
apiKey: process.env.MINMO_API_KEY!,
});

const [providers, accountingSources] = await Promise.all([
minmo.integrations.psp.listProviders(),
minmo.integrations.accounting.listSources(SourceType.PSP_CONNECTION),
]);
```

### Subscribe to live changes

Domain clients expose typed subscriptions alongside their command and query
Expand Down
76 changes: 76 additions & 0 deletions scripts/vendor-upstream.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,30 @@ writeFileSync(
`export { ApiKeyInvalidReason, ReferralCodeScope } from ${JSON.stringify(join(sdkSource, "partner.ts"))};`,
"export {",
" AgentSelectionMode,",
" AccountingExportFailureCode,",
" AccountingHealthStatus,",
" AccountPurpose,",
" AccountStatus,",
" AccountType,",
" AgentStatus,",
" AgentTeamAssociationStatus,",
" AgentTeamAssociationVisibility,",
" AnalyticsBucket,",
" ApiKeyCapability,",
" ApiKeyResourceScope,",
" BalanceBasis,",
" BitcoinNetwork,",
" BookEntityType,",
" ConfirmationRole,",
" Currency,",
" DisputeResolution,",
" EscrowEventType,",
" EscrowNetwork,",
" ExecutionStatus,",
" ExportReportType,",
" FxRateProvider,",
" JournalStatus,",
" NormalBalance,",
" OnchainConfirmationSpeed,",
" OtcEventType,",
" ParticipantRole,",
Expand All @@ -72,9 +83,36 @@ writeFileSync(
" PaymentChannel,",
" PayoutDestinationType,",
" Permission,",
" PostingDirection,",
" PspAccountingTemplate,",
" PspCallbackMode,",
" PspCapability,",
" PspConnectionKind,",
" PspConnectionStatus,",
" PspDisbursementDestinationType,",
" PspEntityType,",
" PspEnvironment,",
" PspEventType,",
" PspPaymentMethod,",
" PspPaymentOperation,",
" PspProvider,",
" PspProviderBalanceStatus,",
" PspProviderSetupFieldType,",
" PspReconciliationExceptionCode,",
" PspReconciliationRecordKind,",
" PspReconciliationResolutionAction,",
" PspReconciliationStatus,",
" PspReconciliationType,",
" ReconciliationStatus,",
" SettlementStatus,",
" SourceType,",
" SwapState,",
" SwapType,",
" TeamRole,",
" TransactionDirection,",
" TransactionOperation,",
" ValuationBasis,",
" ValuationStatus,",
" WalletConnectionScope,",
" WalletEventType,",
" WalletProvider,",
Expand Down Expand Up @@ -119,19 +157,30 @@ writeFileSync(
'export { ApiKeyInvalidReason, ReferralCodeScope } from "./sdk/partner.js";',
"export {",
" AgentSelectionMode,",
" AccountingExportFailureCode,",
" AccountingHealthStatus,",
" AccountPurpose,",
" AccountStatus,",
" AccountType,",
" AgentStatus,",
" AgentTeamAssociationStatus,",
" AgentTeamAssociationVisibility,",
" AnalyticsBucket,",
" ApiKeyCapability,",
" ApiKeyResourceScope,",
" BalanceBasis,",
" BitcoinNetwork,",
" BookEntityType,",
" ConfirmationRole,",
" Currency,",
" DisputeResolution,",
" EscrowEventType,",
" EscrowNetwork,",
" ExecutionStatus,",
" ExportReportType,",
" FxRateProvider,",
" JournalStatus,",
" NormalBalance,",
" OnchainConfirmationSpeed,",
" OtcEventType,",
" ParticipantRole,",
Expand All @@ -143,9 +192,36 @@ writeFileSync(
" PaymentChannel,",
" PayoutDestinationType,",
" Permission,",
" PostingDirection,",
" PspAccountingTemplate,",
" PspCallbackMode,",
" PspCapability,",
" PspConnectionKind,",
" PspConnectionStatus,",
" PspDisbursementDestinationType,",
" PspEntityType,",
" PspEnvironment,",
" PspEventType,",
" PspPaymentMethod,",
" PspPaymentOperation,",
" PspProvider,",
" PspProviderBalanceStatus,",
" PspProviderSetupFieldType,",
" PspReconciliationExceptionCode,",
" PspReconciliationRecordKind,",
" PspReconciliationResolutionAction,",
" PspReconciliationStatus,",
" PspReconciliationType,",
" ReconciliationStatus,",
" SettlementStatus,",
" SourceType,",
" SwapState,",
" SwapType,",
" TeamRole,",
" TransactionDirection,",
" TransactionOperation,",
" ValuationBasis,",
" ValuationStatus,",
" WalletConnectionScope,",
" WalletEventType,",
" WalletProvider,",
Expand Down
80 changes: 80 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
import {
AccountingExportFailureCode,
AccountingHealthStatus,
AccountPurpose,
AccountStatus,
AccountType,
AgentSelectionMode,
AgentStatus,
AgentTeamAssociationStatus,
Expand All @@ -7,21 +12,27 @@ import {
ApiKeyCapability,
ApiKeyInvalidReason,
ApiKeyResourceScope,
BalanceBasis,
BitcoinNetwork,
BookEntityType,
ConfirmationRole,
Currency,
DisputeResolution,
EscrowEventType,
EscrowNetwork,
EventConnectionState,
ExecutionStatus,
ExportReportType,
FxRateProvider,
JournalStatus,
MemoryEventCursorStore,
MinmoApiError,
MinmoAuthenticationError,
MinmoAuthorizationError,
MinmoRateLimitError,
MinmoSdkError,
MinmoTransportError,
NormalBalance,
OnchainConfirmationSpeed,
OtcEventType,
PartnerClient,
Expand All @@ -34,18 +45,50 @@ import {
PaymentChannel,
PayoutDestinationType,
Permission,
PostingDirection,
PspAccountingTemplate,
PspCallbackMode,
PspCapability,
PspConnectionKind,
PspConnectionStatus,
PspDisbursementDestinationType,
PspEntityType,
PspEnvironment,
PspEventType,
PspPaymentMethod,
PspPaymentOperation,
PspProvider,
PspProviderBalanceStatus,
PspProviderSetupFieldType,
PspReconciliationExceptionCode,
PspReconciliationRecordKind,
PspReconciliationResolutionAction,
PspReconciliationStatus,
PspReconciliationType,
ReconciliationStatus,
ReferralCodeScope,
ResyncRequiredError,
SettlementStatus,
SourceType,
SwapEscrowPaymentStatus,
SwapState,
SwapType,
TeamRole,
TransactionDirection,
TransactionOperation,
ValuationBasis,
ValuationStatus,
WalletConnectionScope,
WalletEventType,
WalletProvider,
} from "../vendor/upstream/runtime.mjs";

export {
AccountingExportFailureCode,
AccountingHealthStatus,
AccountPurpose,
AccountStatus,
AccountType,
AgentSelectionMode,
AgentStatus,
AgentTeamAssociationStatus,
Expand All @@ -54,21 +97,27 @@ export {
ApiKeyCapability,
ApiKeyInvalidReason,
ApiKeyResourceScope,
BalanceBasis,
BitcoinNetwork,
BookEntityType,
ConfirmationRole,
Currency,
DisputeResolution,
EscrowEventType,
EscrowNetwork,
EventConnectionState,
ExecutionStatus,
ExportReportType,
FxRateProvider,
JournalStatus,
MemoryEventCursorStore,
MinmoApiError,
MinmoAuthenticationError,
MinmoAuthorizationError,
MinmoRateLimitError,
MinmoSdkError,
MinmoTransportError,
NormalBalance,
OnchainConfirmationSpeed,
OtcEventType,
ParticipantRole,
Expand All @@ -80,24 +129,55 @@ export {
PaymentChannel,
PayoutDestinationType,
Permission,
PostingDirection,
PspAccountingTemplate,
PspCallbackMode,
PspCapability,
PspConnectionKind,
PspConnectionStatus,
PspDisbursementDestinationType,
PspEntityType,
PspEnvironment,
PspEventType,
PspPaymentMethod,
PspPaymentOperation,
PspProvider,
PspProviderBalanceStatus,
PspProviderSetupFieldType,
PspReconciliationExceptionCode,
PspReconciliationRecordKind,
PspReconciliationResolutionAction,
PspReconciliationStatus,
PspReconciliationType,
ReconciliationStatus,
ReferralCodeScope,
ResyncRequiredError,
SettlementStatus,
SourceType,
SwapEscrowPaymentStatus,
SwapState,
SwapType,
TeamRole,
TransactionDirection,
TransactionOperation,
ValuationBasis,
ValuationStatus,
WalletConnectionScope,
WalletEventType,
WalletProvider,
};

export type * from "../vendor/upstream/sdk/disputes.js";
export type * from "../vendor/upstream/sdk/accounting.js";
export type * from "../vendor/upstream/sdk/escrow.js";
export type * from "../vendor/upstream/sdk/events.js";
export type * from "../vendor/upstream/sdk/otc/index.js";
export type * from "../vendor/upstream/sdk/partner.js";
export type * from "../vendor/upstream/sdk/pay/index.js";
export type * from "../vendor/upstream/sdk/psp.js";
export type * from "../vendor/upstream/sdk/wallet.js";
export type * from "../vendor/upstream/core/types/accounting.js";
export type * from "../vendor/upstream/core/types/psp.js";

export const MINMO_PRODUCTION_BASE_URL = "https://api.minmo.to/api/v1";

Expand Down
31 changes: 31 additions & 0 deletions test/facade.test.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import { afterEach, test } from "node:test";
import {
MINMO_PRODUCTION_BASE_URL,
MinmoClient,
PspProvider,
SourceType,
} from "../dist/index.js";

const originalFetch = globalThis.fetch;
Expand Down Expand Up @@ -70,6 +72,35 @@ test("accepts an optional deployment base URL", async () => {
assert.equal(url, "https://api.staging.minmo.to/api/v1/teams/partner-1");
});

test("binds PSP and accounting integrations to the Partner API key", async () => {
const requests = [];
globalThis.fetch = async (input, init) => {
requests.push(new Request(input, init));
return Response.json([]);
};

const client = new MinmoClient({
partnerId: "partner/1",
apiKey: "secret-key",
});

await client.integrations.psp.listProviders();
await client.integrations.accounting.listSources(SourceType.PSP_CONNECTION);

assert.deepEqual(
requests.map((request) => request.url),
[
"https://api.minmo.to/api/v1/teams/partner%2F1/psp/providers",
"https://api.minmo.to/api/v1/teams/partner%2F1/accounting/sources?type=psp_connection",
],
);
assert.deepEqual(
requests.map((request) => request.headers.get("X-API-Key")),
["secret-key", "secret-key"],
);
assert.equal(PspProvider.SAFARICOM_DARAJA, "safaricom_daraja");
});

test("rejects blank Partner IDs and API keys", () => {
assert.throws(
() => new MinmoClient({ partnerId: " ", apiKey: "secret-key" }),
Expand Down
Loading