@novasamatech/host-api 0.9.4 → 0.10.0

package/dist/hostApi.js

@@ -1,8 +1,11 @@
 import { errAsync, fromPromise, okAsync } from 'neverthrow';
 import { extractErrorMessage } from './helpers.js';
+import { CALL_ERROR_FAILURE } from './protocol/callError.js';
 import { GenericError } from './protocol/commonCodecs.js';
 import { CreateProofErr, GetAliasErr, GetUserIdErr, ListRingVrfKeysErr, LoginErr, RegisterRingVrfKeyErr, RequestCredentialsErr, RingVrfSignErr, SignVrfErr, } from './protocol/v1/accounts.js';
+import { ChainInfoErr } from './protocol/v1/chainInteraction.js';
 import { ChatBotRegistrationErr, ChatMessagePostingErr, ChatRoomRegistrationErr } from './protocol/v1/chat.js';
+import { CoinPaymentErr } from './protocol/v1/coinPayment.js';
 import { CreateTransactionErr } from './protocol/v1/createTransaction.js';
 import { DeriveEntropyErr } from './protocol/v1/deriveEntropy.js';
 import { HandshakeErr } from './protocol/v1/handshake.js';
@@ -14,6 +17,7 @@ import { PreimageSubmitErr } from './protocol/v1/preimage.js';
 import { ResourceAllocationErr } from './protocol/v1/resourceAllocation.js';
 import { SigningErr } from './protocol/v1/sign.js';
 import { StatementProofErr } from './protocol/v1/statementStore.js';
+import { WorkerErr } from './protocol/v1/worker.js';
 export function createHostApi(transport) {
     return {
         handshake(payload) {
@@ -85,6 +89,21 @@ export function createHostApi(transport) {
                 value: new StorageErr.Unknown({ reason }),
             }));
         },
+        localStorageSubscribe(args, callback) {
+            return transport.subscribe('host_local_storage_subscribe', args, callback);
+        },
+        workerBeginOperation(payload) {
+            return makeRequest(transport.request('host_worker_begin_operation', payload), reason => ({
+                tag: payload.tag,
+                value: new WorkerErr.Unknown({ reason }),
+            }));
+        },
+        workerEndOperation(payload) {
+            return makeRequest(transport.request('host_worker_end_operation', payload), reason => ({
+                tag: payload.tag,
+                value: new WorkerErr.Unknown({ reason }),
+            }));
+        },
         accountConnectionStatusSubscribe(args, callback) {
             return transport.subscribe('host_account_connection_status_subscribe', args, callback);
         },
@@ -265,6 +284,46 @@ export function createHostApi(transport) {
                 value: new ResourceAllocationErr.Unknown({ reason }),
             }));
         },
+        // coin payment (RFC 0017)
+        coinPaymentCreatePurse(payload) {
+            return makeRequest(transport.request('host_coin_payment_create_purse', payload), () => ({
+                tag: payload.tag,
+                value: new CoinPaymentErr.Internal(),
+            }));
+        },
+        coinPaymentQueryPurse(payload) {
+            return makeRequest(transport.request('host_coin_payment_query_purse', payload), () => ({
+                tag: payload.tag,
+                value: new CoinPaymentErr.Internal(),
+            }));
+        },
+        coinPaymentRebalancePurse(args, callback) {
+            return transport.subscribe('host_coin_payment_rebalance_purse', args, callback);
+        },
+        coinPaymentDeletePurse(args, callback) {
+            return transport.subscribe('host_coin_payment_delete_purse', args, callback);
+        },
+        coinPaymentCreateReceivable(payload) {
+            return makeRequest(transport.request('host_coin_payment_create_receivable', payload), () => ({
+                tag: payload.tag,
+                value: new CoinPaymentErr.Internal(),
+            }));
+        },
+        coinPaymentCreateCheque(payload) {
+            return makeRequest(transport.request('host_coin_payment_create_cheque', payload), () => ({
+                tag: payload.tag,
+                value: new CoinPaymentErr.Internal(),
+            }));
+        },
+        coinPaymentDeposit(args, callback) {
+            return transport.subscribe('host_coin_payment_deposit', args, callback);
+        },
+        coinPaymentRefund(args, callback) {
+            return transport.subscribe('host_coin_payment_refund', args, callback);
+        },
+        coinPaymentListenForPayment(args, callback) {
+            return transport.subscribe('host_coin_payment_listen_for_payment', args, callback);
+        },
         // chain interaction
         chainHeadFollowSubscribe(args, callback) {
             return transport.subscribe('remote_chain_head_follow_subscribe', args, callback);
@@ -311,6 +370,12 @@ export function createHostApi(transport) {
                 value: new GenericError({ reason }),
             }));
         },
