@midnight-ntwrk/wallet-sdk 1.0.0

package/README.md

@@ -0,0 +1,148 @@
+# @midnight-ntwrk/wallet-sdk
+
+Barrel package for the Midnight Wallet SDK. Instead of installing and importing from multiple
+`@midnight-ntwrk/wallet-sdk-*` packages individually, this package re-exports them all through a single dependency with
+multiple entry points.
+
+## Installation
+
+```bash
+npm install @midnight-ntwrk/wallet-sdk
+```
+
+## Overview
+
+This package provides a unified installation and import experience for the Midnight Wallet SDK. The main entry point
+re-exports the core wallet types, while dedicated sub-path exports give access to each underlying package:
+
+| Entry Point                                 | Re-exports                                                                               |
+| ------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `@midnight-ntwrk/wallet-sdk`                | Core: abstractions, address-format, dust-wallet, facade, hd, shielded, unshielded-wallet |
+| `@midnight-ntwrk/wallet-sdk/address-format` | `@midnight-ntwrk/wallet-sdk-address-format`                                              |
+| `@midnight-ntwrk/wallet-sdk/capabilities`   | `@midnight-ntwrk/wallet-sdk-capabilities`                                                |
+| `@midnight-ntwrk/wallet-sdk/dust`           | `@midnight-ntwrk/wallet-sdk-dust-wallet`                                                 |
+| `@midnight-ntwrk/wallet-sdk/facade`         | `@midnight-ntwrk/wallet-sdk-facade`                                                      |
+| `@midnight-ntwrk/wallet-sdk/hd`             | `@midnight-ntwrk/wallet-sdk-hd`                                                          |
+| `@midnight-ntwrk/wallet-sdk/proving`        | `@midnight-ntwrk/wallet-sdk-capabilities/proving`                                        |
+| `@midnight-ntwrk/wallet-sdk/shielded`       | `@midnight-ntwrk/wallet-sdk-shielded`                                                    |
+| `@midnight-ntwrk/wallet-sdk/testing`        | `@midnight-ntwrk/wallet-sdk-utilities/testing`                                           |
+| `@midnight-ntwrk/wallet-sdk/unshielded`     | `@midnight-ntwrk/wallet-sdk-unshielded-wallet`                                           |
+
+The Wallet Facade (`WalletFacade`) provides a high-level unified interface that aggregates the functionality of all
+wallet types (shielded, unshielded, and dust). It simplifies wallet operations by providing:
+
+- Combined state management across all wallet types
+- Unified transaction balancing for shielded, unshielded, and dust
+- Coordinated transfer and swap operations
+- Simplified transaction finalization flow
+- Dust registration management
+
+## Usage
+
+### Initializing the Facade
+
+```typescript
+import { WalletFacade } from '@midnight-ntwrk/wallet-sdk';
+
+const facade = new WalletFacade(shieldedWallet, unshieldedWallet, dustWallet);
+
+// Start all wallets
+await facade.start(shieldedSecretKeys, dustSecretKey);
+```
+
+### Observing Combined State
+
+```typescript
+facade.state().subscribe((state) => {
+  console.log('Shielded:', state.shielded);
+  console.log('Unshielded:', state.unshielded);
+  console.log('Dust:', state.dust);
+  console.log('All synced:', state.isSynced);
+});
+
+// Or wait for full sync
+const syncedState = await facade.waitForSyncedState();
+```
+
+### Creating Transfer Transactions
+
+```typescript
+const recipe = await facade.transferTransaction(
+  [
+    {
+      type: 'shielded',
+      outputs: [{ type: 'TOKEN_B', receiverAddress: shieldedAddr, amount: 1000n }],
+    },
+    {
+      type: 'unshielded',
+      outputs: [{ type: 'TOKEN_A', receiverAddress: unshieldedAddr, amount: 500n }],
+    },
+  ],
+  { shieldedSecretKeys, dustSecretKey },
+  { ttl: new Date(Date.now() + 3600000) },
+);
+```
+
+### Balancing Transactions
+
+```typescript
+// Balance a finalized transaction
+const recipe = await facade.balanceFinalizedTransaction(
+  finalizedTx,
+  { shieldedSecretKeys, dustSecretKey },
+  { ttl, tokenKindsToBalance: 'all' }, // or ['shielded', 'dust']
+);
+
+// Finalize the balanced recipe
+const finalTx = await facade.finalizeRecipe(recipe);
+
+// Submit to the network
+const txId = await facade.submitTransaction(finalTx);
+```
+
+### Creating Swap Offers
+
+```typescript
+const swapRecipe = await facade.initSwap(
+  { shielded: { NIGHT: 1000n } }, // inputs
+  [{ type: 'shielded', outputs: [{ type: 'TOKEN_A', receiverAddress, amount: 100n }] }], // outputs
+  { shieldedSecretKeys, dustSecretKey },
+  { ttl, payFees: false },
+);
+```
+
+### Dust Registration
+
+```typescript
+// Register Night UTXOs for dust generation
+const registrationRecipe = await facade.registerNightUtxosForDustGeneration(
+  nightUtxos,
+  nightVerifyingKey,
+  signDustRegistration,
+);
+
+// Estimate registration costs
+const { fee, dustGenerationEstimations } = await facade.estimateRegistration(nightUtxos);
+```
+
+## Types
+
+### BalancingRecipe
+
+The facade returns different recipe types depending on the input transaction:
+
+- `FinalizedTransactionRecipe` - For finalized transactions
+- `UnboundTransactionRecipe` - For unbound transactions
+- `UnprovenTransactionRecipe` - For unproven transactions
+
+### TokenKindsToBalance
+
+Control which token types to balance:
+
+```typescript
+type TokenKindsToBalance = 'all' | ('dust' | 'shielded' | 'unshielded')[];
+```
+
+## License
+
+Apache-2.0

