Merge pull request #95 from Premian-Labs/fix/transaction-api

Add function to get optionPS transactions and fix transaction fragments

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@premia/v3-sdk",
-	"version": "2.3.3",
+	"version": "2.3.4",
 	"description": "The official SDK for building applications on Premia V3.",
 	"main": "dist/index.js",
 	"typings": "dist/index.d.ts",

src/api/transactionAPI.ts

@@ -1,4 +1,4 @@
-import { Transaction, VaultTransaction } from '../entities'
+import { Transaction, VaultTransaction, OptionPSTransaction } from '../entities'
 import { BaseAPI } from './baseAPI'
 
 /**
@@ -133,4 +133,58 @@ export class TransactionAPI extends BaseAPI {
 			searchInput
 		)
 	}
+
+	/**
+	 * Get a single optionPS transaction given its hash.
+	 *
+	 * @param {string} hash - The hash of the optionPS transaction to retrieve.
+	 *
+	 * @returns {Promise<OptionPSTransaction>} A promise that resolves to the requested optionPS transaction.
+	 *
+	 * @remark Uses caching with a one-minute time-to-live.
+	 */
+	async getOptionPSTransaction(hash: string): Promise<OptionPSTransaction> {
+		return this.premia.subgraph.getOptionPSTransaction(hash)
+	}
+
+	/**
+	 * Get a list of optionPS transactions with optional filter, search, order, and pagination parameters.
+	 *
+	 * @param {string} search - The search query.
+	 * @param {string} [orderBy='timestamp'] - The attribute by which to order the optionPS transactions.
+	 * @param {string} [order='asc'] - The order in which to return the vault transactions (asc, desc).
+	 * @param {number} [first=100] - The maximum number of optionPS transactions to return.
+	 * @param {number} [skip=0] - The number of optionPS transactions to skip.
+	 * @param {string} [account] - The account associated with the optionPS transactions to return.
+	 * @param {number} [startTime] - The start time for the optionPS transactions to return.
+	 * @param {number} [endTime] - The end time for the optionPS transactions to return.
+	 * @param {string} [searchInput] - An additional search input.
+	 *
+	 * @returns {Promise<OptionPSTransaction[]>} A promise that resolves to a list of optionPS transactions.
+	 *
+	 * @remark Uses caching with a one-minute time-to-live.
+	 */
+	async getOptionPSTransactions(
+		search: string,
+		orderBy: string = 'timestamp',
+		order: string = 'asc',
+		first = 100,
+		skip = 0,
+		account?: string,
+		startTime?: number,
+		endTime?: number,
+		searchInput?: string
+	): Promise<OptionPSTransaction[]> {
+		return this.premia.subgraph.getOptionPSTransactions(
+			search,
+			orderBy,
+			order,
+			first,
+			skip,
+			account,
+			startTime,
+			endTime,
+			searchInput
+		)
+	}
 }

src/entities/index.ts

@@ -18,3 +18,4 @@ export * from './vaultTransaction'
 export * from './volatilitySurface'
 export * from './vxPremia'
 export * from './referral'
+export * from './optionPSTransaction'

src/entities/optionPSTransaction.ts

@@ -0,0 +1,38 @@
+import { BigNumberish } from 'ethers'
+
+import { Token } from './token'
+import { OptionPhysicallySettled } from './option'
+
+export enum OptionPSTransactionType {
+	OPTION_PS_EXERCISE = 'OPTION_PS_EXERCISE',
+	OPTION_PS_CANCEL_EXERCISE = 'OPTION_PS_CANCEL_EXERCISE',
+	OPTION_PS_SETTLE_LONG = 'OPTION_PS_SETTLE_LONG',
+	OPTION_PS_SETTLE_SHORT = 'OPTION_PS_SETTLE_SHORT',
+	OPTION_PS_ANNIHILATE = 'OPTION_PS_ANNIHILATE',
+	OPTION_REWARD_UNDERWRITE = 'OPTION_REWARD_UNDERWRITE',
+	SHORT_OPTION_TRANSFER = 'SHORT_OPTION_TRANSFER',
+	SHORT_OPTION_RECEIVE = 'SHORT_OPTION_RECEIVE',
+	LONG_OPTION_PS_TRANSFER = 'LONG_OPTION_PS_TRANSFER',
+	LONG_OPTION_PS_RECEIVE = 'LONG_OPTION_PS_RECEIVE',
+}
+
+export interface OptionPSTransaction {
+	id: string
+	option: OptionPhysicallySettled
+	tokenSymbol: string
+	token: Token
+	origin: string
+	gasUsed: BigNumberish
+	gasPrice: BigNumberish
+	timestamp: BigNumberish
+	block: BigNumberish
+	logIndex: BigNumberish
+
+	type: OptionPSTransactionType
+	action: string
+	description: string
+	size: BigNumberish
+	sizeETH: BigNumberish
+	sizeUSD: BigNumberish
+	user: string
+}

