@iota/wallet-standard 0.1.0

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@iota/wallet-standard",
+  "version": "0.1.0",
+  "description": "A suite of standard utilities for implementing wallets based on the Wallet Standard.",
+  "license": "Apache-2.0",
+  "author": "IOTA Foundation <contact@iota.org>",
+  "type": "commonjs",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "CHANGELOG.md",
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@wallet-standard/core": "1.0.3",
+    "@iota/iota-sdk": "0.1.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.3",
+    "@iota/build-scripts": "0.0.0"
+  },
+  "scripts": {
+    "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
+    "build": "build-package",
+    "prettier:check": "prettier -c --ignore-unknown --ignore-path=../../.prettierignore --ignore-path=.prettierignore .",
+    "prettier:fix": "prettier -w --ignore-unknown --ignore-path=../../.prettierignore --ignore-path=.prettierignore .",
+    "eslint:check": "eslint --max-warnings=0 .",
+    "eslint:fix": "pnpm run eslint:check --fix",
+    "lint": "pnpm run eslint:check && pnpm run prettier:check",
+    "lint:fix": "pnpm run eslint:fix && pnpm run prettier:fix"
+  }
+}

package/src/chains.ts

@@ -0,0 +1,16 @@
+// Copyright (c) Mysten Labs, Inc.
+// Modifications Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+import { getAllNetworks } from '@iota/iota-sdk/client';
+import type { IdentifierString } from '@wallet-standard/core';
+
+export const SUPPORTED_CHAINS = Object.values(getAllNetworks()).map((network) => network.chain);
+
+/**
+ * Utility that returns whether or not a chain identifier is a supported chain.
+ * @param chain a chain identifier in the form of `${string}:{$string}`
+ */
+export function isSupportedChain(chain: IdentifierString): boolean {
+    return SUPPORTED_CHAINS.includes(chain);
+}

package/src/detect.ts

@@ -0,0 +1,32 @@
+// Copyright (c) Mysten Labs, Inc.
+// Modifications Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Wallet, WalletWithFeatures } from '@wallet-standard/core';
+
+import type { MinimallyRequiredFeatures, WalletWithIotaFeatures } from './features/index.js';
+
+// These features are absolutely required for wallets to function in the Iota ecosystem.
+// Eventually, as wallets have more consistent support of features, we may want to extend this list.
+const REQUIRED_FEATURES: (keyof MinimallyRequiredFeatures)[] = [
+    'standard:connect',
+    'standard:events',
+];
+
+/** @deprecated Use isWalletWithRequiredFeatureSet instead since it provides more accurate typing! */
+export function isWalletWithIotaFeatures(
+    wallet: Wallet,
+    /** Extra features that are required to be present, in addition to the expected feature set. */
+    features: string[] = [],
+): wallet is WalletWithIotaFeatures {
+    return [...REQUIRED_FEATURES, ...features].every((feature) => feature in wallet.features);
+}
+
+export function isWalletWithRequiredFeatureSet<AdditionalFeatures extends Wallet['features']>(
+    wallet: Wallet,
+    additionalFeatures: (keyof AdditionalFeatures)[] = [],
+): wallet is WalletWithFeatures<MinimallyRequiredFeatures & AdditionalFeatures> {
+    return [...REQUIRED_FEATURES, ...additionalFeatures].every(
+        (feature) => feature in wallet.features,
+    );
+}

package/src/features/index.ts

