@dfns/lib-viem 0.1.2

package/index.d.ts

@@ -0,0 +1,230 @@
+import { DfnsApiClient } from '@dfns/sdk';
+import { Address, SignableMessage, Hash, TypedDataDefinition, TransactionSerializable, SerializeTransactionFn } from 'viem';
+export type DfnsWalletOptions = {
+    walletId: string;
+    dfnsClient: DfnsApiClient;
+    maxRetries?: number;
+    retryInterval?: number;
+};
+export declare class DfnsWallet {
+    address: Address;
+    private options;
+    constructor(address: Address, options: DfnsWalletOptions);
+    static init(options: DfnsWalletOptions): Promise<DfnsWallet>;
+    private waitForSignature;
+    private signHash;
+    signMessage: ({ message }: {
+        message: SignableMessage;
+    }) => Promise<Hash>;
+    signTransaction: <TTransactionSerializable extends TransactionSerializable>(transaction: TTransactionSerializable, args?: {
+        serializer?: SerializeTransactionFn<TTransactionSerializable> | undefined;
+    } | undefined) => Promise<Hash>;
+    signTypedData: <const TTypedData extends {
+        [x: string]: readonly import("viem").TypedDataParameter[];
+        [x: `string[${string}]`]: undefined;
+        [x: `function[${string}]`]: undefined;
+        [x: `address[${string}]`]: undefined;
+        [x: `bool[${string}]`]: undefined;
+        [x: `bytes[${string}]`]: undefined;
+        [x: `bytes4[${string}]`]: undefined;
+        [x: `bytes2[${string}]`]: undefined;
+        [x: `bytes1[${string}]`]: undefined;
+        [x: `bytes6[${string}]`]: undefined;
+        [x: `bytes18[${string}]`]: undefined;
+        [x: `bytes8[${string}]`]: undefined;
+        [x: `bytes24[${string}]`]: undefined;
+        [x: `bytes10[${string}]`]: undefined;
+        [x: `bytes12[${string}]`]: undefined;
+        [x: `bytes7[${string}]`]: undefined;
+        [x: `bytes9[${string}]`]: undefined;
+        [x: `bytes11[${string}]`]: undefined;
+        [x: `bytes5[${string}]`]: undefined;
+        [x: `bytes3[${string}]`]: undefined;
+        [x: `bytes17[${string}]`]: undefined;
+        [x: `bytes16[${string}]`]: undefined;
+        [x: `bytes15[${string}]`]: undefined;
+        [x: `bytes14[${string}]`]: undefined;
+        [x: `bytes13[${string}]`]: undefined;
+        [x: `bytes19[${string}]`]: undefined;
+        [x: `bytes20[${string}]`]: undefined;
+        [x: `bytes21[${string}]`]: undefined;
+        [x: `bytes22[${string}]`]: undefined;
+        [x: `bytes23[${string}]`]: undefined;
+        [x: `bytes25[${string}]`]: undefined;
+        [x: `bytes26[${string}]`]: undefined;
+        [x: `bytes27[${string}]`]: undefined;
+        [x: `bytes28[${string}]`]: undefined;
+        [x: `bytes29[${string}]`]: undefined;
+        [x: `bytes30[${string}]`]: undefined;
+        [x: `bytes31[${string}]`]: undefined;
+        [x: `bytes32[${string}]`]: undefined;
+        [x: `int[${string}]`]: undefined;
+        [x: `int8[${string}]`]: undefined;
+        [x: `int24[${string}]`]: undefined;
+        [x: `int16[${string}]`]: undefined;
+        [x: `int32[${string}]`]: undefined;
+        [x: `int40[${string}]`]: undefined;
+        [x: `int48[${string}]`]: undefined;
+        [x: `int56[${string}]`]: undefined;
+        [x: `int64[${string}]`]: undefined;
+        [x: `int72[${string}]`]: undefined;
+        [x: `int80[${string}]`]: undefined;
+        [x: `int88[${string}]`]: undefined;
+        [x: `int96[${string}]`]: undefined;
+        [x: `int104[${string}]`]: undefined;
+        [x: `int112[${string}]`]: undefined;
+        [x: `int120[${string}]`]: undefined;
+        [x: `int128[${string}]`]: undefined;
+        [x: `int136[${string}]`]: undefined;
+        [x: `int144[${string}]`]: undefined;
+        [x: `int152[${string}]`]: undefined;
+        [x: `int160[${string}]`]: undefined;
+        [x: `int168[${string}]`]: undefined;
+        [x: `int176[${string}]`]: undefined;
+        [x: `int184[${string}]`]: undefined;
+        [x: `int192[${string}]`]: undefined;
+        [x: `int200[${string}]`]: undefined;
+        [x: `int208[${string}]`]: undefined;
+        [x: `int216[${string}]`]: undefined;
+        [x: `int224[${string}]`]: undefined;
+        [x: `int232[${string}]`]: undefined;
+        [x: `int240[${string}]`]: undefined;
+        [x: `int248[${string}]`]: undefined;
+        [x: `int256[${string}]`]: undefined;
+        [x: `uint[${string}]`]: undefined;
+        [x: `uint8[${string}]`]: undefined;
+        [x: `uint24[${string}]`]: undefined;
+        [x: `uint16[${string}]`]: undefined;
+        [x: `uint32[${string}]`]: undefined;
+        [x: `uint40[${string}]`]: undefined;
+        [x: `uint48[${string}]`]: undefined;
+        [x: `uint56[${string}]`]: undefined;
+        [x: `uint64[${string}]`]: undefined;
+        [x: `uint72[${string}]`]: undefined;
+        [x: `uint80[${string}]`]: undefined;
+        [x: `uint88[${string}]`]: undefined;
+        [x: `uint96[${string}]`]: undefined;
+        [x: `uint104[${string}]`]: undefined;
+        [x: `uint112[${string}]`]: undefined;
+        [x: `uint120[${string}]`]: undefined;
+        [x: `uint128[${string}]`]: undefined;
+        [x: `uint136[${string}]`]: undefined;
+        [x: `uint144[${string}]`]: undefined;
+        [x: `uint152[${string}]`]: undefined;
+        [x: `uint160[${string}]`]: undefined;
+        [x: `uint168[${string}]`]: undefined;
+        [x: `uint176[${string}]`]: undefined;
+        [x: `uint184[${string}]`]: undefined;
+        [x: `uint192[${string}]`]: undefined;
+        [x: `uint200[${string}]`]: undefined;
+        [x: `uint208[${string}]`]: undefined;
+        [x: `uint216[${string}]`]: undefined;
+        [x: `uint224[${string}]`]: undefined;
+        [x: `uint232[${string}]`]: undefined;
+        [x: `uint240[${string}]`]: undefined;
+        [x: `uint248[${string}]`]: undefined;
+        [x: `uint256[${string}]`]: undefined;
+        string?: undefined;
+        address?: undefined;
+        bool?: undefined;
+        bytes?: undefined;
+        bytes4?: undefined;
+        bytes2?: undefined;
+        bytes1?: undefined;
+        bytes6?: undefined;
+        bytes18?: undefined;
+        bytes8?: undefined;
+        bytes24?: undefined;
+        bytes10?: undefined;
+        bytes12?: undefined;
+        bytes7?: undefined;
+        bytes9?: undefined;
+        bytes11?: undefined;
+        bytes5?: undefined;
+        bytes3?: undefined;
+        bytes17?: undefined;
+        bytes16?: undefined;
+        bytes15?: undefined;
+        bytes14?: undefined;
+        bytes13?: undefined;
+        bytes19?: undefined;
+        bytes20?: undefined;
+        bytes21?: undefined;
+        bytes22?: undefined;
+        bytes23?: undefined;
+        bytes25?: undefined;
+        bytes26?: undefined;
+        bytes27?: undefined;
+        bytes28?: undefined;
+        bytes29?: undefined;
+        bytes30?: undefined;
+        bytes31?: undefined;
+        bytes32?: undefined;
+        int8?: undefined;
+        int24?: undefined;
+        int16?: undefined;
+        int32?: undefined;
+        int40?: undefined;
+        int48?: undefined;
+        int56?: undefined;
+        int64?: undefined;
+        int72?: undefined;
+        int80?: undefined;
+        int88?: undefined;
+        int96?: undefined;
+        int104?: undefined;
+        int112?: undefined;
+        int120?: undefined;
+        int128?: undefined;
+        int136?: undefined;
+        int144?: undefined;
+        int152?: undefined;
+        int160?: undefined;
+        int168?: undefined;
+        int176?: undefined;
+        int184?: undefined;
+        int192?: undefined;
+        int200?: undefined;
+        int208?: undefined;
+        int216?: undefined;
+        int224?: undefined;
+        int232?: undefined;
+        int240?: undefined;
+        int248?: undefined;
+        int256?: undefined;
+        uint8?: undefined;
+        uint24?: undefined;
+        uint16?: undefined;
+        uint32?: undefined;
+        uint40?: undefined;
+        uint48?: undefined;
+        uint56?: undefined;
+        uint64?: undefined;
+        uint72?: undefined;
+        uint80?: undefined;
+        uint88?: undefined;
+        uint96?: undefined;
+        uint104?: undefined;
+        uint112?: undefined;
+        uint120?: undefined;
+        uint128?: undefined;
+        uint136?: undefined;
+        uint144?: undefined;
+        uint152?: undefined;
+        uint160?: undefined;
+        uint168?: undefined;
+        uint176?: undefined;
+        uint184?: undefined;
+        uint192?: undefined;
+        uint200?: undefined;
+        uint208?: undefined;
+        uint216?: undefined;
+        uint224?: undefined;
+        uint232?: undefined;
+        uint240?: undefined;
+        uint248?: undefined;
+        uint256?: undefined;
+    } | {
+        [key: string]: unknown;
+    }, TPrimaryType extends string = string>(typedData: TypedDataDefinition<TTypedData, TPrimaryType>) => Promise<Hash>;
+}