src/entities/user.ts

@@ -9,6 +9,7 @@ import { VaultPosition, VaultPositionExtended } from './vaultPosition'
 import { Transaction } from './transaction'
 import { VaultTransaction } from './vaultTransaction'
 import { Referral } from './referral'
+import { OptionPSTransaction } from './optionPSTransaction'
 
 export interface ActionAuthorization {
 	actions: bigint[]
@@ -95,6 +96,7 @@ export interface UserPortfolioHistory extends UserPortfolio {
 	snapshots: UserSnapshot[]
 	poolTransactions: Transaction[]
 	vaultTransactions: VaultTransaction[]
+	optionPSTransactions: OptionPSTransaction[]
 }
 
 export interface UserPortfolioExtended extends UserPortfolio {
@@ -105,6 +107,7 @@ export interface UserPortfolioExtended extends UserPortfolio {
 	snapshots: UserSnapshotExtended[]
 	poolTransactions: Transaction[]
 	vaultTransactions: VaultTransaction[]
+	optionPSTransactions: OptionPSTransaction[]
 }
 
 export interface UserSnapshot {

src/services/subgraph/graphql/fragments/index.ts

@@ -14,3 +14,4 @@ export * from './vaultRegistry'
 export * from './vaultTransaction'
 export * from './volatilitySurface'
 export * from './vxPremia'
+export * from './optionPSTransaction'

src/services/subgraph/graphql/fragments/optionPSTransaction.ts

@@ -0,0 +1,33 @@
+import { gql } from '@apollo/client/core'
+
+import { OptionPhysicallySettledFragment } from './option'
+import { TokenFragment } from './token'
+
+export const OptionPSTransactionFragment = gql`
+	${OptionPhysicallySettledFragment}
+	${TokenFragment}
+
+	fragment OptionPSTransaction on OptionPSTransaction {
+		id
+		option {
+			...OptionPhysicallySettled
+		}
+		tokenSymbol
+		token {
+			...Token
+		}
+		origin
+		gasUsed
+		gasPrice
+		timestamp
+		block
+		logIndex
+
+		type
+		action
+		description
+		size
+		sizeETH
+		sizeUSD
+	}
+`

src/services/subgraph/graphql/fragments/transaction.ts

@@ -1,9 +1,9 @@
 import { gql } from '@apollo/client/core'
 
 import { PoolFragment } from './pool'
-import { TokenFragment } from './token'
 import { TokenPairFragment } from './tokenPair'
 import { VaultFragment } from './vault'
+import { TokenFragment } from './token'
 
 export const TransactionFragment = gql`
 	${PoolFragment}
@@ -22,6 +22,9 @@ export const TransactionFragment = gql`
 		pair {
 			...TokenPair
 		}
+		token {
+			...Token
+		}
 		origin
 		gasUsed
 		gasPrice
@@ -35,6 +38,5 @@ export const TransactionFragment = gql`
 		size
 		sizeETH
 		sizeUSD
-		user
 	}
 `

src/services/subgraph/graphql/fragments/user.ts

@@ -15,6 +15,7 @@ import {
 import { TransactionFragment } from './transaction'
 import { VaultTransactionFragment } from './vaultTransaction'
 import { ReferralFragment } from './referral'
+import { OptionPSTransactionFragment } from './optionPSTransaction'
 
 export const UserFragment = gql`
 	fragment User on User {
@@ -216,6 +217,7 @@ export const UserPortfolioExtendedFragment = gql`
 	${UserSnapshotExtendedFragment}
 	${TransactionFragment}
 	${VaultTransactionFragment}
+	${OptionPSTransactionFragment}
 
 	fragment UserPortfolioExtended on User {
 		...UserExtended
@@ -239,6 +241,9 @@ export const UserPortfolioExtendedFragment = gql`
 		vaultTransactions {
 			...VaultTransaction
 		}
+		optionPSTransactions {
+			...OptionPSTransaction
+		}
 	}
 `
 

src/services/subgraph/graphql/fragments/vaultTransaction.ts

@@ -2,20 +2,20 @@ import { gql } from '@apollo/client/core'
 
 import { VaultFragment } from './vault'
 import { TokenFragment } from './token'
-import { TokenPairFragment } from './tokenPair'
 
 export const VaultTransactionFragment = gql`
 	${VaultFragment}
 	${TokenFragment}
-	${TokenPairFragment}
 
 	fragment VaultTransaction on VaultTransaction {
 		id
-		registry
 		vaultName
 		vault {
 			...Vault
 		}
+		token {
+			...Token
+		}
 		origin
 		gasUsed
 		gasPrice
@@ -29,6 +29,5 @@ export const VaultTransactionFragment = gql`
 		size
 		sizeETH
 		sizeUSD
-		user
 	}
 `

src/services/subgraph/graphql/queries/index.ts

@@ -16,3 +16,4 @@ export * from './vaultTransaction'
 export * from './volatilitySurface'
 export * from './vxPremia'
 export * from './referral'
+export * from './optionPSTransaction'

src/services/subgraph/graphql/queries/optionPSTransaction.ts

@@ -0,0 +1,74 @@
+import { DocumentNode, gql } from '@apollo/client/core'
+import { BigNumberish } from 'ethers'
+import { OptionPSTransactionFragment } from '../fragments'
+import { addFields } from '../../../../utils/subgraph'
+import PremiaSubgraph from '../../index'
+
+export class OptionPSTransactionQuery {
+	static optionPSTransactionId(hash: string): string {
+		return hash
+	}
+
+	@addFields
+	static GetOptionPSTransaction(
+		subgraph: PremiaSubgraph,
+		hash: string
+	): DocumentNode {
+		return gql`
+        ${OptionPSTransactionFragment}
+
+        {
+          optionPSTransaction(id: "${this.optionPSTransactionId(hash)}") {
+                ...OptionPSTransaction
+            }
+        }
+    `
+	}
+
+	@addFields
+	static GetOptionPSTransactions(
+		subgraph: PremiaSubgraph,
+		search: string,
+		orderBy: string,
+		order: string,
+		first = 100,
+		skip = 0,
+		account?: string,
+		startTime?: BigNumberish,
+		endTime?: BigNumberish,
+		searchInput?: string
+	): DocumentNode {
+		const startFilter = startTime ? `timestamp_gte: ${Number(startTime)},` : ''
+		const endFilter = endTime ? `timestamp_lte: ${Number(endTime)},` : ''
+		const searchFilter = searchInput
+			? `description_contains: "${searchInput.toUpperCase()}",`
+			: ''
+		const accountFilter = account ? `user: "${account.toLowerCase()}",` : ''
+
+		const containsName = 'tokenSymbol_contains'
+		const containsFilter = `${containsName}: "${search}",`
+
+		return gql`
+        ${OptionPSTransactionFragment}
+    
+        query OptionPSTransaction {
+            optionPSTransactions(
+                first: ${first}
+                skip: ${skip}
+                orderBy: "${orderBy}"
+                orderDirection: "${order}"
+                where: {
+                    sizeUSD_gt: 0,
+                    ${startFilter}
+                    ${endFilter}
+                    ${searchFilter}
+                    ${accountFilter}
+                    ${containsFilter}
+                }
+            ) {
+                ...OptionPSTransaction
+            }
+        }
+    `
+	}
+}

src/services/subgraph/graphql/queries/transaction.ts

@@ -77,12 +77,14 @@ export class TransactionQuery {
                 ${
 									filter === 'all'
 										? ''
-										: `, type${filter === 'options' ? '_not_in' : '_in'}: ${
+										: `, type_in: ${
 												filter === 'add'
 													? '["POOL_DEPOSIT"]'
 													: filter === 'remove'
 													? '["POOL_WITHDRAW"]'
-													: '["POOL_DEPOSIT", "POOL_WITHDRAW"]'
+													: filter === 'pools'
+													? '["POOL_DEPOSIT", "POOL_TRADE", "POOL_CLAIM_FEES", "POOL_FILL_QUOTE", "POOL_WRITE_FROM", "POOL_SETTLE_POSITION", "POOL_LIQUIDITY_TRANSFER", "POOL_LIQUIDITY_RECEIVE", "POOL_WITHDRAW"]'
+													: '["SHORT_OPTION_SETTLE", "SHORT_OPTION_TRANSFER", "SHORT_OPTION_RECEIVE", "LONG_OPTION_EXERCISE", "LONG_OPTION_TRANSFER", "LONG_OPTION_RECEIVE", "DUAL_OPTION_ANNIHILATE"]'
 										  }`
 								}
             }