@novasamatech/host-api 0.7.8 → 0.7.9-1

package/dist/index.d.ts

@@ -11,7 +11,7 @@ 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';
 export { GenericError } from './protocol/commonCodecs.js';
-export { CreateTransactionErr, VersionedPublicTxPayload } from './protocol/v1/createTransaction.js';
+export { CreateTransactionErr, LegacyTransaction, ProductAccountTransaction } from './protocol/v1/createTransaction.js';
 export { AccountConnectionStatus, AccountId, ContextualAlias, CreateProofErr, DerivationIndex, DotNsIdentifier, GetUserIdErr, LegacyAccount, LoginErr, LoginResult, ProductAccount, ProductAccountId, RequestCredentialsErr, RingLocation, UserIdentity, } from './protocol/v1/accounts.js';
 export { ChatActionPayload, ChatBotRegistrationErr, ChatBotRegistrationStatus, ChatMessageContent, ChatMessagePostingErr, ChatRoom, ChatRoomRegistrationErr, ChatRoomRegistrationResult, ChatRoomRegistrationStatus, ReceivedChatAction, } from './protocol/v1/chat.js';
 export { DeriveEntropyErr } from './protocol/v1/deriveEntropy.js';

package/dist/index.js

@@ -6,7 +6,7 @@ export { hostApiProtocol } from './protocol/impl.js';
 export { assertEnumVariant, enumValue, fromHex, isEnumVariant, resultErr, resultOk, toHex, unwrapResultOrThrow, } from '@novasamatech/scale';
 // Codecs
 export { GenericError } from './protocol/commonCodecs.js';
-export { CreateTransactionErr, VersionedPublicTxPayload } from './protocol/v1/createTransaction.js';
+export { CreateTransactionErr, LegacyTransaction, ProductAccountTransaction } from './protocol/v1/createTransaction.js';
 export { AccountConnectionStatus, AccountId, ContextualAlias, CreateProofErr, DerivationIndex, DotNsIdentifier, GetUserIdErr, LegacyAccount, LoginErr, LoginResult, ProductAccount, ProductAccountId, RequestCredentialsErr, RingLocation, UserIdentity, } from './protocol/v1/accounts.js';
 export { ChatActionPayload, ChatBotRegistrationErr, ChatBotRegistrationStatus, ChatMessageContent, ChatMessagePostingErr, ChatRoom, ChatRoomRegistrationErr, ChatRoomRegistrationResult, ChatRoomRegistrationStatus, ReceivedChatAction, } from './protocol/v1/chat.js';
 export { DeriveEntropyErr } from './protocol/v1/deriveEntropy.js';

package/dist/protocol/impl.d.ts