+        chainGetChainInfo(payload) {
+            return makeRequest(transport.request('remote_chain_get_chain_info', payload), reason => ({
+                tag: payload.tag,
+                value: new ChainInfoErr.Unknown({ reason }),
+            }));
+        },
         chainSpecGenesisHash(payload) {
             return makeRequest(transport.request('remote_chain_spec_genesis_hash', payload), reason => ({
                 tag: payload.tag,
@@ -343,10 +408,29 @@ export function createHostApi(transport) {
         },
     };
 }
+/** Human-readable reason for a transport-level `CallError`, for the domain fallback. */
+function describeCallErrorFailure(failure) {
+    switch (failure.tag) {
+        case 'Denied':
+            return 'call denied by host';
+        case 'Unsupported':
+            return 'method unsupported by host';
+        case 'MalformedFrame':
+            return `malformed frame: ${failure.value.reason}`;
+        case 'HostFailure':
+            return `host failure: ${failure.value.reason}`;
+    }
+}
 function makeRequest(promise, mapErr) {
     return fromPromise(promise, e => mapErr(extractErrorMessage(e))).andThen(r => {
-        if (r.value.success)
-            return okAsync({ tag: r.tag, value: r.value.value });
-        return errAsync({ tag: r.tag, value: r.value.value });
+        const value = r.value;
+        // A transport-level CallError carries no domain answer; fold it into the
+        // method's domain error so products keep a single error type.
+        if (CALL_ERROR_FAILURE in value) {
+            return errAsync(mapErr(describeCallErrorFailure(value[CALL_ERROR_FAILURE])));
+        }
+        if (value.success)
+            return okAsync({ tag: r.tag, value: value.value });
+        return errAsync({ tag: r.tag, value: value.value });
     });
 }

package/dist/index.d.ts

@@ -8,6 +8,8 @@ export { createTransport } from './transport.js';
 export { createDefaultLogger } from './logger.js';
 export type { HostApiProtocol, VersionedProtocolRequest, VersionedProtocolSubscription } from './protocol/impl.js';
 export { hostApiProtocol } from './protocol/impl.js';
+export { CALL_ERROR_FAILURE, isCallErrorFailure } from './protocol/callError.js';
+export type { CallErrorTransportFailure } from './protocol/callError.js';
 export type { Codec, CodecType } from 'scale-ts';
 export type { HexString } from '@novasamatech/scale';
 export { assertEnumVariant, enumValue, fromHex, isEnumVariant, resultErr, resultOk, toHex, unwrapResultOrThrow, } from '@novasamatech/scale';
@@ -22,6 +24,7 @@ export { HandshakeErr } from './protocol/v1/handshake.js';
 export { SigningErr, SigningPayload, SigningPayloadWithoutAccount, SigningRawPayload, SigningRawPayloadWithoutAccount, SigningResult, } from './protocol/v1/sign.js';
 export { SignedStatement, SignedStatementsPage, Statement, StatementProofErr, Topic, TopicFilter, } from './protocol/v1/statementStore.js';
 export { StorageErr } from './protocol/v1/localStorage.js';
+export { OperationId, WorkerErr } from './protocol/v1/worker.js';
 export { DevicePermission } from './protocol/v1/devicePermission.js';
 export { RemotePermission } from './protocol/v1/remotePermission.js';
 export { NotificationId, PushNotification, PushNotificationError } from './protocol/v1/notification.js';
@@ -30,5 +33,6 @@ export { PreimageKey, PreimageSubmitErr, PreimageValue } from './protocol/v1/pre
 export { AllocatableResource, AllocationOutcome, ResourceAllocationErr } from './protocol/v1/resourceAllocation.js';
 export { PaymentBalance, PaymentBalanceErr, PaymentId, PaymentReceipt, PaymentRequestErr, PaymentStatus, PaymentStatusErr, PaymentTopUpErr, PaymentTopUpSource, } 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, OperationStartedResult, RuntimeType, StorageQueryItem, StorageQueryType, StorageResultItem, TransactionBroadcastV1_request, TransactionBroadcastV1_response, TransactionStopV1_request, TransactionStopV1_response, } from './protocol/v1/chainInteraction.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';
 export { Theme, ThemeName, ThemeVariant } from './protocol/v1/theme.js';

package/dist/index.js

@@ -3,6 +3,7 @@ export { createHostApi } from './hostApi.js';
 export { createTransport } from './transport.js';
 export { createDefaultLogger } from './logger.js';
 export { hostApiProtocol } from './protocol/impl.js';
+export { CALL_ERROR_FAILURE, isCallErrorFailure } from './protocol/callError.js';
 export { assertEnumVariant, enumValue, fromHex, isEnumVariant, resultErr, resultOk, toHex, unwrapResultOrThrow, } from '@novasamatech/scale';
 // Codecs
 export { GenericError } from './protocol/commonCodecs.js';
@@ -15,6 +16,7 @@ export { HandshakeErr } from './protocol/v1/handshake.js';
 export { SigningErr, SigningPayload, SigningPayloadWithoutAccount, SigningRawPayload, SigningRawPayloadWithoutAccount, SigningResult, } from './protocol/v1/sign.js';
 export { SignedStatement, SignedStatementsPage, Statement, StatementProofErr, Topic, TopicFilter, } from './protocol/v1/statementStore.js';
 export { StorageErr } from './protocol/v1/localStorage.js';
+export { OperationId, WorkerErr } from './protocol/v1/worker.js';
 export { DevicePermission } from './protocol/v1/devicePermission.js';
 export { RemotePermission } from './protocol/v1/remotePermission.js';
 export { NotificationId, PushNotification, PushNotificationError } from './protocol/v1/notification.js';
@@ -23,5 +25,6 @@ export { PreimageKey, PreimageSubmitErr, PreimageValue } from './protocol/v1/pre
 export { AllocatableResource, AllocationOutcome, ResourceAllocationErr } from './protocol/v1/resourceAllocation.js';
 export { PaymentBalance, PaymentBalanceErr, PaymentId, PaymentReceipt, PaymentRequestErr, PaymentStatus, PaymentStatusErr, PaymentTopUpErr, PaymentTopUpSource, } 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, OperationStartedResult, RuntimeType, StorageQueryItem, StorageQueryType, StorageResultItem, TransactionBroadcastV1_request, TransactionBroadcastV1_response, TransactionStopV1_request, TransactionStopV1_response, } from './protocol/v1/chainInteraction.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';
 export { Theme, ThemeName, ThemeVariant } from './protocol/v1/theme.js';

