@miden-sdk/miden-wallet-adapter-base 0.15.1 → 0.15.2

package/__tests__/signer.test.ts

@@ -0,0 +1,20 @@
+import { describe, it, expect } from 'vitest';
+import type { GuardianInfo } from '../types';
+
+describe('GuardianInfo', () => {
+  it('has the agreed shape', () => {
+    const g: GuardianInfo = {
+      isGuardianAccount: false,
+      guardianEndpoint: null,
+      guardianProvider: null,
+      guardianSyncStatus: null,
+    };
+
+    expect(Object.keys(g).sort()).toEqual([
+      'guardianEndpoint',
+      'guardianProvider',
+      'guardianSyncStatus',
+      'isGuardianAccount',
+    ]);
+  });
+});

package/dist/__tests__/signer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/signer.test.js

@@ -0,0 +1,18 @@
+import { describe, it, expect } from 'vitest';
+describe('GuardianInfo', () => {
+    it('has the agreed shape', () => {
+        const g = {
+            isGuardianAccount: false,
+            guardianEndpoint: null,
+            guardianProvider: null,
+            guardianSyncStatus: null,
+        };
+        expect(Object.keys(g).sort()).toEqual([
+            'guardianEndpoint',
+            'guardianProvider',
+            'guardianSyncStatus',
+            'isGuardianAccount',
+        ]);
+    });
+});
+//# sourceMappingURL=signer.test.js.map

package/dist/__tests__/signer.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signer.test.js","sourceRoot":"","sources":["../../__tests__/signer.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAG9C,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,CAAC,GAAiB;YACtB,iBAAiB,EAAE,KAAK;YACxB,gBAAgB,EAAE,IAAI;YACtB,gBAAgB,EAAE,IAAI;YACtB,kBAAkB,EAAE,IAAI;SACzB,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC;YACpC,kBAAkB;YAClB,kBAAkB;YAClB,oBAAoB;YACpB,mBAAmB;SACpB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/signer.d.ts

@@ -2,7 +2,7 @@ import type { NoteFilterTypes } from '@miden-sdk/miden-sdk';
 import type { WalletAdapter, WalletAdapterProps } from './adapter';
 import { BaseWalletAdapter } from './adapter';
 import { MidenConsumeTransaction, MidenSendTransaction, MidenTransaction } from './transaction';
-import { Asset, CreateAccountParams, InputNoteDetails, SignKind, TransactionOutput } from './types';
+import { Asset, CreateAccountParams, GuardianInfo, InputNoteDetails, SignKind, TransactionOutput } from './types';
 export type Adapter = WalletAdapter | SignerWalletAdapter | MessageSignerWalletAdapter;
 export interface SignerWalletAdapterProps<Name extends string = string> extends WalletAdapterProps<Name> {
 }
