@morpho-org/blue-sdk 1.0.6 → 1.2.1

package/lib/evm.js

@@ -1,113 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.signMessage = exports.signMessageWithProducer = exports.sendTransaction = exports.sendTransactionWithProducer = void 0;
-const ethers_1 = require("ethers");
-const maths_1 = require("./maths");
-const notifications_1 = require("./notifications");
-const signatures_1 = require("./signatures");
-/**
- * Sends a transaction via the provided signer, optionnally waiting for the corresponding transaction receipt.
- * @param signer The signer to send the tx with.
- * @param tx The transaction request.
- * @param wait Whether to wait for the transaction receipt. Defaults to true.
- * @param notificationOptions The optional notification options. Warning: if `wait` is set to true, the provided topic will never complete.
- */
-const sendTransactionWithProducer = async (signer, req, defaultGasLimit, confirms = 1, notificationOptions) => {
-    let response;
-    try {
-        let gasLimit;
-        try {
-            gasLimit = maths_1.MathLib.wMulUp(await signer.estimateGas(req), (0, ethers_1.parseUnits)("1.1"));
-        }
-        catch (error) {
-            if (defaultGasLimit == null)
-                throw error;
-            gasLimit = defaultGasLimit;
-        }
-        const tx = { ...req, gasLimit };
-        notificationOptions?.producer.next({
-            id: notificationOptions.id,
-            status: notifications_1.NotificationStatus.signing,
-            context: { tx },
-        });
-        response = await signer.sendTransaction(tx);
-        notificationOptions?.producer.next({
-            id: notificationOptions.id,
-            status: notifications_1.NotificationStatus.pending,
-            context: { args: notificationOptions.args, tx, response },
-        });
-        const receipt = await response.wait(confirms);
-        notificationOptions?.producer.next({
-            id: notificationOptions.id,
-            status: notifications_1.NotificationStatus.success,
-            context: { args: notificationOptions.args, tx, response, receipt },
-        });
-    }
-    catch (error) {
-        notificationOptions?.producer.next({
-            id: notificationOptions.id,
-            status: notifications_1.NotificationStatus.error,
-            context: { args: notificationOptions.args, tx: req, response, error },
-        });
-    }
-};
-exports.sendTransactionWithProducer = sendTransactionWithProducer;
-/**
- * Sends a transaction via the provided signer, optionnally waiting for the corresponding transaction receipt.
- * @param signer The signer to send the tx with.
- * @param tx The transaction request.
- * @param wait Whether to wait for the transaction receipt. Defaults to true.
- * @param topic The type of notifications to emit.
- * @param args The optional notification arguments.
- * @return The notification consumer which receives the transaction notifications.
- */
-const sendTransaction = (signer, tx, defaultGasLimit, confirms, args = {}) => {
-    const producer = new notifications_1.NotificationProducer(notifications_1.NotificationTopic.tx);
-    (0, exports.sendTransactionWithProducer)(signer, tx, defaultGasLimit, confirms, {
-        producer,
-        id: Date.now().toString(),
-        args,
-    });
-    return producer.consumer;
-};
-exports.sendTransaction = sendTransaction;
-const signMessageWithProducer = async (signer, message, notificationOptions) => {
-    notificationOptions?.producer.next({
-        id: notificationOptions.id,
-        status: notifications_1.NotificationStatus.signing,
-    });
-    try {
-        const signature = await signatures_1.SignatureUtils.safeSignTypedData(signer, message.data.domain, message.data.types, message.data.value);
-        signatures_1.SignatureUtils.verifySignature(signature, message.hash, await signer.getAddress());
-        notificationOptions?.producer.next({
-            id: notificationOptions.id,
-            status: notifications_1.NotificationStatus.success,
-            context: { message, args: notificationOptions.args, signature },
-        });
-    }
-    catch (error) {
-        notificationOptions?.producer.next({
-            id: notificationOptions.id,
-            status: notifications_1.NotificationStatus.error,
-            context: { message, args: notificationOptions.args, error },
-        });
-    }
-};
-exports.signMessageWithProducer = signMessageWithProducer;
-/**
- * Sends a signature request to the provided signer.
- * @param signer The signer to send the approval with.
- * @param args The approval parameters.
- * @param encodeMessage The approval encoder to pass the approval parameters to get the approval transactions.
- * @return The notification consumer which receives the transaction notifications.
- */
-const signMessage = (signer, args, encodeMessage, chainId) => {
-    const producer = new notifications_1.NotificationProducer(notifications_1.NotificationTopic.signature);
-    (0, exports.signMessageWithProducer)(signer, encodeMessage(args, chainId), {
-        producer,
-        id: Date.now().toString(),
-        args,
-    });
-    return producer.consumer;
-};
-exports.signMessage = signMessage;