package/dist/protocol/callError.d.ts

@@ -0,0 +1,63 @@
+import type { Codec, ResultPayload } from 'scale-ts';
+/** The transport-level failure variants (everything except `Domain`). */
+export type CallErrorTransportFailure = {
+    tag: 'Denied';
+} | {
+    tag: 'Unsupported';
+} | {
+    tag: 'MalformedFrame';
+    value: {
+        reason: string;
+    };
+} | {
+    tag: 'HostFailure';
+    value: {
+        reason: string;
+    };
+};
+/** SCALE codec for `CallError<D>`, discriminants pinned to the truapi order. */
+export declare const CallError: <D>(domain: Codec<D>) => Codec<{
+    tag: "Denied";
+    value: undefined;
+} | {
+    tag: "Unsupported";
+    value: undefined;
+} | {
+    tag: "MalformedFrame";
+    value: {
+        reason: string;
+    };
+} | {
+    tag: "HostFailure";
+    value: {
+        reason: string;
+    };
+} | {
+    tag: "Domain";
+    value: D;
+}>;
+/** A decoded transport failure carries this brand so the transport can spot it. */
+export declare const CALL_ERROR_FAILURE: unique symbol;
+/** Business (present) shape of a response: a plain scale-ts `Result`. */
+type Business<OK, ERR> = ResultPayload<OK, ERR>;
+/** True when a decoded response is a transport-level `CallError`, not a domain answer. */
+export declare const isCallErrorFailure: <OK, ERR>(value: CallResultValue<OK, ERR>) => value is {
+    [CALL_ERROR_FAILURE]: CallErrorTransportFailure;
+};
+export type CallResultValue<OK, ERR> = Business<OK, ERR> | {
+    [CALL_ERROR_FAILURE]: CallErrorTransportFailure;
+};
+export declare const CallResult: <OK, ERR>(ok: Codec<OK>, domainErr: Codec<ERR>) => Codec<CallResultValue<OK, ERR>>;
+/** A decoded subscription interrupt: the domain reason, or a transport failure. */
+export type CallInterruptValue<ERR> = ERR | {
+    [CALL_ERROR_FAILURE]: CallErrorTransportFailure;
+};
+/**
+ * Interrupt codec counterpart to `Result`. A subscription's interrupt reason is
+ * `CallError(V1(err))` on the wire (byte-identical to truapi); its value form is
+ * the plain domain reason for the `Domain` case, and a `CALL_ERROR_FAILURE`
+ * marker for a transport-level interrupt. The transport assembly applies this to
+ * typed interrupts, so interrupt codec definitions stay the plain domain error.
+ */
+export declare const interruptError: <ERR>(domainErr: Codec<ERR>) => Codec<CallInterruptValue<ERR>>;
+export {};