package/index.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DfnsWallet = void 0;
+const Wallets_1 = require("@dfns/sdk/codegen/datamodel/Wallets");
+const viem_1 = require("viem");
+const accounts_1 = require("viem/accounts");
+const sleep = (interval = 0) => new Promise((resolve) => setTimeout(resolve, interval));
+class DfnsWallet {
+    constructor(address, options) {
+        // must use the arrow syntax to bind `this` to all public methods, otherwise, after
+        // viem's `toAccount`, the returned LocalAccount will not be able to resolve `this`
+        // on method calls to `signMessage` and `signTypedData`
+        this.signMessage = async ({ message }) => {
+            const signature = await this.signHash((0, viem_1.hashMessage)(message));
+            return (0, viem_1.signatureToHex)(signature);
+        };
+        this.signTransaction = async (transaction, args) => {
+            let serializer = args?.serializer;
+            if (!serializer) {
+                serializer = viem_1.serializeTransaction;
+            }
+            const hash = (0, viem_1.keccak256)(serializer(transaction));
+            const signature = await this.signHash(hash);
+            return serializer(transaction, signature);
+        };
+        this.signTypedData = async (typedData) => {
+            const hash = (0, viem_1.hashTypedData)(typedData);
+            const signature = await this.signHash(hash);
+            return (0, viem_1.signatureToHex)(signature);
+        };
+        this.address = address;
+        this.options = {
+            ...options,
+            maxRetries: options.maxRetries ?? 3,
+            retryInterval: options.retryInterval ?? 1000,
+        };
+    }
+    static async init(options) {
+        const { walletId, dfnsClient } = options;
+        const res = await dfnsClient.wallets.getWallet({ walletId });
+        if (!res.signingKey || res.signingKey.scheme !== Wallets_1.KeyScheme.ECDSA || res.signingKey.curve !== Wallets_1.KeyCurve.secp256k1) {
+            throw new Error(`wallet ${walletId} has incompatible scheme (${res.signingKey?.scheme}) or curve (${res.signingKey?.curve})`);
+        }
+        let address;
+        if (res.address) {
+            address = (0, viem_1.getAddress)(res.address);
+        }
+        else {
+            address = (0, accounts_1.publicKeyToAddress)((0, viem_1.toHex)(res.signingKey.publicKey));
+        }
+        return new DfnsWallet(address, options);
+    }
+    async waitForSignature(signatureId) {
+        const { walletId, dfnsClient, retryInterval } = this.options;
+        let maxRetries = this.options.maxRetries;
+        while (maxRetries > 0) {
+            await sleep(retryInterval);
+            const res = await dfnsClient.wallets.getSignature({ walletId, signatureId });
+            if (res.status === Wallets_1.SignatureStatus.Signed) {
+                if (!res.signature)
+                    break;
+                return {
+                    r: res.signature.r,
+                    s: res.signature.s,
+                    v: res.signature.recid ? 28n : 27n,
+                };
+            }
+            else if (res.status === Wallets_1.SignatureStatus.Failed) {
+                break;
+            }
+            maxRetries -= 1;
+        }
+        const waitedSeconds = Math.floor((this.options.maxRetries * retryInterval) / 1000);
+        throw new Error(`Signature request ${signatureId} took more than ${waitedSeconds}s to complete, stopping polling. Please update options "maxRetries" or "retryIntervals" to wait longer.`);
+    }
+    async signHash(hash) {
+        const { walletId, dfnsClient } = this.options;
+        const res = await dfnsClient.wallets.generateSignature({
+            walletId,
+            body: { kind: Wallets_1.SignatureKind.Hash, hash },
+        });
+        return this.waitForSignature(res.id);
+    }
+}
+exports.DfnsWallet = DfnsWallet;

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@dfns/lib-viem",
+  "version": "0.1.2",
+  "dependencies": {
+    "buffer": "6.0.3",
+    "cross-fetch": "3.1.6",
+    "uuid": "9.0.0",
+    "viem": "^1.19.3"
+  },
+  "peerDependencies": {
+    "@dfns/sdk": "0.1.2"
+  },
+  "main": "./index.js",
+  "type": "commonjs"
+}