package/lib/helpers/getChecksumedAddress.d.ts

@@ -1,7 +0,0 @@
-import { AddressLike } from "ethers";
-/**
- * Transform an AddressLike into a checksumed address
- *
- * @param address Address to transform
- */
-export declare const getChecksumedAddress: (address: AddressLike) => Promise<string>;

package/lib/helpers/getChecksumedAddress.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getChecksumedAddress = void 0;
-const ethers_1 = require("ethers");
-/**
- * Transform an AddressLike into a checksumed address
- *
- * @param address Address to transform
- */
-const getChecksumedAddress = async (address) => {
-    const awaited = await address;
-    // Ethers getAddress function is throwing an error if the address is already checksumed
-    if (typeof awaited === "string")
-        return (0, ethers_1.getAddress)(awaited.toLowerCase());
-    return (0, ethers_1.getAddress)((await awaited.getAddress()).toLowerCase());
-};
-exports.getChecksumedAddress = getChecksumedAddress;

package/lib/helpers/isZeroAddressOrUnset.d.ts

@@ -1,7 +0,0 @@
-/**
- * Check if an address is the zero address, null, or undefined.
- *
- * @param address - The address to check, which can be a valid address, null, or undefined.
- * @returns True if the address is zero, null, or undefined; otherwise, false.
- */
-export declare function isZeroAddressOrUnset(address: string | null | undefined): boolean;

package/lib/helpers/isZeroAddressOrUnset.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isZeroAddressOrUnset = void 0;
-const ethers_1 = require("ethers");
-/**
- * Check if an address is the zero address, null, or undefined.
- *
- * @param address - The address to check, which can be a valid address, null, or undefined.
- * @returns True if the address is zero, null, or undefined; otherwise, false.
- */
-function isZeroAddressOrUnset(address) {
-    return address === undefined || address === null || address === ethers_1.ZeroAddress;
-}
-exports.isZeroAddressOrUnset = isZeroAddressOrUnset;

package/lib/maths/MathUtils.d.ts

@@ -1,15 +0,0 @@
-/**
- * Math utilities
- * This library reproduces the behaviour of the solidity library MathUtils
- * TODO: add library link
- * @category Maths
- */
-export declare class MathUtils {
-    static zeroFloorSub(a: bigint, b: bigint): bigint;
-    static min(a: bigint, b: bigint): bigint;
-    static mins(...args: bigint[]): bigint;
-    static max(a: bigint, b: bigint): bigint;
-    static pos(a: bigint): bigint;
-    static neg(a: bigint): bigint;
-    static abs(a: bigint): bigint;
-}

package/lib/maths/MathUtils.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MathUtils = void 0;
-/**
- * Math utilities
- * This library reproduces the behaviour of the solidity library MathUtils
- * TODO: add library link
- * @category Maths
- */
-class MathUtils {
-    static zeroFloorSub(a, b) {
-        return a - b < 0n ? 0n : a - b;
-    }
-    static min(a, b) {
-        return a < b ? a : b;
-    }
-    static mins(...args) {
-        return args.reduce((a, b) => this.min(a, b));
-    }
-    static max(a, b) {
-        return a > b ? a : b;
-    }
-    static pos(a) {
-        return a >= 0n ? a : 0n;
-    }
-    static neg(a) {
-        return a < 0n ? -a : 0n;
-    }
-    static abs(a) {
-        return a >= 0 ? a : -a;
-    }
-}
-exports.MathUtils = MathUtils;

package/lib/notifications.d.ts

