@novasamatech/host-api 0.11.0 → 0.12.0

package/dist/index.d.ts

@@ -31,7 +31,7 @@ export { NotificationId, PushNotification, PushNotificationError } from './proto
 export { NavigateToErr } from './protocol/v1/navigation.js';
 export { PreimageKey, PreimageSubmitErr, PreimageValue } from './protocol/v1/preimage.js';
 export { AllocatableResource, AllocationOutcome, ResourceAllocationErr } from './protocol/v1/resourceAllocation.js';
-export { PaymentBalance, PaymentBalanceErr, PaymentId, PaymentReceipt, PaymentRequestErr, PaymentStatus, PaymentStatusErr, PaymentTopUpErr, PaymentTopUpId, PaymentTopUpSource, PaymentTopUpStatus, PaymentTopUpStatusErr, } from './protocol/v1/payments.js';
+export { PaymentBalance, PaymentBalanceErr, PaymentId, PaymentRequestErr, PaymentStatus, PaymentStatusErr, PaymentTopUpErr, PaymentTopUpId, PaymentTopUpSource, PaymentTopUpStatus, PaymentTopUpStatusErr, } from './protocol/v1/payments.js';
 export { Arrangement, BorderStyle, ButtonVariant, ColorToken, ContentAlignment, CustomRendererNode, Dimensions, HorizontalAlignment, Modifier, Shape, Size, TypographyStyle, VerticalAlignment, } from './protocol/v1/customRenderer.js';
 export { ChainHeadEvent, ChainHeadFollowV1_start, ChainIdentifier, ChainInfoErr, OperationStartedResult, RuntimeType, StorageQueryItem, StorageQueryType, StorageResultItem, TransactionBroadcastV1_request, TransactionBroadcastV1_response, TransactionStopV1_request, TransactionStopV1_response, } from './protocol/v1/chainInteraction.js';
 export { CoinPaymentBalance, CoinPaymentCheque, CoinPaymentErr, CoinPaymentListenForItem, CoinPaymentPurseId, CoinPaymentPurseInfo, CoinPaymentReceivable, CoinPaymentStatus, CoinPaymentTransmissionChannel, } from './protocol/v1/coinPayment.js';

package/dist/index.js

@@ -23,7 +23,7 @@ export { NotificationId, PushNotification, PushNotificationError } from './proto
 export { NavigateToErr } from './protocol/v1/navigation.js';
 export { PreimageKey, PreimageSubmitErr, PreimageValue } from './protocol/v1/preimage.js';
 export { AllocatableResource, AllocationOutcome, ResourceAllocationErr } from './protocol/v1/resourceAllocation.js';
-export { PaymentBalance, PaymentBalanceErr, PaymentId, PaymentReceipt, PaymentRequestErr, PaymentStatus, PaymentStatusErr, PaymentTopUpErr, PaymentTopUpId, PaymentTopUpSource, PaymentTopUpStatus, PaymentTopUpStatusErr, } from './protocol/v1/payments.js';
+export { PaymentBalance, PaymentBalanceErr, PaymentId, PaymentRequestErr, PaymentStatus, PaymentStatusErr, PaymentTopUpErr, PaymentTopUpId, PaymentTopUpSource, PaymentTopUpStatus, PaymentTopUpStatusErr, } from './protocol/v1/payments.js';
 export { Arrangement, BorderStyle, ButtonVariant, ColorToken, ContentAlignment, CustomRendererNode, Dimensions, HorizontalAlignment, Modifier, Shape, Size, TypographyStyle, VerticalAlignment, } from './protocol/v1/customRenderer.js';
 export { ChainHeadEvent, ChainHeadFollowV1_start, ChainIdentifier, ChainInfoErr, OperationStartedResult, RuntimeType, StorageQueryItem, StorageQueryType, StorageResultItem, TransactionBroadcastV1_request, TransactionBroadcastV1_response, TransactionStopV1_request, TransactionStopV1_response, } from './protocol/v1/chainInteraction.js';
 export { CoinPaymentBalance, CoinPaymentCheque, CoinPaymentErr, CoinPaymentListenForItem, CoinPaymentPurseId, CoinPaymentPurseInfo, CoinPaymentReceivable, CoinPaymentStatus, CoinPaymentTransmissionChannel, } from './protocol/v1/coinPayment.js';