package/dist/address-format.d.ts

@@ -0,0 +1 @@
+export * from '@midnight-ntwrk/wallet-sdk-address-format';

package/dist/address-format.js

@@ -0,0 +1,13 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 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 * from '@midnight-ntwrk/wallet-sdk-address-format';

package/dist/capabilities.d.ts

@@ -0,0 +1 @@
+export * from '@midnight-ntwrk/wallet-sdk-capabilities';

package/dist/capabilities.js

@@ -0,0 +1,13 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 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 * from '@midnight-ntwrk/wallet-sdk-capabilities';

package/dist/dust.d.ts

@@ -0,0 +1 @@
+export * from '@midnight-ntwrk/wallet-sdk-dust-wallet';

package/dist/dust.js

@@ -0,0 +1,13 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 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 * from '@midnight-ntwrk/wallet-sdk-dust-wallet';

package/dist/facade.d.ts

@@ -0,0 +1 @@
+export * from '@midnight-ntwrk/wallet-sdk-facade';

package/dist/facade.js

@@ -0,0 +1,13 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 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 * from '@midnight-ntwrk/wallet-sdk-facade';

package/dist/hd.d.ts

@@ -0,0 +1 @@
+export * from '@midnight-ntwrk/wallet-sdk-hd';

package/dist/hd.js

@@ -0,0 +1,13 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 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 * from '@midnight-ntwrk/wallet-sdk-hd';

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from '@midnight-ntwrk/wallet-sdk-abstractions';
+export * from '@midnight-ntwrk/wallet-sdk-address-format';
+export * from '@midnight-ntwrk/wallet-sdk-dust-wallet';
+export * from '@midnight-ntwrk/wallet-sdk-facade';
+export * from '@midnight-ntwrk/wallet-sdk-hd';
+export * from '@midnight-ntwrk/wallet-sdk-shielded';
+export * from '@midnight-ntwrk/wallet-sdk-unshielded-wallet';

package/dist/index.js

@@ -0,0 +1,19 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 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 * from '@midnight-ntwrk/wallet-sdk-abstractions';
+export * from '@midnight-ntwrk/wallet-sdk-address-format';
+export * from '@midnight-ntwrk/wallet-sdk-dust-wallet';
+export * from '@midnight-ntwrk/wallet-sdk-facade';
+export * from '@midnight-ntwrk/wallet-sdk-hd';
+export * from '@midnight-ntwrk/wallet-sdk-shielded';
+export * from '@midnight-ntwrk/wallet-sdk-unshielded-wallet';