@@ -1,98 +0,0 @@
-import { Signature, TransactionReceipt, TransactionRequest, TransactionResponse } from "ethers";
-import { Observable, Observer, ReplaySubject } from "rxjs";
-import { SignatureMessage } from "./signatures/types";
-export declare enum NotificationStatus {
-    signing = "signing",
-    success = "success",
-    error = "error",
-    pending = "pending"
-}
-export declare enum NotificationTopic {
-    tx = "tx",
-    signature = "signature"
-}
-export interface NotificationContext {
-    [NotificationTopic.tx]: {
-        [NotificationStatus.signing]: {
-            tx: TransactionRequest;
-        };
-        [NotificationStatus.pending]: {
-            args: Record<PropertyKey, any>;
-            tx: TransactionRequest;
-            response?: TransactionResponse;
-        };
-        [NotificationStatus.success]: {
-            args: Record<PropertyKey, any>;
-            tx: TransactionRequest;
-            response?: TransactionResponse;
-            receipt: TransactionReceipt | null;
-        };
-        [NotificationStatus.error]: {
-            args: Record<PropertyKey, any>;
-            tx: TransactionRequest;
-            response?: TransactionResponse;
-            error: Error;
-        };
-    };
-    [NotificationTopic.signature]: {
-        [NotificationStatus.signing]: never;
-        [NotificationStatus.pending]: {
-            message: SignatureMessage;
-            args: Record<PropertyKey, any>;
-        };
-        [NotificationStatus.success]: {
-            message: SignatureMessage;
-            args: Record<PropertyKey, any>;
-            signature: Signature;
-        };
-        [NotificationStatus.error]: {
-            message: SignatureMessage;
-            args: Record<PropertyKey, any>;
-            error: Error;
-        };
-    };
-}
-export interface NotificationBody<Topic extends NotificationTopic = NotificationTopic, Status extends NotificationStatus = NotificationStatus> {
-    id: string;
-    topic: Topic;
-    status: Status;
-}
-export type Notifications = {
-    [Topic in NotificationTopic]: {
-        [Status in NotificationStatus]: NotificationBody<Topic, Status> & (NotificationContext[Topic][Status] extends never ? unknown : {
-            context: NotificationContext[Topic][Status];
-        });
-    };
-};
-export type TxNotification = Notifications[NotificationTopic.tx][NotificationStatus];
-export type SignatureNotification = Notifications[NotificationTopic.signature][NotificationStatus];
-export type Notification = Notifications[NotificationTopic][NotificationStatus];
-export type NotificationsWithoutTopic = {
-    [Topic in NotificationTopic]: {
-        [Status in NotificationStatus]: Omit<NotificationBody<Topic, Status>, "topic"> & (NotificationContext[Topic][Status] extends never ? unknown : {
-            context: NotificationContext[Topic][Status];
-        });
-    };
-};
-export interface NotificationConsumer<Topic extends NotificationTopic> {
-    notifications$: Observable<Notifications[Topic][NotificationStatus]>;
-    wait: (observerOrNext?: Partial<Observer<Notifications[Topic][NotificationStatus]>> | ((value: Notifications[Topic][NotificationStatus]) => void)) => Promise<Notifications[Topic][NotificationStatus.success | NotificationStatus.error]>;
-}
-/**
- * MUST receive a success or error notification at some point to ensure the result promise resolves.
- */
-export declare class NotificationProducer<Topic extends NotificationTopic> {
-    readonly topic: Topic;
-    protected readonly _notifications$: ReplaySubject<Notifications[Topic][NotificationStatus]>;
-    readonly notifications$: Observable<Notifications[Topic][NotificationStatus]>;
-    protected readonly _result: Promise<Notifications[Topic][NotificationStatus]>;
-    readonly consumer: NotificationConsumer<Topic>;
-    /**
-     * Creates a notification producer.
-     * MUST receive a success or error notification at some point to ensure the result promise resolves.
-     * @param topic The notification topic to populate each notification with.
-     */
-    constructor(topic: Topic);
-    wait(observerOrNext?: Partial<Observer<Notifications[Topic][NotificationStatus]>> | ((value: Notifications[Topic][NotificationStatus]) => void)): Promise<Notifications[Topic][NotificationStatus.success | NotificationStatus.error]>;
-    next(notification: NotificationsWithoutTopic[Topic][NotificationStatus]): void;
-}

package/lib/notifications.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotificationProducer = exports.NotificationTopic = exports.NotificationStatus = void 0;
-const rxjs_1 = require("rxjs");
-var NotificationStatus;
-(function (NotificationStatus) {
-    NotificationStatus["signing"] = "signing";
-    NotificationStatus["success"] = "success";
-    NotificationStatus["error"] = "error";
-    NotificationStatus["pending"] = "pending";
-})(NotificationStatus || (exports.NotificationStatus = NotificationStatus = {}));
-var NotificationTopic;
-(function (NotificationTopic) {
-    NotificationTopic["tx"] = "tx";
-    NotificationTopic["signature"] = "signature";
-})(NotificationTopic || (exports.NotificationTopic = NotificationTopic = {}));
-/**
- * MUST receive a success or error notification at some point to ensure the result promise resolves.
- */
-class NotificationProducer {
-    /**
-     * Creates a notification producer.
-     * MUST receive a success or error notification at some point to ensure the result promise resolves.
-     * @param topic The notification topic to populate each notification with.
-     */
-    constructor(topic) {
-        this.topic = topic;
-        this._notifications$ = new rxjs_1.ReplaySubject(Infinity);
-        this.notifications$ = this._notifications$.asObservable();
-        this._result = (0, rxjs_1.lastValueFrom)(this._notifications$);
-        this.consumer = {
-            notifications$: this.notifications$,
-            wait: this.wait.bind(this),
-        };
-    }
-    async wait(observerOrNext) {
-        const subscription = this.notifications$.subscribe(observerOrNext);
-        const notification = (await this._result);
-        subscription.unsubscribe();
-        return notification;
-    }
-    next(notification) {
-        this._notifications$.next({
-            ...notification,
-            topic: this.topic,
-        });
-        if (notification.status === NotificationStatus.success ||
-            notification.status === NotificationStatus.error)
-            this._notifications$.complete();
-    }
-}
-exports.NotificationProducer = NotificationProducer;

