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.

Sign up for GitHub

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

cache payment token decimals to reduce network requests and increase speed #1313

Merged
merged 2 commits into from
Dec 14, 2023
Merged

cache payment token decimals to reduce network requests and increase speed #1313

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ecfc2c7
cache payment token decimals to improve speed/reduce network requests
ryanio Dec 10, 2023
740a71f
remove unused parameter
ryanio Dec 10, 2023
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
41 changes: 28 additions & 13 deletions src/sdk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ import {
OpenSeaCollection,
OrderSide,
TokenStandard,
OpenSeaPaymentToken,
AssetWithTokenStandard,
AssetWithTokenId,
} from "./types";
Expand All @@ -67,14 +66,16 @@ import {
export class OpenSeaSDK {
/** Provider to use for transactions. */
public provider: JsonRpcProvider;
/** Seaport v1.5 client @see {@link https://github.com/ProjectOpenSea/seaport}*/
/** Seaport v1.5 client @see {@link https://github.com/ProjectOpenSea/seaport-js} */
public seaport_v1_5: Seaport;
/** Logger function to use when debugging */
public logger: (arg: string) => void;
/** API instance */
public readonly api: OpenSeaAPI;
/** The configured chain */
public readonly chain: Chain;
/** Internal cache of decimals for payment tokens to save network requests */
private _cachedPaymentTokenDecimals: { [address: string]: number } = {};

private _emitter: EventEmitter;
private _signerOrProvider: Signer | JsonRpcProvider;
Expand Down Expand Up @@ -111,6 +112,19 @@ export class OpenSeaSDK {

// Logger: default to no logging if fn not provided
this.logger = logger ?? ((arg: string) => arg);

// Cache decimals for WETH payment token to skip network request
try {
const wethAddress = getWETHAddress(this.chain).toLowerCase();
this._cachedPaymentTokenDecimals[wethAddress] = 18;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} catch (error: any) {
if (error.message.includes("Unknown WETH address")) {
// Ignore
} else {
console.error(error);
}
}
}

/**
Expand Down Expand Up @@ -943,13 +957,12 @@ export class OpenSeaSDK {
}

/**
* Compute the `basePrice` and `extra` parameters to be used to price an order.
* Compute the `basePrice` and `endPrice` parameters to be used to price an order.
* Also validates the expiration time and auction type.
* @param tokenAddress Address of the ERC-20 token to use for trading.
* Use the null address for ETH
* @param tokenAddress Address of the ERC-20 token to use for trading. Use the null address for ETH.
* @param expirationTime When the auction expires, or 0 if never.
* @param startAmount The base value for the order, in the token's main units (e.g. ETH instead of wei)
* @param endAmount The end value for the order, in the token's main units (e.g. ETH instead of wei). If unspecified, the order's `extra` attribute will be 0
* @param endAmount The end value for the order, in the token's main units (e.g. ETH instead of wei)
*/
private async _getPriceParameters(
orderSide: OrderSide,
Expand All @@ -958,15 +971,18 @@ export class OpenSeaSDK {
startAmount: BigNumberish,
endAmount?: BigNumberish,
) {
tokenAddress = tokenAddress.toLowerCase();
const isEther = tokenAddress === ethers.ZeroAddress;
let paymentToken: OpenSeaPaymentToken | undefined;
let decimals = 18;
if (!isEther) {
paymentToken = await this.api.getPaymentToken(tokenAddress);
if (!paymentToken) {
throw new Error(`No payment token found for ${tokenAddress}`);
if (tokenAddress in this._cachedPaymentTokenDecimals) {
decimals = this._cachedPaymentTokenDecimals[tokenAddress];
} else {
const paymentToken = await this.api.getPaymentToken(tokenAddress);
this._cachedPaymentTokenDecimals[tokenAddress] = paymentToken.decimals;
decimals = paymentToken.decimals;
}
}
const decimals = paymentToken?.decimals ?? 18;

const startAmountWei = ethers.parseUnits(startAmount.toString(), decimals);
const endAmountWei = endAmount
Expand All @@ -977,7 +993,6 @@ export class OpenSeaSDK {

const basePrice = startAmountWei;
const endPrice = endAmountWei;
const extra = priceDiffWei;

// Validation
if (startAmount == null || startAmountWei < 0) {
Expand All @@ -996,7 +1011,7 @@ export class OpenSeaSDK {
"Expiration time must be set if order will change in price.",
);
}
return { basePrice, extra, paymentToken, endPrice };
return { basePrice, endPrice };
}

private _dispatch(event: EventType, data: EventData) {
Expand Down