@@ -12,6 +12,7 @@ export declare abstract class BaseSignerWalletAdapter<Name extends string = stri
 export interface MessageSignerWalletAdapterProps<Name extends string = string> extends WalletAdapterProps<Name> {
     requestTransaction(transaction: MidenTransaction): Promise<string>;
     requestAssets(): Promise<Asset[]>;
+    requestGuardianInfo(): Promise<GuardianInfo>;
     requestPrivateNotes(noteFilterType: NoteFilterTypes, noteIds?: string[]): Promise<InputNoteDetails[]>;
     signBytes(data: Uint8Array, kind: SignKind): Promise<Uint8Array>;
     importPrivateNote(note: Uint8Array): Promise<string>;
@@ -27,6 +28,7 @@ export declare abstract class BaseMessageSignerWalletAdapter<Name extends string
     abstract requestConsume(transaction: MidenConsumeTransaction): Promise<string>;
     abstract requestTransaction(transaction: MidenTransaction): Promise<string>;
     abstract requestAssets(): Promise<Asset[]>;
+    abstract requestGuardianInfo(): Promise<GuardianInfo>;
     abstract requestPrivateNotes(noteFilterType: NoteFilterTypes, noteIds?: string[]): Promise<InputNoteDetails[]>;
     abstract signBytes(data: Uint8Array, kind: SignKind): Promise<Uint8Array>;
     abstract importPrivateNote(note: Uint8Array): Promise<string>;

package/dist/signer.js.map

@@ -1 +1 @@
-{"version":3,"file":"signer.js","sourceRoot":"","sources":["../signer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAmB9C,MAAM,OAAgB,uBACpB,SAAQ,iBAAuB;CACQ;AAyBzC,MAAM,OAAgB,8BAGpB,SAAQ,uBAA6B;CAqBtC"}
+{"version":3,"file":"signer.js","sourceRoot":"","sources":["../signer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAmB9C,MAAM,OAAgB,uBACpB,SAAQ,iBAAuB;CACQ;AA0BzC,MAAM,OAAgB,8BAGpB,SAAQ,uBAA6B;CAsBtC"}

package/dist/types.d.ts

@@ -22,6 +22,12 @@ export interface Asset {
     faucetId: string;
     amount: string;
 }
+export interface GuardianInfo {
+    isGuardianAccount: boolean;
+    guardianEndpoint: string | null;
+    guardianProvider: 'open-zeppelin' | 'gateway' | 'lambda-class' | 'custom' | null;
+    guardianSyncStatus: 'in-sync' | 'out-of-sync' | null;
+}
 export type InputNoteDetails = {
     noteId: string;
     senderAccountId: string | undefined;

package/docs/README.md

@@ -54,6 +54,7 @@
 
 - [Asset](interfaces/Asset.md)
 - [CreateAccountParams](interfaces/CreateAccountParams.md)
+- [GuardianInfo](interfaces/GuardianInfo.md)
 - [IFailedTransactionOutput](interfaces/IFailedTransactionOutput.md)
 - [MessageSignerWalletAdapterProps](interfaces/MessageSignerWalletAdapterProps.md)
 - [MidenConsumeTransaction](interfaces/MidenConsumeTransaction.md)

package/docs/classes/BaseMessageSignerWalletAdapter.md

@@ -664,6 +664,20 @@ Remove the listeners of a given event.
 
 ***
 
+### requestGuardianInfo()
+
+> `abstract` **requestGuardianInfo**(): `Promise`\<[`GuardianInfo`](../interfaces/GuardianInfo.md)\>
+
+#### Returns
+
+`Promise`\<[`GuardianInfo`](../interfaces/GuardianInfo.md)\>
+
+#### Implementation of
+
+`MessageSignerWalletAdapter.requestGuardianInfo`
+
+***
+
 ### requestPrivateNotes()
 
 > `abstract` **requestPrivateNotes**(`noteFilterType`, `noteIds?`): `Promise`\<[`InputNoteDetails`](../type-aliases/InputNoteDetails.md)[]\>

package/docs/interfaces/GuardianInfo.md

@@ -0,0 +1,31 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / GuardianInfo
+
+# Interface: GuardianInfo
+
+## Properties
+
+### guardianEndpoint
+
+> **guardianEndpoint**: `string`
+
+***
+
+### guardianProvider
+
+> **guardianProvider**: `"open-zeppelin"` \| `"gateway"` \| `"lambda-class"` \| `"custom"`
+
+***
+
+### guardianSyncStatus
+
+> **guardianSyncStatus**: `"in-sync"` \| `"out-of-sync"`
+
+***
+
+### isGuardianAccount
+
+> **isGuardianAccount**: `boolean`

package/docs/interfaces/MessageSignerWalletAdapterProps.md

@@ -218,6 +218,16 @@
 
 ***
 
+### requestGuardianInfo()
+
+> **requestGuardianInfo**(): `Promise`\<[`GuardianInfo`](GuardianInfo.md)\>
+
+#### Returns
+
+`Promise`\<[`GuardianInfo`](GuardianInfo.md)\>
+
+***
+
 ### requestPrivateNotes()
 
 > **requestPrivateNotes**(`noteFilterType`, `noteIds?`): `Promise`\<[`InputNoteDetails`](../type-aliases/InputNoteDetails.md)[]\>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@miden-sdk/miden-wallet-adapter-base",
-  "version": "0.15.1",
+  "version": "0.15.2",
   "description": "Core infrastructure for connecting Miden-compatible wallets to your dApp.",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",

package/signer.ts

@@ -6,7 +6,7 @@ import {
   MidenSendTransaction,
   MidenTransaction,
 } from './transaction';
-import { Asset, CreateAccountParams, InputNoteDetails, SignKind, TransactionOutput } from './types';
+import { Asset, CreateAccountParams, GuardianInfo, InputNoteDetails, SignKind, TransactionOutput } from './types';
 
 export type Adapter =
   | WalletAdapter
@@ -27,6 +27,7 @@ export interface MessageSignerWalletAdapterProps<Name extends string = string>
   extends WalletAdapterProps<Name> {
   requestTransaction(transaction: MidenTransaction): Promise<string>;
   requestAssets(): Promise<Asset[]>;
+  requestGuardianInfo(): Promise<GuardianInfo>;
   requestPrivateNotes(
     noteFilterType: NoteFilterTypes,
     noteIds?: string[]
@@ -58,6 +59,7 @@ export abstract class BaseMessageSignerWalletAdapter<
   ): Promise<string>;
   abstract requestTransaction(transaction: MidenTransaction): Promise<string>;
   abstract requestAssets(): Promise<Asset[]>;
+  abstract requestGuardianInfo(): Promise<GuardianInfo>;
   abstract requestPrivateNotes(
     noteFilterType: NoteFilterTypes,
     noteIds?: string[]

package/types.ts

@@ -32,6 +32,18 @@ export interface Asset {
   amount: string;
 }
 
+export interface GuardianInfo {
+  isGuardianAccount: boolean;
+  guardianEndpoint: string | null;
+  guardianProvider:
+    | 'open-zeppelin'
+    | 'gateway'
+    | 'lambda-class'
+    | 'custom'
+    | null;
+  guardianSyncStatus: 'in-sync' | 'out-of-sync' | null;
+}
+
 export type InputNoteDetails = {
   noteId: string;
   senderAccountId: string | undefined;