package/lib/signatures/index.d.ts

@@ -1,12 +0,0 @@
-import * as _Manager from "./manager";
-import * as _Permit from "./permit";
-import * as _Permit2 from "./permit2";
-import { safeSignTypedData as _safeSignTypedData, verifySignature as _verifySignature, getMessage as _getMessage } from "./utils";
-export declare namespace SignatureUtils {
-    export import Permit = _Permit;
-    export import Permit2 = _Permit2;
-    export import Manager = _Manager;
-    const safeSignTypedData: typeof _safeSignTypedData;
-    const verifySignature: typeof _verifySignature;
-    const getMessage: typeof _getMessage;
-}

package/lib/signatures/index.js

@@ -1,39 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SignatureUtils = void 0;
-const _Manager = __importStar(require("./manager"));
-const _Permit = __importStar(require("./permit"));
-const _Permit2 = __importStar(require("./permit2"));
-const utils_1 = require("./utils");
-var SignatureUtils;
-(function (SignatureUtils) {
-    SignatureUtils.Permit = _Permit;
-    SignatureUtils.Permit2 = _Permit2;
-    SignatureUtils.Manager = _Manager;
-    SignatureUtils.safeSignTypedData = utils_1.safeSignTypedData;
-    SignatureUtils.verifySignature = utils_1.verifySignature;
-    SignatureUtils.getMessage = utils_1.getMessage;
-})(SignatureUtils || (exports.SignatureUtils = SignatureUtils = {}));

package/lib/signatures/manager.d.ts

@@ -1,10 +0,0 @@
-import { ChainId } from "../chain";
-import { SignatureMessage } from "./types";
-export interface ManagerApprovalSignatureArgs {
-    authorizer: string;
-    authorized: string;
-    isAuthorized: boolean;
-    nonce: bigint;
-    deadline: bigint;
-}
-export declare const getManagerApprovalMessage: (args: ManagerApprovalSignatureArgs, chainId: ChainId) => SignatureMessage;

package/lib/signatures/manager.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getManagerApprovalMessage = void 0;
-const addresses_1 = require("../addresses");
-const utils_1 = require("./utils");
-const getManagerApprovalMessage = (args, chainId) => {
-    const domain = {
-        chainId: chainId.toString(),
-        verifyingContract: (0, addresses_1.getChainAddresses)(chainId).morpho,
-    };
-    const types = {
-        Authorization: [
-            {
-                name: "authorizer",
-                type: "address",
-            },
-            {
-                name: "authorized",
-                type: "address",
-            },
-            {
-                name: "isAuthorized",
-                type: "bool",
-            },
-            {
-                name: "nonce",
-                type: "uint256",
-            },
-            {
-                name: "deadline",
-                type: "uint256",
-            },
-        ],
-    };
-    return (0, utils_1.getMessage)(domain, types, args);
-};
-exports.getManagerApprovalMessage = getManagerApprovalMessage;

package/lib/signatures/permit.d.ts

@@ -1,21 +0,0 @@
-import { ChainId } from "../chain";
-import { Token } from "../token";
-import { Address } from "../types";
-import { SignatureMessage } from "./types";
-export interface PermitArgs {
-    erc20: Token;
-    owner: Address;
-    spender: Address;
-    allowance: bigint;
-    nonce: bigint;
-    deadline: bigint;
-}
-/**
- * Permit signature for ERC20 tokens, following EIP-2612.
- * Docs: https://eips.ethereum.org/EIPS/eip-2612
- */
-export declare const getPermitMessage: ({ deadline, owner, nonce, spender, erc20, allowance }: PermitArgs, chainId: ChainId) => SignatureMessage;
-export declare const WITH_SIMPLE_PERMIT: {
-    [id in ChainId]: (Address | undefined)[];
-};
-export declare const hasSimplePermit: (chainId: ChainId, address: Address) => boolean;