package/dist/protocol/callError.js

@@ -0,0 +1,57 @@
+import { Enum } from '@novasamatech/scale';
+import { Result as ScaleResult, Struct, _void, enhanceCodec, str } from 'scale-ts';
+/** Wraps a domain error codec into a `V1`-versioned enum, as truapi does. */
+const versioned = (domain) => Enum({ v1: domain }, [0]);
+/** SCALE codec for `CallError<D>`, discriminants pinned to the truapi order. */
+export const CallError = (domain) => Enum({
+    Domain: domain,
+    Denied: _void,
+    Unsupported: _void,
+    MalformedFrame: Struct({ reason: str }),
+    HostFailure: Struct({ reason: str }),
+}, [0, 1, 2, 3, 4]);
+/** A decoded transport failure carries this brand so the transport can spot it. */
+export const CALL_ERROR_FAILURE = Symbol('callErrorFailure');
+/** True when a decoded response is a transport-level `CallError`, not a domain answer. */
+export const isCallErrorFailure = (value) => CALL_ERROR_FAILURE in value;
+export const CallResult = (ok, domainErr) => {
+    const wire = ScaleResult(ok, CallError(versioned(domainErr)));
+    return enhanceCodec(wire, value => {
+        if (CALL_ERROR_FAILURE in value) {
+            // Re-encoding a decoded transport failure (rare): pass it straight back.
+            return { success: false, value: value[CALL_ERROR_FAILURE] };
+        }
+        if (value.success)
+            return { success: true, value: value.value };
+        return { success: false, value: { tag: 'Domain', value: { tag: 'v1', value: value.value } } };
+    }, decoded => {
+        if (decoded.success)
+            return { success: true, value: decoded.value };
+        const callError = decoded.value;
+        if (callError.tag === 'Domain') {
+            return { success: false, value: callError.value.value };
+        }
+        return { [CALL_ERROR_FAILURE]: callError };
+    });
+};
+/**
+ * Interrupt codec counterpart to `Result`. A subscription's interrupt reason is
+ * `CallError(V1(err))` on the wire (byte-identical to truapi); its value form is
+ * the plain domain reason for the `Domain` case, and a `CALL_ERROR_FAILURE`
+ * marker for a transport-level interrupt. The transport assembly applies this to
+ * typed interrupts, so interrupt codec definitions stay the plain domain error.
+ */
+export const interruptError = (domainErr) => {
+    const wire = CallError(versioned(domainErr));
+    return enhanceCodec(wire, value => {
+        if (typeof value === 'object' && value !== null && CALL_ERROR_FAILURE in value) {
+            const failure = value[CALL_ERROR_FAILURE];
+            return { tag: failure.tag, value: 'value' in failure ? failure.value : undefined };
+        }
+        return { tag: 'Domain', value: { tag: 'v1', value } };
+    }, decoded => {
+        if (decoded.tag === 'Domain')
+            return decoded.value.value;
+        return { [CALL_ERROR_FAILURE]: decoded };
+    });
+};