package/dist/proving.d.ts

@@ -0,0 +1 @@
+export * from '@midnight-ntwrk/wallet-sdk-capabilities/proving';

package/dist/proving.js

@@ -0,0 +1,13 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 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 * from '@midnight-ntwrk/wallet-sdk-capabilities/proving';

package/dist/shielded.d.ts

@@ -0,0 +1 @@
+export * from '@midnight-ntwrk/wallet-sdk-shielded';

package/dist/shielded.js

@@ -0,0 +1,13 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 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 * from '@midnight-ntwrk/wallet-sdk-shielded';

package/dist/testing.d.ts

@@ -0,0 +1 @@
+export * from '@midnight-ntwrk/wallet-sdk-utilities/testing';

package/dist/testing.js

@@ -0,0 +1,13 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 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 * from '@midnight-ntwrk/wallet-sdk-utilities/testing';

package/dist/unshielded.d.ts

@@ -0,0 +1 @@
+export * from '@midnight-ntwrk/wallet-sdk-unshielded-wallet';

package/dist/unshielded.js

@@ -0,0 +1,13 @@
+// This file is part of MIDNIGHT-WALLET-SDK.
+// Copyright (C) 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 * from '@midnight-ntwrk/wallet-sdk-unshielded-wallet';

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@midnight-ntwrk/wallet-sdk",
+  "description": "Barrel package re-exporting all Midnight Wallet SDK packages",
+  "version": "1.0.0",
+  "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"
+    },
+    "./address-format": {
+      "types": "./dist/address-format.d.ts",
+      "import": "./dist/address-format.js"
+    },
+    "./capabilities": {
+      "types": "./dist/capabilities.d.ts",
+      "import": "./dist/capabilities.js"
+    },
+    "./dust": {
+      "types": "./dist/dust.d.ts",
+      "import": "./dist/dust.js"
+    },
+    "./facade": {
+      "types": "./dist/facade.d.ts",
+      "import": "./dist/facade.js"
+    },
+    "./hd": {
+      "types": "./dist/hd.d.ts",
+      "import": "./dist/hd.js"
+    },
+    "./proving": {
+      "types": "./dist/proving.d.ts",
+      "import": "./dist/proving.js"
+    },
+    "./shielded": {
+      "types": "./dist/shielded.d.ts",
+      "import": "./dist/shielded.js"
+    },
+    "./testing": {
+      "types": "./dist/testing.d.ts",
+      "import": "./dist/testing.js"
+    },
+    "./unshielded": {
+      "types": "./dist/unshielded.d.ts",
+      "import": "./dist/unshielded.js"
+    }
+  },
+  "dependencies": {
+    "@midnight-ntwrk/wallet-sdk-abstractions": "^2.1.0",
+    "@midnight-ntwrk/wallet-sdk-address-format": "^3.1.1",
+    "@midnight-ntwrk/wallet-sdk-capabilities": "^3.3.0",
+    "@midnight-ntwrk/wallet-sdk-dust-wallet": "^4.0.0",
+    "@midnight-ntwrk/wallet-sdk-facade": "^4.0.0",
+    "@midnight-ntwrk/wallet-sdk-hd": "^3.0.2",
+    "@midnight-ntwrk/wallet-sdk-shielded": "^3.0.0",
+    "@midnight-ntwrk/wallet-sdk-unshielded-wallet": "^3.0.0",
+    "@midnight-ntwrk/wallet-sdk-utilities": "^1.1.1"
+  },
+  "scripts": {
+    "typecheck": "tsc -b ./tsconfig.json --noEmit --force",
+    "lint": "eslint --max-warnings 0",
+    "format": "prettier --write \"**/*.{ts,js,json,yaml,yml,md}\"",
+    "format:check": "prettier --check \"**/*.{ts,js,json,yaml,yml,md}\"",
+    "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"
+  }
+}