package/lib/signatures/permit.js

@@ -1,101 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasSimplePermit = exports.WITH_SIMPLE_PERMIT = exports.getPermitMessage = void 0;
-const addresses_1 = require("../addresses");
-const chain_1 = require("../chain");
-const utils_1 = require("./utils");
-/**
- * Permit signature for ERC20 tokens, following EIP-2612.
- * Docs: https://eips.ethereum.org/EIPS/eip-2612
- */
-const getPermitMessage = ({ deadline, owner, nonce, spender, erc20, allowance }, chainId) => {
-    const { usdc, dai } = (0, addresses_1.getChainAddresses)(chainId);
-    const domain = {
-        name: erc20.name,
-        version: erc20.address === usdc ? "2" : "1",
-        chainId: chainId.toString(),
-        verifyingContract: erc20.address,
-    };
-    if (erc20.address === dai)
-        return (0, utils_1.getMessage)(domain, {
-            Permit: [
-                {
-                    name: "holder",
-                    type: "address",
-                },
-                {
-                    name: "spender",
-                    type: "address",
-                },
-                {
-                    name: "nonce",
-                    type: "uint256",
-                },
-                {
-                    name: "expiry",
-                    type: "uint256",
-                },
-                {
-                    name: "allowed",
-                    type: "bool",
-                },
-            ],
-        }, {
-            holder: owner,
-            spender,
-            allowed: allowance > 0n,
-            nonce,
-            expiry: deadline,
-        });
-    const types = {
-        Permit: [
-            {
-                name: "owner",
-                type: "address",
-            },
-            {
-                name: "spender",
-                type: "address",
-            },
-            {
-                name: "value",
-                type: "uint256",
-            },
-            {
-                name: "nonce",
-                type: "uint256",
-            },
-            {
-                name: "deadline",
-                type: "uint256",
-            },
-        ],
-    };
-    const value = {
-        owner,
-        spender,
-        value: allowance,
-        nonce,
-        deadline,
-    };
-    return (0, utils_1.getMessage)(domain, types, value);
-};
-exports.getPermitMessage = getPermitMessage;
-exports.WITH_SIMPLE_PERMIT = {
-    [chain_1.ChainId.EthMainnet]: [
-        addresses_1.addresses[chain_1.ChainId.EthMainnet].wbIB01,
-        addresses_1.addresses[chain_1.ChainId.EthMainnet].wbC3M,
-        addresses_1.addresses[chain_1.ChainId.EthMainnet].wstEth,
-        addresses_1.addresses[chain_1.ChainId.EthMainnet].sDai,
-        addresses_1.addresses[chain_1.ChainId.EthMainnet].osEth,
-        addresses_1.addresses[chain_1.ChainId.EthMainnet].usdc,
-        addresses_1.addresses[chain_1.ChainId.EthMainnet].dai,
-    ],
-    [chain_1.ChainId.EthGoerliTestnet]: [
-        "0x0aCd15Fb54034492c392596B56ED415bD07e70d7", // Fake DAI
-        "0xD8134205b0328F5676aaeFb3B2a0DC15f4029d8C", // Real sDAI
-    ],
-    [chain_1.ChainId.BaseMainnet]: [addresses_1.addresses[chain_1.ChainId.BaseMainnet].usdc],
-};
-const hasSimplePermit = (chainId, address) => exports.WITH_SIMPLE_PERMIT[chainId]?.includes(address);
-exports.hasSimplePermit = hasSimplePermit;

package/lib/signatures/permit2.d.ts

@@ -1,20 +0,0 @@
-import { ChainId } from "../chain";
-import { Address } from "../types";
-import { SignatureMessage } from "./types";
-export interface Permit2Args {
-    erc20: Address;
-    allowance: bigint;
-    nonce: bigint;
-    deadline: bigint;
-    spender: Address;
-    expiration?: bigint;
-}
-export interface Permit2TransferFromArgs {
-    erc20: Address;
-    allowance: bigint;
-    spender: Address;
-    nonce: bigint;
-    deadline: bigint;
-}
-export declare const getPermit2TransferFromMessage: (args: Permit2TransferFromArgs, chainId: ChainId) => SignatureMessage;
-export declare const getPermit2Message: (args: Permit2Args, chainId: ChainId) => SignatureMessage;