@midnight-ntwrk/wallet-sdk-abstractions 1.0.0-beta.9

package/dist/NetworkId.d.ts

@@ -0,0 +1,10 @@
+export declare const NetworkId: {
+    readonly MainNet: "mainnet";
+    readonly TestNet: "testnet";
+    readonly DevNet: "devnet";
+    readonly QaNet: "qanet";
+    readonly Undeployed: "undeployed";
+    readonly Preview: "preview";
+    readonly PreProd: "preprod";
+};
+export type NetworkId = (typeof NetworkId)[keyof typeof NetworkId];

package/dist/NetworkId.js

@@ -0,0 +1,21 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+export const NetworkId = {
+    MainNet: 'mainnet',
+    TestNet: 'testnet',
+    DevNet: 'devnet',
+    QaNet: 'qanet',
+    Undeployed: 'undeployed',
+    Preview: 'preview',
+    PreProd: 'preprod',
+};

package/dist/ProtocolState.d.ts

@@ -0,0 +1,11 @@
+import * as ProtocolVersion from './ProtocolVersion.js';
+/**
+ * A type that associates some state with a given version of the Midnight protocol.
+ *
+ * @typeParam TState The type of state.
+ */
+export type ProtocolState<TState> = Readonly<{
+    version: ProtocolVersion.ProtocolVersion;
+    state: TState;
+}>;
+export declare const state: <TState>(ps: ProtocolState<TState>) => TState;

package/dist/ProtocolState.js

@@ -0,0 +1 @@
+export const state = (ps) => ps.state;

package/dist/ProtocolVersion.d.ts

@@ -0,0 +1,54 @@
+import * as Brand from 'effect/Brand';
+import * as Schema from 'effect/Schema';
+/**
+ * A branded `bigint` that represents a protocol version.
+ */
+export type ProtocolVersion = Brand.Branded<bigint, 'ProtocolVersion'>;
+/**
+ * Constructs a branded `bigint` represents a protocol version.
+ */
+export declare const ProtocolVersion: Brand.Brand.Constructor<ProtocolVersion>;
+export declare namespace ProtocolVersion {
+    /**
+     * A tuple type that represents a start and ending protocol version.
+     */
+    type Range = readonly [start: ProtocolVersion, end: ProtocolVersion];
+}
+/**
+ * Creates a new protocol version range.
+ *
+ * @param start The start value.
+ * @param end The end value.
+ * @returns A {@link ProtocolVersion.Range} defined by `start` and `end`.
+ *
+ * @throws `TypeError`
+ * Thrown when `start` is after `end`, or the difference between them is less than one.
+ */
+export declare const makeRange: (start: ProtocolVersion, end: ProtocolVersion) => ProtocolVersion.Range;
+/**
+ * Determines if a given protocol version is within a given range.
+ *
+ * @param version The version to test.
+ * @param range The {@link ProtocolVersion.Range} to test `version` against.
+ * @returns `true` if `version` is within the range defined by `range`.
+ */
+export declare const withinRange: (version: ProtocolVersion, range: ProtocolVersion.Range) => boolean;
+/**
+ * A schema that transforms a `bigint` into a {@link ProtocolVersion}.
+ */
+export declare const ProtocolVersionSchema: Schema.BrandSchema<bigint & Brand.Brand<"ProtocolVersion">, string, never>;
+/**
+ * A type predicate that determines if a given value is a {@link ProtocolVersion}.
+ *
+ * @param u The value to test.
+ * @returns `true` if `u` has the type {@link ProtocolVersion}.
+ */
+export declare const is: (u: unknown, overrideOptions?: import("effect/SchemaAST").ParseOptions | number) => u is bigint & Brand.Brand<"ProtocolVersion">;
+/**
+ * Represents the minimum supported protocol version.
+ */
+export declare const MinSupportedVersion: ProtocolVersion;
+/**
+ * Represents the maximum supported protocol version.
+ */
+export declare const MaxSupportedVersion: ProtocolVersion;

package/dist/ProtocolVersion.js