@@ -123,12 +123,30 @@ export declare const hostApiProtocol: {
         }, "RequestCredentialsErr::Unknown">>>];
     }>;
     readonly host_create_transaction: VersionedProtocolRequest<{
-        readonly v1: [Codec<[[string, number], import("./v1/createTransaction.js").TxPayloadV1Public]>, Codec<import("scale-ts").ResultPayload<Uint8Array<ArrayBufferLike>, import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::Rejected"> | import("@novasamatech/scale").CodecError<{
+        readonly v1: [Codec<{
+            signer: [string, number];
+            callData: Uint8Array<ArrayBufferLike>;
+            extensions: {
+                id: string;
+                extra: Uint8Array<ArrayBufferLike>;
+                additionalSigned: Uint8Array<ArrayBufferLike>;
+            }[];
+            txExtVersion: number;
+        }>, Codec<import("scale-ts").ResultPayload<Uint8Array<ArrayBufferLike>, import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::Rejected"> | import("@novasamatech/scale").CodecError<{
             reason: string;
         }, "CreateTransactionErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::PermissionDenied"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::FailedToDecode"> | import("@novasamatech/scale").CodecError<string, "CreateTransactionErr::NotSupported">>>];
     }>;
     readonly host_create_transaction_with_legacy_account: VersionedProtocolRequest<{
-        readonly v1: [Codec<import("./v1/createTransaction.js").TxPayloadV1Public>, Codec<import("scale-ts").ResultPayload<Uint8Array<ArrayBufferLike>, import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::Rejected"> | import("@novasamatech/scale").CodecError<{
+        readonly v1: [Codec<{
+            signer: Uint8Array<ArrayBufferLike>;
+            callData: Uint8Array<ArrayBufferLike>;
+            extensions: {
+                id: string;
+                extra: Uint8Array<ArrayBufferLike>;
+                additionalSigned: Uint8Array<ArrayBufferLike>;
+            }[];
+            txExtVersion: number;
+        }>, Codec<import("scale-ts").ResultPayload<Uint8Array<ArrayBufferLike>, import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::Rejected"> | import("@novasamatech/scale").CodecError<{
             reason: string;
         }, "CreateTransactionErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::PermissionDenied"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::FailedToDecode"> | import("@novasamatech/scale").CodecError<string, "CreateTransactionErr::NotSupported">>>];
     }>;

package/dist/protocol/messageCodec.d.ts

@@ -129,13 +129,31 @@ export declare const MessagePayload: EnumCodec<Record<"host_handshake_request",
         reason: string;
     }, "RequestCredentialsErr::Unknown">>>;
 }>> & Record<"host_create_transaction_request", EnumCodec<{
-    readonly v1: Codec<[[string, number], import("./v1/createTransaction.js").TxPayloadV1Public]>;
+    readonly v1: Codec<{
+        signer: [string, number];
+        callData: Uint8Array<ArrayBufferLike>;
+        extensions: {
+            id: string;
+            extra: Uint8Array<ArrayBufferLike>;
+            additionalSigned: Uint8Array<ArrayBufferLike>;
+        }[];
+        txExtVersion: number;
+    }>;
 }>> & Record<"host_create_transaction_response", EnumCodec<{
     readonly v1: Codec<import("scale-ts").ResultPayload<Uint8Array<ArrayBufferLike>, import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::Rejected"> | import("@novasamatech/scale").CodecError<{
         reason: string;
     }, "CreateTransactionErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::PermissionDenied"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::FailedToDecode"> | import("@novasamatech/scale").CodecError<string, "CreateTransactionErr::NotSupported">>>;
 }>> & Record<"host_create_transaction_with_legacy_account_request", EnumCodec<{
-    readonly v1: Codec<import("./v1/createTransaction.js").TxPayloadV1Public>;
+    readonly v1: Codec<{
+        signer: Uint8Array<ArrayBufferLike>;
+        callData: Uint8Array<ArrayBufferLike>;
+        extensions: {
+            id: string;
+            extra: Uint8Array<ArrayBufferLike>;
+            additionalSigned: Uint8Array<ArrayBufferLike>;
+        }[];
+        txExtVersion: number;
+    }>;
 }>> & Record<"host_create_transaction_with_legacy_account_response", EnumCodec<{
     readonly v1: Codec<import("scale-ts").ResultPayload<Uint8Array<ArrayBufferLike>, import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::Rejected"> | import("@novasamatech/scale").CodecError<{
         reason: string;
@@ -1275,7 +1293,16 @@ export declare const Message: Codec<{
         tag: "host_create_transaction_request";
         value: {
             tag: "v1";
-            value: [[string, number], import("./v1/createTransaction.js").TxPayloadV1Public];
+            value: {
+                signer: [string, number];
+                callData: Uint8Array<ArrayBufferLike>;
+                extensions: {
+                    id: string;
+                    extra: Uint8Array<ArrayBufferLike>;
+                    additionalSigned: Uint8Array<ArrayBufferLike>;
+                }[];
+                txExtVersion: number;
+            };
         };
     } | {
         tag: "host_create_transaction_response";
@@ -1289,7 +1316,16 @@ export declare const Message: Codec<{
         tag: "host_create_transaction_with_legacy_account_request";
         value: {
             tag: "v1";
-            value: import("./v1/createTransaction.js").TxPayloadV1Public;
+            value: {
+                signer: Uint8Array<ArrayBufferLike>;
+                callData: Uint8Array<ArrayBufferLike>;
+                extensions: {
+                    id: string;
+                    extra: Uint8Array<ArrayBufferLike>;
+                    additionalSigned: Uint8Array<ArrayBufferLike>;
+                }[];
+                txExtVersion: number;
+            };
         };
     } | {
         tag: "host_create_transaction_with_legacy_account_response";

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

@@ -1,7 +1,8 @@
-import type { HexString } from '@novasamatech/scale';
+import type { Codec } from 'scale-ts';
 /**
  * createTransaction implementation
  * @see https://github.com/polkadot-js/api/issues/6213
+ * Since specification is aimed to cover both online and offline signers we dropped some field that are not related
  */
 export declare const CreateTransactionErr: [import("scale-ts").Encoder<import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::Rejected"> | import("@novasamatech/scale").CodecError<{
     reason: string;
@@ -27,121 +28,54 @@ export declare const CreateTransactionErr: [import("scale-ts").Encoder<import("@
         reason: string;
     }, "CreateTransactionErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::PermissionDenied"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::FailedToDecode"> | import("@novasamatech/scale").CodecError<string, "CreateTransactionErr::NotSupported">;
 };
-export declare const TxPayloadExtensionV1: import("scale-ts").Codec<{
+export declare const TxPayloadExtensionV1: Codec<{
     id: string;
-    extra: `0x${string}`;
-    additionalSigned: `0x${string}`;
+    extra: Uint8Array<ArrayBufferLike>;
+    additionalSigned: Uint8Array<ArrayBufferLike>;
 }>;
-export declare const TxPayloadContextV1: import("scale-ts").Codec<{
-    metadata: `0x${string}`;
-    tokenSymbol: string;
-    tokenDecimals: number;
-    bestBlockHeight: number;
+export declare const ProductAccountTransaction: Codec<{
+    signer: [string, number];
+    callData: Uint8Array<ArrayBufferLike>;
+    extensions: {
+        id: string;
+        extra: Uint8Array<ArrayBufferLike>;
+        additionalSigned: Uint8Array<ArrayBufferLike>;
+    }[];
+    txExtVersion: number;
 }>;
-export declare const TxPayloadV1: import("scale-ts").Codec<{
-    signer: string | null;
-    callData: `0x${string}`;
+export declare const LegacyTransaction: Codec<{
+    signer: Uint8Array<ArrayBufferLike>;
+    callData: Uint8Array<ArrayBufferLike>;
     extensions: {
         id: string;
-        extra: `0x${string}`;
-        additionalSigned: `0x${string}`;
+        extra: Uint8Array<ArrayBufferLike>;
+        additionalSigned: Uint8Array<ArrayBufferLike>;
     }[];
     txExtVersion: number;
-    context: {
-        metadata: `0x${string}`;
-        tokenSymbol: string;
-        tokenDecimals: number;
-        bestBlockHeight: number;
-    };
 }>;
-export declare const VersionedTxPayload: import("scale-ts").Codec<{
-    tag: "v1";
-    value: {
-        signer: string | null;
-        callData: `0x${string}`;
-        extensions: {
-            id: string;
-            extra: `0x${string}`;
-            additionalSigned: `0x${string}`;
-        }[];
-        txExtVersion: number;
-        context: {
-            metadata: `0x${string}`;
-            tokenSymbol: string;
-            tokenDecimals: number;
-            bestBlockHeight: number;
-        };
-    };
+export declare const CreateTransactionV1_request: Codec<{
+    signer: [string, number];
+    callData: Uint8Array<ArrayBufferLike>;
+    extensions: {
+        id: string;
+        extra: Uint8Array<ArrayBufferLike>;
+        additionalSigned: Uint8Array<ArrayBufferLike>;
+    }[];
+    txExtVersion: number;
 }>;
-export declare const VersionedPublicTxPayload: import("scale-ts").Codec<TxPayloadV1Public>;
-export declare const CreateTransactionV1_request: import("scale-ts").Codec<[[string, number], TxPayloadV1Public]>;
-export declare const CreateTransactionV1_response: import("scale-ts").Codec<import("scale-ts").ResultPayload<Uint8Array<ArrayBufferLike>, import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::Rejected"> | import("@novasamatech/scale").CodecError<{
+export declare const CreateTransactionV1_response: Codec<import("scale-ts").ResultPayload<Uint8Array<ArrayBufferLike>, import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::Rejected"> | import("@novasamatech/scale").CodecError<{
     reason: string;
 }, "CreateTransactionErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::PermissionDenied"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::FailedToDecode"> | import("@novasamatech/scale").CodecError<string, "CreateTransactionErr::NotSupported">>>;
-export declare const CreateTransactionWithLegacyAccountV1_request: import("scale-ts").Codec<TxPayloadV1Public>;
-export declare const CreateTransactionWithLegacyAccountV1_response: import("scale-ts").Codec<import("scale-ts").ResultPayload<Uint8Array<ArrayBufferLike>, import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::Rejected"> | import("@novasamatech/scale").CodecError<{
-    reason: string;
-}, "CreateTransactionErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::PermissionDenied"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::FailedToDecode"> | import("@novasamatech/scale").CodecError<string, "CreateTransactionErr::NotSupported">>>;
-export interface TxPayloadV1Public {
-    /** Payload version. MUST be 1. */
-    version: 1;
-    /**
-     * Signer selection hint. Allows the implementer to identify which private-key / scheme to use.
-     * - Use a wallet-defined handle (e.g., address/SS58, account-name, etc). This identifier
-     * was previously made available to the consumer.
-     * - Set `null` to let the implementer pick the signer (or if the signer is implied).
-     */
-    signer: string | null;
-    /**
-     * SCALE-encoded Call (module indicator + function indicator + params).
-     */
-    callData: HexString;
-    /**
-     * Transaction extensions supplied by the caller (order irrelevant).
-     * The consumer SHOULD provide every extension that is relevant to them.
-     * The implementer MAY infer missing ones.
-     */
-    extensions: Array<{
-        /** Identifier as defined in metadata (e.g., "CheckSpecVersion", "ChargeAssetTxPayment"). */
+export declare const CreateTransactionWithLegacyAccountV1_request: Codec<{
+    signer: Uint8Array<ArrayBufferLike>;
+    callData: Uint8Array<ArrayBufferLike>;
+    extensions: {
         id: string;
-        /**
-         * Explicit "extra" to sign (goes into the extrinsic body).
-         * SCALE-encoded per the extension's "extra" type as defined in the metadata.
-         */
-        extra: HexString;
-        /**
-         * "Implicit" data to sign (known by the chain, not included into the extrinsic body).
-         * SCALE-encoded per the extension's "additionalSigned" type as defined in the metadata.
-         */
-        additionalSigned: HexString;
-    }>;
-    /**
-     * Transaction Extension Version.
-     * - For Extrinsic V4 MUST be 0.
-     * - For Extrinsic V5, set to any version supported by the runtime.
-     * The implementer:
-     *  - MUST use this field to determine the required extensions for creating the extrinsic.
-     *  - MAY use this field to infer missing extensions that the implementer could know how to handle.
-     */
+        extra: Uint8Array<ArrayBufferLike>;
+        additionalSigned: Uint8Array<ArrayBufferLike>;
+    }[];
     txExtVersion: number;
-    /**
-     * Context needed for decoding, display, and (optionally) inferring certain extensions.
-     */
-    context: {
-        /**
-         * RuntimeMetadataPrefixed blob (SCALE), starting with ASCII "meta" magic (`0x6d657461`),
-         * then a metadata version (V14+). For V5+ versioned extensions, MUST provide V16+.
-         */
-        metadata: HexString;
-        /**
-         * Native token display info (used by some implementers), also needed to compute
-         * the `CheckMetadataHash` value.
-         */
-        tokenSymbol: string;
-        tokenDecimals: number;
-        /**
-         * Highest known block number to aid mortality UX.
-         */
-        bestBlockHeight: number;
-    };
-}
+}>;
+export declare const CreateTransactionWithLegacyAccountV1_response: Codec<import("scale-ts").ResultPayload<Uint8Array<ArrayBufferLike>, import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::Rejected"> | import("@novasamatech/scale").CodecError<{
+    reason: string;
+}, "CreateTransactionErr::Unknown"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::PermissionDenied"> | import("@novasamatech/scale").CodecError<undefined, "CreateTransactionErr::FailedToDecode"> | import("@novasamatech/scale").CodecError<string, "CreateTransactionErr::NotSupported">>>;

package/dist/protocol/v1/createTransaction.js

@@ -1,10 +1,11 @@
-import { Enum, ErrEnum, Hex, Nullable } from '@novasamatech/scale';
-import { Bytes, Result, Struct, Tuple, Vector, _void, enhanceCodec, str, u32, u8 } from 'scale-ts';
+import { ErrEnum } from '@novasamatech/scale';
+import { Bytes, Result, Struct, Vector, _void, str, u8 } from 'scale-ts';
 import { GenericErr } from '../commonCodecs.js';
-import { ProductAccountId } from './accounts.js';
+import { AccountId, ProductAccountId } from './accounts.js';
 /**
  * createTransaction implementation
  * @see https://github.com/polkadot-js/api/issues/6213
+ * Since specification is aimed to cover both online and offline signers we dropped some field that are not related
  */
 export const CreateTransactionErr = ErrEnum('CreateTransactionErr', {
     FailedToDecode: [_void, 'Failed to decode'],
@@ -16,45 +17,47 @@ export const CreateTransactionErr = ErrEnum('CreateTransactionErr', {
     Unknown: [GenericErr, 'Unknown error'],
 });
 export const TxPayloadExtensionV1 = Struct({
+    /** Identifier as defined in metadata (e.g., "CheckSpecVersion", "ChargeAssetTxPayment"). */
     id: str,
-    extra: Hex(),
-    additionalSigned: Hex(),
-});
-export const TxPayloadContextV1 = Struct({
-    metadata: Hex(),
-    tokenSymbol: str,
-    tokenDecimals: u32,
-    bestBlockHeight: u32,
-});
-export const TxPayloadV1 = Struct({
-    signer: Nullable(str),
-    callData: Hex(),
-    extensions: Vector(TxPayloadExtensionV1),
-    txExtVersion: u8,
-    context: TxPayloadContextV1,
-});
-export const VersionedTxPayload = Enum({
-    v1: TxPayloadV1,
-});
-export const VersionedPublicTxPayload = enhanceCodec(VersionedTxPayload, v => {
-    if (v.version !== 1) {
-        throw new Error(`Unsupported transaction version: ${v}`);
-    }
-    return {
-        tag: 'v1',
-        value: v,
-    };
-}, v => {
-    if (v.tag !== 'v1') {
-        throw new Error(`Unsupported transaction version: ${v}`);
-    }
-    return {
-        version: 1,
-        ...v.value,
-    };
+    /**
+     * Explicit "extra" to sign (goes into the extrinsic body).
+     * SCALE-encoded per the extension's "extra" type as defined in the metadata.
+     */
+    extra: Bytes(),
+    /**
+     * "Implicit" data to sign (known by the chain, not included into the extrinsic body).
+     * SCALE-encoded per the extension's "additionalSigned" type as defined in the metadata.
+     */
+    additionalSigned: Bytes(),
 });
+function GenericTxPayloadV1(signer) {
+    return Struct({
+        signer,
+        /**
+         * SCALE-encoded Call (module indicator + function indicator + params).
+         */
+        callData: Bytes(),
+        /**
+         * Transaction extensions supplied by the caller (order irrelevant).
+         * The consumer SHOULD provide every extension that is relevant to them.
+         * The implementer MAY infer missing ones.
+         */
+        extensions: Vector(TxPayloadExtensionV1),
+        /**
+         * Transaction Extension Version.
+         * - For Extrinsic V4 MUST be 0.
+         * - For Extrinsic V5, set to any version supported by the runtime.
+         * The implementer:
+         *  - MUST use this field to determine the required extensions for creating the extrinsic.
+         *  - MAY use this field to infer missing extensions that the implementer could know how to handle.
+         */
+        txExtVersion: u8,
+    });
+}
 // transaction in the context of a host api account model
-export const CreateTransactionV1_request = Tuple(ProductAccountId, VersionedPublicTxPayload);
+export const ProductAccountTransaction = GenericTxPayloadV1(ProductAccountId);
+export const LegacyTransaction = GenericTxPayloadV1(AccountId);
+export const CreateTransactionV1_request = ProductAccountTransaction;
 export const CreateTransactionV1_response = Result(Bytes(), CreateTransactionErr);
-export const CreateTransactionWithLegacyAccountV1_request = VersionedPublicTxPayload;
+export const CreateTransactionWithLegacyAccountV1_request = LegacyTransaction;
 export const CreateTransactionWithLegacyAccountV1_response = Result(Bytes(), CreateTransactionErr);

package/package.json

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