Skip to content

Commit

Permalink
Merge pull request #100 from morpho-org/feat/export-augmented-modules
Browse files Browse the repository at this point in the history
Feat/export augmented modules
  • Loading branch information
Rubilmax authored Sep 30, 2024
2 parents 49daa08 + a540b84 commit 90ade49
Show file tree
Hide file tree
Showing 40 changed files with 93 additions and 57 deletions.
15 changes: 9 additions & 6 deletions packages/blue-sdk-ethers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,9 @@ import "@morpho-org/blue-sdk-ethers/lib/augment";
Leverage the [`MarketConfig`](./src/market/MarketConfig.ts) class to fetch information on a given market's immutable configuration:

```typescript
import { MarketId, MarketConfig } from "@morpho-org/blue-sdk";
import "@morpho-org/blue-sdk-ethers/lib/augment/MarketConfig";
import { MarketId } from "@morpho-org/blue-sdk";
// /!\ Import MarketConfig from the augmentation file (or simply import the file)
import { MarketConfig } from "@morpho-org/blue-sdk-ethers/lib/augment/MarketConfig";

const config = await MarketConfig.fetch(
"0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc" as MarketId,
Expand All @@ -63,8 +64,9 @@ Leverage the [`Market`](./src/market/Market.ts) class to fetch information on a

```typescript
import { Time } from "@morpho-org/morpho-ts";
import { MarketId, Market } from "@morpho-org/blue-sdk";
import "@morpho-org/blue-sdk-ethers/lib/augment/Market";
import { MarketId } from "@morpho-org/blue-sdk";
// /!\ Import Market from the augmentation file (or simply import the file)
import { Market } from "@morpho-org/blue-sdk-ethers/lib/augment/Market";