package/dist/protocol/impl.d.ts

@@ -952,14 +952,13 @@ export declare const hostApiProtocol: {
             from: number | undefined;
             amount: bigint;
             destination: Uint8Array<ArrayBufferLike>;
-        }>, Codec<import("./callError.js").CallResultValue<{
-            id: string;
-        }, import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
+            id: Uint8Array<ArrayBufferLike>;
+        }>, Codec<import("./callError.js").CallResultValue<undefined, import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
             reason: string;
-        }, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>>];
+        }, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::AlreadyExists"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>>];
     }>;
     readonly host_payment_status_subscribe: VersionedProtocolSubscription<{
-        readonly v1: [Codec<string>, Codec<{
+        readonly v1: [import("@novasamatech/scale").BytesCodec<number>, Codec<{
             tag: "Failed";
             value: string;
         } | {
@@ -968,6 +967,9 @@ export declare const hostApiProtocol: {
         } | {
             tag: "Completed";
             value: undefined;
+        } | {
+            tag: "PartiallyClaimed";
+            value: bigint;
         }>, [import("scale-ts").Encoder<import("@novasamatech/scale").CodecError<{
             reason: string;
         }, "PaymentStatusErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentStatusErr::PaymentNotFound">>, import("scale-ts").Decoder<import("@novasamatech/scale").CodecError<{

package/dist/protocol/messageCodec.d.ts

@@ -1006,15 +1006,14 @@ export declare const MessagePayload: EnumCodec<Record<"host_handshake_request",
         from: number | undefined;
         amount: bigint;
         destination: Uint8Array<ArrayBufferLike>;
+        id: Uint8Array<ArrayBufferLike>;
     }>;
 }>> & Record<"host_payment_request_response", EnumCodec<{
-    readonly v1: Codec<import("./callError.js").CallResultValue<{
-        id: string;
-    }, import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
+    readonly v1: Codec<import("./callError.js").CallResultValue<undefined, import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
         reason: string;
-    }, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>>;
+    }, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::AlreadyExists"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>>;
 }>> & Record<"host_payment_status_subscribe_start", EnumCodec<{
-    readonly v1: Codec<string>;
+    readonly v1: import("@novasamatech/scale").BytesCodec<number>;
 }>> & Record<"host_payment_status_subscribe_receive", EnumCodec<{
     readonly v1: Codec<{
         tag: "Failed";
@@ -1025,6 +1024,9 @@ export declare const MessagePayload: EnumCodec<Record<"host_handshake_request",
     } | {
         tag: "Completed";
         value: undefined;
+    } | {
+        tag: "PartiallyClaimed";
+        value: bigint;
     }>;
 }>> & Record<"host_payment_status_subscribe_interrupt", EnumCodec<{
     readonly v1: [import("scale-ts").Encoder<import("@novasamatech/scale").CodecError<{
@@ -3069,23 +3071,22 @@ export declare const Message: Codec<{
                 from: number | undefined;
                 amount: bigint;
                 destination: Uint8Array<ArrayBufferLike>;
+                id: Uint8Array<ArrayBufferLike>;
             };
         };
     } | {
         tag: "host_payment_request_response";
         value: {
             tag: "v1";
-            value: import("./callError.js").CallResultValue<{
-                id: string;
-            }, import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
+            value: import("./callError.js").CallResultValue<undefined, import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
                 reason: string;
-            }, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>;
+            }, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::AlreadyExists"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>;
         };
     } | {
         tag: "host_payment_status_subscribe_start";
         value: {
             tag: "v1";
-            value: string;
+            value: Uint8Array<ArrayBufferLike>;
         };
     } | {
         tag: "host_payment_status_subscribe_receive";
@@ -3100,6 +3101,9 @@ export declare const Message: Codec<{
             } | {
                 tag: "Completed";
                 value: undefined;
+            } | {
+                tag: "PartiallyClaimed";
+                value: bigint;
             };
         };
     } | {

package/dist/protocol/v1/payments.d.ts

@@ -1,5 +1,6 @@
 export declare const Sr25519SecretKey: import("@novasamatech/scale").BytesCodec<number>;
-export declare const PaymentId: import("scale-ts").Codec<string>;
+/** Product-supplied, opaque 32-byte idempotency key for a payment request. */
+export declare const PaymentId: import("@novasamatech/scale").BytesCodec<number>;
 /** Product-supplied, opaque 32-byte idempotency key for a top up. */
 export declare const PaymentTopUpId: import("@novasamatech/scale").BytesCodec<number>;
 export declare const CoinPaymentPurseId: import("scale-ts").Codec<number>;
@@ -22,9 +23,6 @@ export declare const PaymentTopUpSource: import("scale-ts").Codec<{
 export declare const PaymentBalance: import("scale-ts").Codec<{
     available: bigint;
 }>;
-export declare const PaymentReceipt: import("scale-ts").Codec<{
-    id: string;
-}>;
 export declare const PaymentStatus: import("scale-ts").Codec<{
     tag: "Failed";
     value: string;
@@ -34,6 +32,9 @@ export declare const PaymentStatus: import("scale-ts").Codec<{
 } | {
     tag: "Completed";
     value: undefined;
+} | {
+    tag: "PartiallyClaimed";
+    value: bigint;
 }>;
 export declare const PaymentTopUpStatus: import("scale-ts").Codec<{
     tag: "Detecting";
@@ -122,16 +123,17 @@ export declare const PaymentTopUpStatusErr: [import("scale-ts").Encoder<import("
 };
 export declare const PaymentRequestErr: [import("scale-ts").Encoder<import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
     reason: string;
-}, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>, import("scale-ts").Decoder<import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
+}, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::AlreadyExists"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>, import("scale-ts").Decoder<import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
     reason: string;
-}, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>] & {
+}, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::AlreadyExists"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>] & {
     enc: import("scale-ts").Encoder<import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
         reason: string;
-    }, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>;
+    }, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::AlreadyExists"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>;
     dec: import("scale-ts").Decoder<import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
         reason: string;
-    }, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>;
+    }, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::AlreadyExists"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>;
 } & {
+    readonly AlreadyExists: import("@novasamatech/scale").ErrCodec<undefined, "PaymentRequestErr::AlreadyExists">;
     readonly Rejected: import("@novasamatech/scale").ErrCodec<undefined, "PaymentRequestErr::Rejected">;
     readonly InsufficientBalance: import("@novasamatech/scale").ErrCodec<undefined, "PaymentRequestErr::InsufficientBalance">;
     readonly Unknown: import("@novasamatech/scale").ErrCodec<{
@@ -140,7 +142,7 @@ export declare const PaymentRequestErr: [import("scale-ts").Encoder<import("@nov
 } & {
     [Symbol.hasInstance](v: unknown): v is import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
         reason: string;
-    }, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">;
+    }, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::AlreadyExists"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">;
 };
 export declare const PaymentStatusErr: [import("scale-ts").Encoder<import("@novasamatech/scale").CodecError<{
     reason: string;
@@ -218,13 +220,12 @@ export declare const PaymentRequestV1_request: import("scale-ts").Codec<{
     from: number | undefined;
     amount: bigint;
     destination: Uint8Array<ArrayBufferLike>;
+    id: Uint8Array<ArrayBufferLike>;
 }>;
-export declare const PaymentRequestV1_response: import("scale-ts").Codec<import("../callError.js").CallResultValue<{
-    id: string;
-}, import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
+export declare const PaymentRequestV1_response: import("scale-ts").Codec<import("../callError.js").CallResultValue<undefined, import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::Rejected"> | import("@novasamatech/scale").CodecError<{
     reason: string;
-}, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>>;
-export declare const PaymentStatusSubscribeV1_start: import("scale-ts").Codec<string>;
+}, "PaymentRequestErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::AlreadyExists"> | import("@novasamatech/scale").CodecError<undefined, "PaymentRequestErr::InsufficientBalance">>>;
+export declare const PaymentStatusSubscribeV1_start: import("@novasamatech/scale").BytesCodec<number>;
 export declare const PaymentStatusSubscribeV1_receive: import("scale-ts").Codec<{
     tag: "Failed";
     value: string;
@@ -234,6 +235,9 @@ export declare const PaymentStatusSubscribeV1_receive: import("scale-ts").Codec<
 } | {
     tag: "Completed";
     value: undefined;
+} | {
+    tag: "PartiallyClaimed";
+    value: bigint;
 }>;
 export declare const PaymentStatusSubscribeV1_interrupt: [import("scale-ts").Encoder<import("@novasamatech/scale").CodecError<{
     reason: string;

package/dist/protocol/v1/payments.js

@@ -5,7 +5,8 @@ import { GenericErr } from '../commonCodecs.js';
 import { DerivationIndex } from './accounts.js';
 // common types
 export const Sr25519SecretKey = Bytes(64);
-export const PaymentId = str;
+/** Product-supplied, opaque 32-byte idempotency key for a payment request. */
+export const PaymentId = Bytes(32);
 /** Product-supplied, opaque 32-byte idempotency key for a top up. */
 export const PaymentTopUpId = Bytes(32);
 // Optional purse selector (RFC 0017). `undefined` (None) targets MAIN_PURSE.
@@ -19,13 +20,17 @@ export const PaymentTopUpSource = Enum({
 export const PaymentBalance = Struct({
     available: u128,
 });
-export const PaymentReceipt = Struct({
-    id: PaymentId,
-});
+// A status never advances once it reaches a terminal variant (`Completed`,
+// `Failed`, `PartiallyClaimed`); the host takes no further action and keeps the
+// status readable indefinitely.
 export const PaymentStatus = Enum({
     Processing: _void,
+    // Terminal: the full amount reached the destination.
     Completed: _void,
+    // Terminal: the payment did not go through; carries the reason.
     Failed: str,
+    // Terminal: only this amount reached the destination, less than requested.
+    PartiallyClaimed: u128,
 });
 // A status never advances once it reaches a terminal variant (`Claimed` with
 // `finalized`, `ClaimedPartially`, `NotClaimed`); the host takes no further
@@ -64,6 +69,7 @@ export const PaymentTopUpStatusErr = ErrEnum('PaymentTopUpStatusErr', {
     Unknown: [GenericErr, 'unknown error'],
 });
 export const PaymentRequestErr = ErrEnum('PaymentRequestErr', {
+    AlreadyExists: [_void, 'a payment with this id already exists'],
     Rejected: [_void, 'rejected'],
     InsufficientBalance: [_void, 'insufficient balance'],
     Unknown: [GenericErr, 'unknown error'],
@@ -91,8 +97,9 @@ export const PaymentRequestV1_request = Struct({
     from: Option(CoinPaymentPurseId),
     amount: u128,
     destination: Bytes(32),
+    id: PaymentId,
 });
-export const PaymentRequestV1_response = CallResult(PaymentReceipt, PaymentRequestErr);
+export const PaymentRequestV1_response = CallResult(_void, PaymentRequestErr);
 // host_payment_status_subscribe
 export const PaymentStatusSubscribeV1_start = PaymentId;
 export const PaymentStatusSubscribeV1_receive = PaymentStatus;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@novasamatech/host-api",
   "type": "module",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Host API: transport implementation for host - product integration.",
   "license": "Apache-2.0",
   "repository": {
@@ -22,7 +22,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@novasamatech/scale": "0.11.0",
+    "@novasamatech/scale": "0.12.0",
     "nanoevents": "10.0.0",
     "nanoid": "6.0.1",
     "neverthrow": "^8.2.0",