@@ -0,0 +1,64 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import * as Brand from 'effect/Brand';
+import * as Schema from 'effect/Schema';
+/**
+ * Constructs a branded `bigint` represents a protocol version.
+ */
+export const ProtocolVersion = Brand.nominal();
+/**
+ * Creates a new protocol version range.
+ *
+ * @param start The start value.
+ * @param end The end value.
+ * @returns A {@link ProtocolVersion.Range} defined by `start` and `end`.
+ *
+ * @throws `TypeError`
+ * Thrown when `start` is after `end`, or the difference between them is less than one.
+ */
+// TODO: make it possible to represent an open range on the end side to remove special "MaxSupportedVersion"
+export const makeRange = (start, end) => {
+    if (end - start < 1)
+        throw new TypeError('Invalid protocol version range.');
+    return [start, end];
+};
+/**
+ * Determines if a given protocol version is within a given range.
+ *
+ * @param version The version to test.
+ * @param range The {@link ProtocolVersion.Range} to test `version` against.
+ * @returns `true` if `version` is within the range defined by `range`.
+ */
+export const withinRange = (version, range) => {
+    const [min, max] = range;
+    return version >= min && version < max;
+};
+/**
+ * A schema that transforms a `bigint` into a {@link ProtocolVersion}.
+ */
+export const ProtocolVersionSchema = Schema.BigInt.pipe(Schema.fromBrand(ProtocolVersion));
+/**
+ * A type predicate that determines if a given value is a {@link ProtocolVersion}.
+ *
+ * @param u The value to test.
+ * @returns `true` if `u` has the type {@link ProtocolVersion}.
+ */
+export const is = Schema.is(ProtocolVersionSchema);
+/**
+ * Represents the minimum supported protocol version.
+ */
+export const MinSupportedVersion = ProtocolVersion(0n);
+/**
+ * Represents the maximum supported protocol version.
+ */
+export const MaxSupportedVersion = ProtocolVersion(BigInt(Number.MAX_SAFE_INTEGER));

package/dist/SerializedTransaction.d.ts

@@ -0,0 +1,9 @@
+import * as Brand from 'effect/Brand';
+/**
+ * A branded `Uint8Array` representing serialized transaction data.
+ */
+export type SerializedTransaction = Brand.Branded<Uint8Array, 'SerializedTransaction'>;
+/**
+ * Constructs a branded `Uint8Array` representing serialized transaction data.
+ */
+export declare const SerializedTransaction: Brand.Brand.Constructor<SerializedTransaction>;

package/dist/SerializedTransaction.js

@@ -0,0 +1,17 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import * as Brand from 'effect/Brand';
+/**
+ * Constructs a branded `Uint8Array` representing serialized transaction data.
+ */
+export const SerializedTransaction = Brand.nominal();

package/dist/SerializedUnprovenTransaction.d.ts

@@ -0,0 +1,9 @@
+import { Brand } from 'effect';
+/**
+ * A branded `Uint8Array` representing serialized unproven transaction data.
+ */
+export type SerializedUnprovenTransaction = Brand.Branded<Uint8Array, 'SerializedUnprovenTransaction'>;
+/**
+ * Constructs a branded `Uint8Array` representing serialized unproven transaction data.
+ */
+export declare const SerializedUnprovenTransaction: Brand.Brand.Constructor<SerializedUnprovenTransaction>;

package/dist/SerializedUnprovenTransaction.js

@@ -0,0 +1,17 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import { Brand } from 'effect';
+/**
+ * Constructs a branded `Uint8Array` representing serialized unproven transaction data.
+ */
+export const SerializedUnprovenTransaction = Brand.nominal();

package/dist/WalletSeed.d.ts

@@ -0,0 +1,28 @@
+import * as Brand from 'effect/Brand';
+import * as Schema from 'effect/Schema';
+/**
+ * A branded `Uint8Array` that represents a BIP32 compatible seed phrase.
+ */
+export type WalletSeed = Brand.Branded<Uint8Array, 'WalletSeed'>;
+/**
+ * Constructs a branded `Uint8Array` representing a BIP32 compatible seed phrase.
+ */
+export declare const WalletSeed: Brand.Brand.Constructor<WalletSeed>;
+/**
+ * A schema that transforms an array of numbers into a {@link WalletSeed}.
+ */
+export declare const WalletSeedSchema: Schema.BrandSchema<Uint8Array<ArrayBufferLike> & Uint8Array<ArrayBufferLike> & Brand.Brand<"WalletSeed">, readonly number[], never>;
+/**
+ * A type predicate that determines if a given value is a {@link WalletSeed}.
+ *
+ * @param u The value to test.
+ * @returns `true` if `u` has the type {@link WalletSeed}.
+ */
+export declare const is: (u: unknown, overrideOptions?: import("effect/SchemaAST").ParseOptions | number) => u is Uint8Array<ArrayBufferLike> & Uint8Array<ArrayBufferLike> & Brand.Brand<"WalletSeed">;
+/**
+ * Constructs a {@link WalletSeed} from a string representation of a BIP32 compatible seed phrase.
+ *
+ * @param strValue The string value.
+ * @returns A {@link WalletSeed} created from `strValue`.
+ */
+export declare const fromString: (strValue: string) => WalletSeed;

package/dist/WalletSeed.js