@@ -0,0 +1,50 @@
+// Copyright (c) Mysten Labs, Inc.
+// Modifications Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+import type {
+    IdentifierRecord,
+    StandardConnectFeature,
+    StandardDisconnectFeature,
+    StandardEventsFeature,
+    WalletWithFeatures,
+} from '@wallet-standard/core';
+
+import type { IotaSignAndExecuteTransactionBlockFeature } from './iotaSignAndExecuteTransactionBlock.js';
+import type { IotaSignMessageFeature } from './iotaSignMessage.js';
+import type { IotaSignPersonalMessageFeature } from './iotaSignPersonalMessage.js';
+import type { IotaSignTransactionBlockFeature } from './iotaSignTransactionBlock.js';
+
+/**
+ * Wallet Standard features that are unique to Iota, and that all Iota wallets are expected to implement.
+ */
+export type IotaFeatures = IotaSignTransactionBlockFeature &
+    IotaSignAndExecuteTransactionBlockFeature &
+    IotaSignPersonalMessageFeature &
+    // This deprecated feature should be removed once wallets update to the new method:
+    Partial<IotaSignMessageFeature>;
+
+export type WalletWithIotaFeatures = WalletWithFeatures<
+    StandardConnectFeature &
+        StandardEventsFeature &
+        IotaFeatures &
+        // Disconnect is an optional feature:
+        Partial<StandardDisconnectFeature>
+>;
+
+/**
+ * Represents a wallet with the absolute minimum feature set required to function in the Iota ecosystem.
+ */
+export type WalletWithRequiredFeatures = WalletWithFeatures<
+    MinimallyRequiredFeatures &
+        Partial<IotaFeatures> &
+        Partial<StandardDisconnectFeature> &
+        IdentifierRecord<unknown>
+>;
+
+export type MinimallyRequiredFeatures = StandardConnectFeature & StandardEventsFeature;
+
+export * from './iotaSignMessage.js';
+export * from './iotaSignTransactionBlock.js';
+export * from './iotaSignAndExecuteTransactionBlock.js';
+export * from './iotaSignPersonalMessage.js';

package/src/features/iotaSignAndExecuteTransactionBlock.ts

@@ -0,0 +1,46 @@
+// Copyright (c) Mysten Labs, Inc.
+// Modifications Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+import type {
+    ExecuteTransactionRequestType,
+    IotaTransactionBlockResponse,
+    IotaTransactionBlockResponseOptions,
+} from '@iota/iota-sdk/client';
+
+import type { IotaSignTransactionBlockInput } from './iotaSignTransactionBlock.js';
+
+/** The latest API version of the signAndExecuteTransactionBlock API. */
+export type IotaSignAndExecuteTransactionBlockVersion = '1.0.0';
+
+/**
+ * A Wallet Standard feature for signing a transaction, and submitting it to the
+ * network. The wallet is expected to submit the transaction to the network via RPC,
+ * and return the transaction response.
+ */
+export type IotaSignAndExecuteTransactionBlockFeature = {
+    /** Namespace for the feature. */
+    'iota:signAndExecuteTransactionBlock': {
+        /** Version of the feature API. */
+        version: IotaSignAndExecuteTransactionBlockVersion;
+        signAndExecuteTransactionBlock: IotaSignAndExecuteTransactionBlockMethod;
+    };
+};
+
+export type IotaSignAndExecuteTransactionBlockMethod = (
+    input: IotaSignAndExecuteTransactionBlockInput,
+) => Promise<IotaSignAndExecuteTransactionBlockOutput>;
+
+/** Input for signing and sending transactions. */
+export interface IotaSignAndExecuteTransactionBlockInput extends IotaSignTransactionBlockInput {
+    /**
+     * `WaitForEffectsCert` or `WaitForLocalExecution`, see details in `ExecuteTransactionRequestType`.
+     * Defaults to `WaitForLocalExecution` if options.showEffects or options.showEvents is true
+     */
+    requestType?: ExecuteTransactionRequestType;
+    /** specify which fields to return (e.g., transaction, effects, events, etc). By default, only the transaction digest will be returned. */
+    options?: IotaTransactionBlockResponseOptions;
+}
+
+/** Output of signing and sending transactions. */
+export interface IotaSignAndExecuteTransactionBlockOutput extends IotaTransactionBlockResponse {}

package/src/features/iotaSignMessage.ts

@@ -0,0 +1,47 @@
+// Copyright (c) Mysten Labs, Inc.
+// Modifications Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+import type { WalletAccount } from '@wallet-standard/core';
+
+/**
+ * The latest API version of the signMessage API.
+ * @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `iota:signPersonalMessage` feature
+ */
+export type IotaSignMessageVersion = '1.0.0';
+
+/**
+ * A Wallet Standard feature for signing a personal message, and returning the
+ * message bytes that were signed, and message signature.
+ *
+ * @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `iota:signPersonalMessage` feature
+ */
+export type IotaSignMessageFeature = {
+    /** Namespace for the feature. */
+    'iota:signMessage': {
+        /** Version of the feature API. */
+        version: IotaSignMessageVersion;
+        signMessage: IotaSignMessageMethod;
+    };
+};
+
+/** @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `iota:signPersonalMessage` feature */
+export type IotaSignMessageMethod = (input: IotaSignMessageInput) => Promise<IotaSignMessageOutput>;
+
+/**
+ * Input for signing messages.
+ * @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `iota:signPersonalMessage` feature
+ */
+export interface IotaSignMessageInput {
+    message: Uint8Array;
+    account: WalletAccount;
+}
+
+/**
+ * Output of signing messages.
+ * @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `iota:signPersonalMessage` feature
+ */
+export interface IotaSignMessageOutput {
+    messageBytes: string;
+    signature: string;
+}