const market = await Market.fetch(
"0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc" as MarketId,
Expand Down Expand Up @@ -92,8 +94,9 @@ Leverage the [`Position`](./src/position/Position.ts) class to fetch the positio

```typescript
import { Time } from "@morpho-org/morpho-ts";
import { MarketId, AccrualPosition } from "@morpho-org/blue-sdk";
import "@morpho-org/blue-sdk-ethers/lib/augment/Position";
import { MarketId } from "@morpho-org/blue-sdk";
// /!\ Import AccrualPosition from the augmentation file (or simply import the file)
import { AccrualPosition } from "@morpho-org/blue-sdk-ethers/lib/augment/Position";

const position = await AccrualPosition.fetch(
"0x7f65e7326F22963e2039734dDfF61958D5d284Ca",
Expand Down
2 changes: 2 additions & 0 deletions packages/blue-sdk-ethers/src/augment/Holding.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ declare module "@morpho-org/blue-sdk" {
}

Holding.fetch = fetchHolding;

export { Holding };
2 changes: 2 additions & 0 deletions packages/blue-sdk-ethers/src/augment/Market.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@ declare module "@morpho-org/blue-sdk" {

Market.fetch = fetchMarket;
Market.fetchFromConfig = fetchMarketFromConfig;

export { Market };
2 changes: 2 additions & 0 deletions packages/blue-sdk-ethers/src/augment/MarketConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ declare module "@morpho-org/blue-sdk" {
}

MarketConfig.fetch = fetchMarketConfig;

export { MarketConfig };
2 changes: 2 additions & 0 deletions packages/blue-sdk-ethers/src/augment/Position.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ declare module "@morpho-org/blue-sdk" {
Position.fetch = fetchPosition;
AccrualPosition.fetch = fetchAccrualPosition;
AccrualPosition.fetchFromConfig = fetchAccrualPositionFromConfig;

export { Position, AccrualPosition };
2 changes: 2 additions & 0 deletions packages/blue-sdk-ethers/src/augment/Token.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ declare module "@morpho-org/blue-sdk" {
}

Token.fetch = fetchToken;

export { Token };
2 changes: 2 additions & 0 deletions packages/blue-sdk-ethers/src/augment/User.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ declare module "@morpho-org/blue-sdk" {
}

User.fetch = fetchUser;

export { User };
2 changes: 2 additions & 0 deletions packages/blue-sdk-ethers/src/augment/Vault.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ declare module "@morpho-org/blue-sdk" {
Vault.fetch = fetchVault;
Vault.fetchFromConfig = fetchVaultFromConfig;
AccrualVault.fetch = fetchAccrualVault;

export { Vault, AccrualVault };
2 changes: 2 additions & 0 deletions packages/blue-sdk-ethers/src/augment/VaultConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ declare module "@morpho-org/blue-sdk" {
}

VaultConfig.fetch = fetchVaultConfig;

export { VaultConfig };
2 changes: 2 additions & 0 deletions packages/blue-sdk-ethers/src/augment/VaultMarketAllocation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ declare module "@morpho-org/blue-sdk" {

VaultMarketAllocation.fetch = fetchVaultMarketAllocation;
VaultMarketAllocation.fetchFromConfig = fetchVaultMarketAllocationFromConfig;

export { VaultMarketAllocation };
2 changes: 2 additions & 0 deletions packages/blue-sdk-ethers/src/augment/VaultMarketConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ declare module "@morpho-org/blue-sdk" {
}

VaultMarketConfig.fetch = fetchVaultMarketConfig;

export { VaultMarketConfig };
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ declare module "@morpho-org/blue-sdk" {
}

VaultMarketPublicAllocatorConfig.fetch = fetchVaultMarketPublicAllocatorConfig;

export { VaultMarketPublicAllocatorConfig };
4 changes: 2 additions & 2 deletions packages/blue-sdk-ethers/test/Holding.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ import { deal } from "hardhat-deal";

import { SignerWithAddress } from "@nomicfoundation/hardhat-ethers/signers";

import { ChainId, Holding, MathLib, addresses } from "@morpho-org/blue-sdk";
import { ChainId, MathLib, addresses } from "@morpho-org/blue-sdk";
import { MAINNET_MARKETS } from "@morpho-org/blue-sdk/src/tests/mocks/markets";

import { setUp } from "@morpho-org/morpho-test";
import { ethers } from "hardhat";
import "../src/augment/Holding";
import { Holding } from "../src/augment/Holding";

describe("augment/Holding", () => {
let signer: SignerWithAddress;
Expand Down
4 changes: 2 additions & 2 deletions packages/blue-sdk-ethers/test/Market.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ import { SignerWithAddress } from "@nomicfoundation/hardhat-ethers/signers";
import { setCode, time } from "@nomicfoundation/hardhat-network-helpers";
import { setNextBlockTimestamp } from "@nomicfoundation/hardhat-network-helpers/dist/src/helpers/time";

import { ChainId, Market, MarketConfig, addresses } from "@morpho-org/blue-sdk";
import { ChainId, MarketConfig, addresses } from "@morpho-org/blue-sdk";
import { MAINNET_MARKETS } from "@morpho-org/blue-sdk/src/tests/mocks/markets";
import { setUp } from "@morpho-org/morpho-test";

import "../src/augment/Market";
import { Market } from "../src/augment/Market";

describe("augment/Market", () => {
let signer: SignerWithAddress;
Expand Down
9 changes: 2 additions & 7 deletions packages/blue-sdk-ethers/test/MarketConfig.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,11 @@ import { ethers } from "hardhat";

import { SignerWithAddress } from "@nomicfoundation/hardhat-ethers/signers";

import {
ChainId,
MarketConfig,
MarketId,
addresses,
} from "@morpho-org/blue-sdk";
import { ChainId, MarketId, addresses } from "@morpho-org/blue-sdk";
import { MAINNET_MARKETS } from "@morpho-org/blue-sdk/src/tests/mocks/markets";
import { setUp } from "@morpho-org/morpho-test";

import "../src/augment/MarketConfig";
import { MarketConfig } from "../src/augment/MarketConfig";

describe("augment/MarketConfig", () => {
let signer: SignerWithAddress;
Expand Down
4 changes: 2 additions & 2 deletions packages/blue-sdk-ethers/test/Position.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ import { deal } from "hardhat-deal";

import { SignerWithAddress } from "@nomicfoundation/hardhat-ethers/signers";

import { ChainId, Position, addresses } from "@morpho-org/blue-sdk";
import { ChainId, addresses } from "@morpho-org/blue-sdk";
import { MAINNET_MARKETS } from "@morpho-org/blue-sdk/src/tests/mocks/markets";
import { setUp } from "@morpho-org/morpho-test";
import "../src/augment/Position";
import { Position } from "../src/augment/Position";

const market = MAINNET_MARKETS.usdc_wstEth;

Expand Down
3 changes: 1 addition & 2 deletions packages/blue-sdk-ethers/test/Token.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@ import { SignerWithAddress } from "@nomicfoundation/hardhat-ethers/signers";
import {
ChainId,
ExchangeRateWrappedToken,
Token,
addresses,
} from "@morpho-org/blue-sdk";
import { setUp } from "@morpho-org/morpho-test";
import "../src/augment/Token";
import { Token } from "../src/augment/Token";

describe("augment/Token", () => {
let signer: SignerWithAddress;
Expand Down
4 changes: 2 additions & 2 deletions packages/blue-sdk-ethers/test/User.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import { ethers } from "hardhat";

import { SignerWithAddress } from "@nomicfoundation/hardhat-ethers/signers";

import { ChainId, User, addresses } from "@morpho-org/blue-sdk";
import { ChainId, addresses } from "@morpho-org/blue-sdk";
import { setUp } from "@morpho-org/morpho-test";
import "../src/augment/User";
import { User } from "../src/augment/User";

describe("augment/User", () => {
let signer: SignerWithAddress;
Expand Down
4 changes: 2 additions & 2 deletions packages/blue-sdk-ethers/test/Vault.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ import { ethers } from "hardhat";
import { SignerWithAddress } from "@nomicfoundation/hardhat-ethers/signers";
import { setNextBlockTimestamp } from "@nomicfoundation/hardhat-network-helpers/dist/src/helpers/time";

import { ChainId, MarketId, Vault, addresses } from "@morpho-org/blue-sdk";
import { ChainId, MarketId, addresses } from "@morpho-org/blue-sdk";
import { setUp } from "@morpho-org/morpho-test";

import "../src/augment/Vault";
import { Vault } from "../src/augment/Vault";
import { steakUsdc } from "./fixtures";

describe("augment/Vault", () => {
Expand Down
3 changes: 1 addition & 2 deletions packages/blue-sdk-ethers/test/VaultMarketConfig.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@ import { SignerWithAddress } from "@nomicfoundation/hardhat-ethers/signers";

import {
ChainId,
VaultMarketConfig,
VaultMarketPublicAllocatorConfig,
addresses,
} from "@morpho-org/blue-sdk";
import { MAINNET_MARKETS } from "@morpho-org/blue-sdk/src/tests/mocks/markets";
import { setUp } from "@morpho-org/morpho-test";

import "../src/augment/VaultMarketConfig";
import { VaultMarketConfig } from "../src/augment/VaultMarketConfig";
import { steakUsdc } from "./fixtures";

describe("augment/VaultMarketConfig", () => {
Expand Down
21 changes: 12 additions & 9 deletions packages/blue-sdk-viem/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,12 @@ import "@morpho-org/blue-sdk-viem/lib/augment";
Leverage the [`MarketConfig`](./src/market/MarketConfig.ts) class to fetch information on a given market's immutable configuration:

```typescript
import { MarketConfig } from "@morpho-org/blue-sdk";
import "@morpho-org/blue-sdk-viem/lib/augment/MarketConfig";
import { MarketId } from "@morpho-org/blue-sdk";
// /!\ Import AccrualPosition from the augmentation file (or simply import the file)
import { MarketConfig } from "@morpho-org/blue-sdk-viem/lib/augment/MarketConfig";

const config = await MarketConfig.fetch(
"0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc",
"0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc" as MarketId,
client // viem client.
);

Expand All @@ -63,11 +64,12 @@ Leverage the [`Market`](./src/market/Market.ts) class to fetch information on a

```typescript
import { Time } from "@morpho-org/morpho-ts";
import { Market } from "@morpho-org/blue-sdk";
import "@morpho-org/blue-sdk-viem/lib/augment/Market";
import { MarketId } from "@morpho-org/blue-sdk";
// /!\ Import AccrualPosition from the augmentation file (or simply import the file)
import { Market } from "@morpho-org/blue-sdk-viem/lib/augment/Market";

const market = await Market.fetch(
"0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc",
"0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc" as MarketId,
client // viem client.
);

Expand All @@ -92,12 +94,13 @@ Leverage the [`Position`](./src/position/Position.ts) class to fetch the positio

```typescript
import { Time } from "@morpho-org/morpho-ts";
import { AccrualPosition } from "@morpho-org/blue-sdk";
import "@morpho-org/blue-sdk-viem/lib/augment/Position";
import { MarketId } from "@morpho-org/blue-sdk";
// /!\ Import AccrualPosition from the augmentation file (or simply import the file)
import { AccrualPosition } from "@morpho-org/blue-sdk-viem/lib/augment/Position";

const position = await AccrualPosition.fetch(
"0x7f65e7326F22963e2039734dDfF61958D5d284Ca",
"0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc",
"0xb323495f7e4148be5643a4ea4a8221eef163e4bccfdedc2a6f4696baacbc86cc" as MarketId,
client // viem client.
);

Expand Down
2 changes: 2 additions & 0 deletions packages/blue-sdk-viem/src/augment/Holding.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ declare module "@morpho-org/blue-sdk" {
}

Holding.fetch = fetchHolding;

export { Holding };
2 changes: 2 additions & 0 deletions packages/blue-sdk-viem/src/augment/Market.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@ declare module "@morpho-org/blue-sdk" {

Market.fetch = fetchMarket;
Market.fetchFromConfig = fetchMarketFromConfig;

export { Market };
2 changes: 2 additions & 0 deletions packages/blue-sdk-viem/src/augment/MarketConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,5 @@ MarketConfig.prototype.asViem = function () {
lltv: bigint;
};
};

export { MarketConfig };
2 changes: 2 additions & 0 deletions packages/blue-sdk-viem/src/augment/Position.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ declare module "@morpho-org/blue-sdk" {
Position.fetch = fetchPosition;
AccrualPosition.fetch = fetchAccrualPosition;
AccrualPosition.fetchFromConfig = fetchAccrualPositionFromConfig;

export { Position, AccrualPosition };
2 changes: 2 additions & 0 deletions packages/blue-sdk-viem/src/augment/Token.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ declare module "@morpho-org/blue-sdk" {
}

Token.fetch = fetchToken;

export { Token };
2 changes: 2 additions & 0 deletions packages/blue-sdk-viem/src/augment/User.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ declare module "@morpho-org/blue-sdk" {
}

User.fetch = fetchUser;

export { User };
2 changes: 2 additions & 0 deletions packages/blue-sdk-viem/src/augment/Vault.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ declare module "@morpho-org/blue-sdk" {
Vault.fetch = fetchVault;
Vault.fetchFromConfig = fetchVaultFromConfig;
AccrualVault.fetch = fetchAccrualVault;

export { Vault, AccrualVault };
2 changes: 2 additions & 0 deletions packages/blue-sdk-viem/src/augment/VaultConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ declare module "@morpho-org/blue-sdk" {
}

VaultConfig.fetch = fetchVaultConfig;

export { VaultConfig };
2 changes: 2 additions & 0 deletions packages/blue-sdk-viem/src/augment/VaultMarketAllocation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ declare module "@morpho-org/blue-sdk" {

VaultMarketAllocation.fetch = fetchVaultMarketAllocation;
VaultMarketAllocation.fetchFromConfig = fetchVaultMarketAllocationFromConfig;

export { VaultMarketAllocation };
2 changes: 2 additions & 0 deletions packages/blue-sdk-viem/src/augment/VaultMarketConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ declare module "@morpho-org/blue-sdk" {
}

VaultMarketConfig.fetch = fetchVaultMarketConfig;

export { VaultMarketConfig };
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ declare module "@morpho-org/blue-sdk" {
}

VaultMarketPublicAllocatorConfig.fetch = fetchVaultMarketPublicAllocatorConfig;

export { VaultMarketPublicAllocatorConfig };
4 changes: 2 additions & 2 deletions packages/blue-sdk-viem/test/Holding.test.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
import { expect } from "chai";
import { deal } from "hardhat-deal";

import { ChainId, Holding, MathLib, addresses } from "@morpho-org/blue-sdk";
import { ChainId, MathLib, addresses } from "@morpho-org/blue-sdk";
import { MAINNET_MARKETS } from "@morpho-org/blue-sdk/src/tests/mocks/markets";

import { setUp } from "@morpho-org/morpho-test";
import { viem } from "hardhat";
import "../src/augment/Holding";
import {
Account,
Address,
Expand All @@ -22,6 +21,7 @@ import {
testActions,
} from "viem";
import { permit2Abi } from "../src/abis";
import { Holding } from "../src/augment/Holding";

describe("augment/Holding", () => {
let client: Client<
Expand Down
4 changes: 2 additions & 2 deletions packages/blue-sdk-viem/test/Market.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import {
testActions,
} from "viem";

import { ChainId, Market, MarketConfig, addresses } from "@morpho-org/blue-sdk";
import { ChainId, MarketConfig, addresses } from "@morpho-org/blue-sdk";
import { MAINNET_MARKETS } from "@morpho-org/blue-sdk/src/tests/mocks/markets";
import { createRandomAddress, setUp } from "@morpho-org/morpho-test";

import "../src/augment/Market";
import { blueAbi } from "../src/abis";
import { Market } from "../src/augment/Market";

describe("augment/Market", () => {
let client: Client<
Expand Down
9 changes: 2 additions & 7 deletions packages/blue-sdk-viem/test/MarketConfig.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,11 @@ import {
zeroAddress,
} from "viem";

import {
ChainId,
MarketConfig,
MarketId,
addresses,
} from "@morpho-org/blue-sdk";
import { ChainId, MarketId, addresses } from "@morpho-org/blue-sdk";
import { MAINNET_MARKETS } from "@morpho-org/blue-sdk/src/tests/mocks/markets";
import { setUp } from "@morpho-org/morpho-test";

import "../src/augment/MarketConfig";
import { MarketConfig } from "../src/augment/MarketConfig";

describe("augment/MarketConfig", () => {
let client: Client<
Expand Down
Loading

0 comments on commit 90ade49

Please sign in to comment.