@@ -0,0 +1,36 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import * as Brand from 'effect/Brand';
+import * as Schema from 'effect/Schema';
+/**
+ * Constructs a branded `Uint8Array` representing a BIP32 compatible seed phrase.
+ */
+export const WalletSeed = Brand.nominal();
+/**
+ * A schema that transforms an array of numbers into a {@link WalletSeed}.
+ */
+export const WalletSeedSchema = Schema.Uint8Array.pipe(Schema.fromBrand(WalletSeed));
+/**
+ * A type predicate that determines if a given value is a {@link WalletSeed}.
+ *
+ * @param u The value to test.
+ * @returns `true` if `u` has the type {@link WalletSeed}.
+ */
+export const is = Schema.is(WalletSeedSchema);
+/**
+ * Constructs a {@link WalletSeed} from a string representation of a BIP32 compatible seed phrase.
+ *
+ * @param strValue The string value.
+ * @returns A {@link WalletSeed} created from `strValue`.
+ */
+export const fromString = (strValue) => WalletSeed(Buffer.from(strValue, 'hex'));

package/dist/WalletState.d.ts

@@ -0,0 +1,22 @@
+import * as Brand from 'effect/Brand';
+import * as Schema from 'effect/Schema';
+/**
+ * A branded `string` representing serialized (JSON) wallet state made up of local state, transaction history,
+ * and block height.
+ */
+export type WalletState = Brand.Branded<string, 'WalletState'>;
+/**
+ * Constructs a branded `string` representing serialized (JSON) wallet state.
+ */
+export declare const WalletState: Brand.Brand.Constructor<WalletState>;
+/**
+ * A schema that transforms a string into a {@link WalletState}.
+ */
+export declare const WalletStateSchema: Schema.BrandSchema<string & Brand.Brand<"WalletState">, string, never>;
+/**
+ * A type predicate that determines if a given value is a {@link WalletState}.
+ *
+ * @param u The value to test.
+ * @returns `true` if `u` has the type {@link WalletState}.
+ */
+export declare const is: (u: unknown, overrideOptions?: import("effect/SchemaAST").ParseOptions | number) => u is string & Brand.Brand<"WalletState">;

package/dist/WalletState.js

@@ -0,0 +1,29 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import * as Brand from 'effect/Brand';
+import * as Schema from 'effect/Schema';
+/**
+ * Constructs a branded `string` representing serialized (JSON) wallet state.
+ */
+export const WalletState = Brand.nominal();
+/**
+ * A schema that transforms a string into a {@link WalletState}.
+ */
+export const WalletStateSchema = Schema.String.pipe(Schema.fromBrand(WalletState));
+/**
+ * A type predicate that determines if a given value is a {@link WalletState}.
+ *
+ * @param u The value to test.
+ * @returns `true` if `u` has the type {@link WalletState}.
+ */
+export const is = Schema.is(WalletStateSchema);

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * as WalletSeed from './WalletSeed.js';
+export * as WalletState from './WalletState.js';
+export * from './SerializedTransaction.js';
+export * from './SerializedUnprovenTransaction.js';
+export * as ProtocolState from './ProtocolState.js';
+export * as ProtocolVersion from './ProtocolVersion.js';
+export * as NetworkId from './NetworkId.js';

package/dist/index.js

@@ -0,0 +1,19 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 2025 Midnight Foundation
+// SPDX-License-Identifier: Apache-2.0
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+export * as WalletSeed from './WalletSeed.js';
+export * as WalletState from './WalletState.js';
+export * from './SerializedTransaction.js';
+export * from './SerializedUnprovenTransaction.js';
+export * as ProtocolState from './ProtocolState.js';
+export * as ProtocolVersion from './ProtocolVersion.js';
+export * as NetworkId from './NetworkId.js';

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@midnight-ntwrk/wallet-sdk-abstractions",
+  "description": "Domain-specific abstractions for the wallet SDK",
+  "version": "1.0.0-beta.9",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "author": "Midnight Foundation",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com/"
+  },
+  "files": [
+    "dist/"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/midnight-ntwrk/artifacts.git"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "effect": "^3.17.3"
+  },
+  "devDependencies": {
+    "eslint": "^9.37.0",
+    "fast-check": "^4.2.0",
+    "publint": "~0.3.14",
+    "rimraf": "^6.0.1",
+    "to-words": "^4.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  },
+  "scripts": {
+    "typecheck": "tsc -b ./tsconfig.json --noEmit",
+    "test": "vitest run",
+    "lint": "eslint --max-warnings 0",
+    "format": "prettier --write \"**/*.{ts,js,json,yaml,yml}\"",
+    "format:check": "prettier --check \"**/*.{ts,js,json,yaml,yml}\"",
+    "dist": "tsc -b ./tsconfig.build.json",
+    "dist:publish": "tsc -b ./tsconfig.publish.json",
+    "clean": "rimraf --glob dist 'tsconfig.*.tsbuildinfo' && date +%s > .clean-timestamp",
+    "publint": "publint --strict"
+  }
+}