package/src/features/iotaSignPersonalMessage.ts

@@ -0,0 +1,39 @@
+// Copyright (c) Mysten Labs, Inc.
+// Modifications Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+import type { WalletAccount } from '@wallet-standard/core';
+
+/** The latest API version of the signPersonalMessage API. */
+export type IotaSignPersonalMessageVersion = '1.0.0';
+
+/**
+ * A Wallet Standard feature for signing a personal message, and returning the
+ * message bytes that were signed, and message signature.
+ */
+export type IotaSignPersonalMessageFeature = {
+    /** Namespace for the feature. */
+    'iota:signPersonalMessage': {
+        /** Version of the feature API. */
+        version: IotaSignPersonalMessageVersion;
+        signPersonalMessage: IotaSignPersonalMessageMethod;
+    };
+};
+
+export type IotaSignPersonalMessageMethod = (
+    input: IotaSignPersonalMessageInput,
+) => Promise<IotaSignPersonalMessageOutput>;
+
+/** Input for signing personal messages. */
+export interface IotaSignPersonalMessageInput {
+    message: Uint8Array;
+    account: WalletAccount;
+}
+
+/** Output of signing personal messages. */
+export interface IotaSignPersonalMessageOutput extends SignedPersonalMessage {}
+
+export interface SignedPersonalMessage {
+    bytes: string;
+    signature: string;
+}

package/src/features/iotaSignTransactionBlock.ts

@@ -0,0 +1,41 @@
+// Copyright (c) Mysten Labs, Inc.
+// Modifications Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+import type { TransactionBlock } from '@iota/iota-sdk/transactions';
+import type { IdentifierString, WalletAccount } from '@wallet-standard/core';
+
+/** The latest API version of the signTransactionBlock API. */
+export type IotaSignTransactionBlockVersion = '1.0.0';
+
+/**
+ * A Wallet Standard feature for signing a transaction, and returning the
+ * serialized transaction and transaction signature.
+ */
+export type IotaSignTransactionBlockFeature = {
+    /** Namespace for the feature. */
+    'iota:signTransactionBlock': {
+        /** Version of the feature API. */
+        version: IotaSignTransactionBlockVersion;
+        signTransactionBlock: IotaSignTransactionBlockMethod;
+    };
+};
+
+export type IotaSignTransactionBlockMethod = (
+    input: IotaSignTransactionBlockInput,
+) => Promise<IotaSignTransactionBlockOutput>;
+
+/** Input for signing transactions. */
+export interface IotaSignTransactionBlockInput {
+    transactionBlock: TransactionBlock;
+    account: WalletAccount;
+    chain: IdentifierString;
+}
+
+/** Output of signing transactions. */
+export interface IotaSignTransactionBlockOutput extends SignedTransactionBlock {}
+
+export interface SignedTransactionBlock {
+    transactionBlockBytes: string;
+    signature: string;
+}

package/src/index.ts

@@ -0,0 +1,10 @@
+// Copyright (c) Mysten Labs, Inc.
+// Modifications Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+export * from '@wallet-standard/core';
+
+export type { Wallet } from './wallet.js';
+export * from './features/index.js';
+export * from './detect.js';
+export * from './chains.js';

package/src/wallet.ts

@@ -0,0 +1,16 @@
+// Copyright (c) Mysten Labs, Inc.
+// Modifications Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+declare module '@wallet-standard/core' {
+    export interface Wallet {
+        /**
+         * Unique identifier of the Wallet.
+         *
+         * If not provided, the wallet name will be used as the identifier.
+         */
+        readonly id?: string;
+    }
+}
+
+export type { Wallet } from '@wallet-standard/core';