Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

apy #945

Open
wants to merge 31 commits into
base: main
Choose a base branch
from
Open

apy #945

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
777 changes: 777 additions & 0 deletions crates/subgraph/src/apy.rs

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions crates/subgraph/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
pub mod apy;
mod cynic_client;
mod orderbook_client;
mod pagination;
Expand Down
6 changes: 6 additions & 0 deletions crates/subgraph/src/orderbook_client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ pub enum OrderbookSubgraphClientError {
PaginationClientError(#[from] PaginationClientError),
#[error(transparent)]
ParseError(#[from] alloy::primitives::ruint::ParseError),
#[error(transparent)]
ParseBigIntConversionError(#[from] alloy::primitives::BigIntConversionError),
#[error(transparent)]
ParseFloatError(#[from] std::num::ParseFloatError),
#[error(transparent)]
ParseIntError(#[from] std::num::ParseIntError),
}

pub struct OrderbookSubgraphClient {
Expand Down
6 changes: 3 additions & 3 deletions crates/subgraph/src/types/common.rs
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ pub struct OrderStructPartialTrade {
pub id: Bytes,
}

#[derive(cynic::QueryFragment, Debug, Serialize, Clone, PartialEq)]
#[derive(cynic::QueryFragment, Debug, Serialize, Clone, PartialEq, Eq, Hash)]
#[cynic(graphql_type = "ERC20")]
#[typeshare]
pub struct Erc20 {
Expand All @@ -305,11 +305,11 @@ pub struct AddOrder {
pub transaction: Transaction,
}

#[derive(cynic::Scalar, Debug, Clone, PartialEq)]
#[derive(cynic::Scalar, Debug, Clone, PartialEq, Eq, Hash)]
#[typeshare]
pub struct BigInt(pub String);

#[derive(cynic::Scalar, Debug, Clone, PartialEq)]
#[derive(cynic::Scalar, Debug, Clone, PartialEq, Eq, Hash)]
#[typeshare]
pub struct Bytes(pub String);

Expand Down
14 changes: 7 additions & 7 deletions crates/subgraph/src/vol.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@ use serde::{Deserialize, Serialize};
use std::str::FromStr;
use typeshare::typeshare;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Hash)]
#[serde(rename_all = "camelCase")]
#[typeshare]
pub struct VaultVolume {
id: String,
token: Erc20,
pub id: String,
pub token: Erc20,
#[typeshare(typescript(type = "string"))]
total_in: U256,
pub total_in: U256,
#[typeshare(typescript(type = "string"))]
total_out: U256,
pub total_out: U256,
#[typeshare(typescript(type = "string"))]
total_vol: U256,
pub total_vol: U256,
#[typeshare(typescript(type = "string"))]
net_vol: I256,
pub net_vol: I256,
}

/// Get the vaults volume from array of trades
Expand Down
2 changes: 1 addition & 1 deletion flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
cargo install --git https://github.com/tomjw64/typeshare --rev 556b44aafd5304eedf17206800f69834e3820b7c
export PATH=$PATH:$CARGO_HOME/bin

typeshare crates/subgraph/src/types/common.rs crates/subgraph/src/types/order.rs crates/subgraph/src/types/vault.rs crates/subgraph/src/types/order_trade.rs crates/common/src/types/order_detail_extended.rs crates/subgraph/src/vol.rs --lang=typescript --output-file=tauri-app/src/lib/typeshare/subgraphTypes.ts;
typeshare crates/subgraph/src/types/common.rs crates/subgraph/src/types/order.rs crates/subgraph/src/types/vault.rs crates/subgraph/src/types/order_trade.rs crates/common/src/types/order_detail_extended.rs crates/subgraph/src/vol.rs crates/subgraph/src/apy.rs --lang=typescript --output-file=tauri-app/src/lib/typeshare/subgraphTypes.ts;

typeshare crates/settings/src/parse.rs --lang=typescript --output-file=tauri-app/src/lib/typeshare/appSettings.ts;
typeshare lib/rain.interpreter/crates/eval/src/trace.rs crates/common/src/fuzz/mod.rs crates/settings/src/config_source.rs crates/settings/src/config.rs crates/settings/src/plot_source.rs crates/settings/src/chart.rs crates/settings/src/deployer.rs crates/settings/src/network.rs crates/settings/src/order.rs crates/settings/src/orderbook.rs crates/settings/src/scenario.rs crates/settings/src/blocks.rs crates/settings/src/token.rs crates/settings/src/deployment.rs --lang=typescript --output-file=tauri-app/src/lib/typeshare/config.ts;
Expand Down
23 changes: 23 additions & 0 deletions tauri-app/src-tauri/src/commands/order_take.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use crate::error::CommandResult;
use rain_orderbook_common::{
csv::TryIntoCsv, subgraph::SubgraphArgs, types::FlattenError, types::OrderTakeFlattened,
};
use rain_orderbook_subgraph_client::apy::{get_order_apy, OrderAPY};
use rain_orderbook_subgraph_client::vol::VaultVolume;
use rain_orderbook_subgraph_client::{types::common::*, PaginationArgs};
use std::fs;
Expand Down Expand Up @@ -79,3 +80,25 @@ pub async fn order_trades_count(
.await?
.len())
}

#[tauri::command]
pub async fn order_apy(
order_id: String,
subgraph_args: SubgraphArgs,
start_timestamp: Option<u64>,
end_timestamp: Option<u64>,
) -> CommandResult<OrderAPY> {
let client = subgraph_args.to_subgraph_client().await?;
let order = client.order_detail(order_id.clone().into()).await?;
let trades = subgraph_args
.to_subgraph_client()
.await?
.order_trades_list_all(order_id.into(), start_timestamp, end_timestamp)
.await?;
Ok(get_order_apy(
order,
&trades,
start_timestamp,
end_timestamp,
)?)
}
6 changes: 4 additions & 2 deletions tauri-app/src-tauri/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ use commands::order::{
};
use commands::order_quote::{batch_order_quotes, debug_order_quote};
use commands::order_take::{
order_trades_count, order_trades_list, order_trades_list_write_csv, order_vaults_volume,
order_apy, order_trades_count, order_trades_list, order_trades_list_write_csv,
order_vaults_volume,
};
use commands::trade_debug::debug_trade;
use commands::vault::{
Expand Down Expand Up @@ -82,7 +83,8 @@ fn run_tauri_app() {
get_app_commit_sha,
validate_raindex_version,
order_vaults_volume,
order_trades_count
order_trades_count,
order_apy,
])
.run(tauri::generate_context!())
.expect("error while running tauri application");
Expand Down
53 changes: 53 additions & 0 deletions tauri-app/src/lib/components/charts/APYTimeFilters.svelte
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<script lang="ts">
import ButtonTab from '$lib/components/ButtonTab.svelte';
import { ButtonGroup } from 'flowbite-svelte';

const TIME_DELTA_1_MONTH = 60 * 60 * 24 * 30;
rouzwelt marked this conversation as resolved.
Show resolved Hide resolved
const TIME_DELTA_1_YEAR = TIME_DELTA_1_MONTH * 12;
rouzwelt marked this conversation as resolved.
Show resolved Hide resolved

let now = Math.floor(new Date().getTime() / 1000);
rouzwelt marked this conversation as resolved.
Show resolved Hide resolved
let timeDelta: number | undefined;

function setNow() {
now = Math.floor(new Date().getTime() / 1000);
}

export let startTimestamp: number | undefined;
export let endTimestamp: number | undefined;
</script>

<ButtonGroup class="bg-gray-800" data-testid="lightweightChartYearButtons">
<ButtonTab
on:click={() => {
setNow();
timeDelta = undefined;
startTimestamp = undefined;
endTimestamp = undefined;
}}
active={timeDelta === undefined}
size="xs"
class="px-2 py-1">All Time</ButtonTab
>
<ButtonTab
on:click={() => {
setNow();
timeDelta = TIME_DELTA_1_YEAR;
startTimestamp = now - TIME_DELTA_1_YEAR;
endTimestamp = now;
}}
active={timeDelta === TIME_DELTA_1_YEAR}
size="xs"
class="px-2 py-1">1 Year</ButtonTab
>
<ButtonTab
on:click={() => {
setNow();
timeDelta = TIME_DELTA_1_MONTH;
startTimestamp = now - TIME_DELTA_1_MONTH;
endTimestamp = now;
}}
active={timeDelta === TIME_DELTA_1_MONTH}
size="xs"
class="px-2 py-1">1 Month</ButtonTab
>
</ButtonGroup>
4 changes: 4 additions & 0 deletions tauri-app/src/lib/components/detail/OrderDetail.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import { onDestroy } from 'svelte';
import { queryClient } from '$lib/queries/queryClient';
import OrderVaultsVolTable from '../tables/OrderVaultsVolTable.svelte';
import OrderApy from '../tables/OrderAPY.svelte';

export let id: string;

Expand Down Expand Up @@ -143,6 +144,9 @@
<TabItem title="Volume">
<OrderVaultsVolTable {id} />
</TabItem>
<TabItem title="APY">
<OrderApy {id} />
</TabItem>
</Tabs>
</svelte:fragment>
</TanstackPageContentDetail>
37 changes: 37 additions & 0 deletions tauri-app/src/lib/components/tables/OrderAPY.svelte
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<script lang="ts">
import { createInfiniteQuery } from '@tanstack/svelte-query';
import TanstackAppTable from './TanstackAppTable.svelte';
import { QKEY_ORDER_APY } from '$lib/queries/keys';
import { getOrderApy } from '$lib/queries/orderTradesList';
import { subgraphUrl } from '$lib/stores/settings';
import { TableBodyCell, TableHeadCell } from 'flowbite-svelte';
import ApyTimeFilters from '../charts/APYTimeFilters.svelte';

export let id: string;

let startTimestamp: number | undefined;
let endTimestamp: number | undefined;

$: orderApy = createInfiniteQuery({
queryKey: [id, QKEY_ORDER_APY + id],
queryFn: () => getOrderApy(id, $subgraphUrl || '', startTimestamp, endTimestamp),
initialPageParam: 0,
getNextPageParam: () => undefined,
enabled: !!$subgraphUrl,
});
</script>

<TanstackAppTable query={orderApy} emptyMessage="No Order found" rowHoverable={false}>
<svelte:fragment slot="timeFilter">
<ApyTimeFilters bind:startTimestamp bind:endTimestamp />
</svelte:fragment>
<svelte:fragment slot="head">
<TableHeadCell padding="p-4">APY</TableHeadCell>
</svelte:fragment>

<svelte:fragment slot="bodyRow" let:item>
<TableBodyCell tdClass="break-all px-4 py-2" data-testid="apy">
{item.apy?.apy ?? 0} % {item.apy?.token?.symbol ? 'in ' + item.apy.token.symbol : ''}
rouzwelt marked this conversation as resolved.
Show resolved Hide resolved
</TableBodyCell>
</svelte:fragment>
</TanstackAppTable>
79 changes: 79 additions & 0 deletions tauri-app/src/lib/components/tables/OrderAPY.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
import { render, screen, waitFor } from '@testing-library/svelte';
import { test, vi } from 'vitest';
import { expect } from '$lib/test/matchers';
import { mockIPC } from '@tauri-apps/api/mocks';
import type { OrderAPY } from '$lib/typeshare/subgraphTypes';
import OrderApy from './OrderVaultsVolTable.svelte';
import { QueryClient } from '@tanstack/svelte-query';

vi.mock('$lib/stores/settings', async (importOriginal) => {
const { writable } = await import('svelte/store');
const { mockSettingsStore } = await import('$lib/mocks/settings');

const _activeOrderbook = writable();

return {
...((await importOriginal()) as object),
settings: mockSettingsStore,
subgraphUrl: writable('https://example.com'),
activeOrderbook: {
..._activeOrderbook,
load: vi.fn(() => _activeOrderbook.set(true)),
},
};
});

vi.mock('$lib/services/modal', async () => {
return {
handleDepositGenericModal: vi.fn(),
handleDepositModal: vi.fn(),
handleWithdrawModal: vi.fn(),
};
});

const mockOrderApy: OrderAPY[] = [
{
orderId: '1',
orderHash: '1',
apy: {
apy: 1.2,
token: {
id: 'output_token',
address: 'output_token',
name: 'output_token',
symbol: 'output_token',
decimals: '0',
},
},
startTime: 1,
endTime: 2,
inputsTokenVaultApy: [],
outputsTokenVaultApy: [],
},
];

test('renders table with correct data', async () => {
const queryClient = new QueryClient();

mockIPC((cmd) => {
if (cmd === 'order_apy') {
return mockOrderApy;
}
});

render(OrderApy, {
context: new Map([['$$_queryClient', queryClient]]),
props: { id: '1' },
});

await waitFor(async () => {
// get apy row
const rows = screen.getAllByTestId('apy');

// checking
for (let i = 0; i < mockOrderApy.length; i++) {
const display = mockOrderApy[i].apy!.apy;
expect(rows[i]).toHaveTextContent(display.toString());
}
});
});
1 change: 1 addition & 0 deletions tauri-app/src/lib/queries/keys.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ export const QKEY_ORDER = 'order';
export const QKEY_ORDER_TRADES_LIST = 'orderTradesList';
export const QKEY_ORDER_QUOTE = 'orderQuote';
export const QKEY_VAULTS_VOL_LIST = 'orderVaultsVolumeList';
export const QKEY_ORDER_APY = 'orderApy';
21 changes: 20 additions & 1 deletion tauri-app/src/lib/queries/orderTradesList.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { Trade, VaultVolume } from '$lib/typeshare/subgraphTypes';
import type { OrderAPY, Trade, VaultVolume } from '$lib/typeshare/subgraphTypes';
import { invoke } from '@tauri-apps/api';
import { DEFAULT_PAGE_SIZE } from './constants';
import { prepareHistoricalOrderChartData } from '$lib/services/historicalOrderCharts';
Expand Down Expand Up @@ -92,3 +92,22 @@ export const orderTradesCount = async (
endTimestamp,
} as OrderTradesListArgs);
};

export const getOrderApy = async (
id: string,
url: string | undefined,
startTimestamp?: number,
endTimestamp?: number,
) => {
if (!url) {
return [];
}
return [
await invoke<OrderAPY>('order_apy', {
orderId: id,
subgraphArgs: { url },
startTimestamp,
endTimestamp,
} as OrderTradesListArgs),
];
};
Loading