@orb-labs/orby-core 0.0.15 → 0.0.17

package/dist/entities/financial/fungible_token.js

@@ -1,64 +0,0 @@
-import { Currency } from "./currency.js";
-import { checkValidAddress, validateAndParseAddress, } from "../../utils/validateAndParseAddress.js";
-import { TokenType } from "../../enums.js";
-/**
- * Represents an ERC20 token with a unique address and some metadata.
- */
-export class FungibleToken extends Currency {
-    static toFungibleToken(token) {
-        if (!token) {
-            return undefined;
-        }
-        const { address, chainId, currency, coinGeckoId, isNative } = token;
-        return new FungibleToken(BigInt(chainId), address, currency.decimals, currency.asset.symbol, currency.asset.name, undefined, isNative, coinGeckoId);
-    }
-    /**
-     * @param chainId The chain ID on which this token resides
-     * @param address The contract address on the chain on which this token lives
-     * @param decimals {@link Currency#decimals}
-     * @param symbol {@link Currency#symbol}
-     * @param name {@link Currency#name}
-     * @param bypassChecksum If true it only checks for length === 42, startsWith 0x and contains only hex characters
-     */
-    constructor(chainId, address, decimals, symbol, name, bypassChecksum, isNative, coinGeckoId, logoUrl) {
-        // TODO(felix): add this back
-        // invariant(!_.isUndefined(getBlockchainFromBlockchainId(chainId)), "CHAIN_ID");
-        super(decimals, symbol, name, logoUrl, isNative, true, coinGeckoId);
-        this.isToken = true;
-        // TODO(felix): bypassChecksum is a little confusing since when bypassChecksum is true, we still validate the address
-        // bypassChecksum is derived from the isNative parameter, so we should remove it and just check if isNative here
-        if (bypassChecksum) {
-            this.address = checkValidAddress(address)?.toLowerCase();
-        }
-        else if (!isNative) {
-            this.address = validateAndParseAddress(address)?.toLowerCase();
-        }
-        else {
-            this.address = address;
-        }
-        this.isNative = isNative || false;
-        this.chainId = chainId;
-    }
-    /**
-     * Returns true if the two tokens are equivalent, i.e. have the same chainId and address.
-     * @param other other token to compare
-     */
-    equals(other) {
-        if (this === other)
-            return true;
-        return (this.chainId == other?.chainId &&
-            this.address.toLowerCase() == other?.address?.toLowerCase());
-    }
-    /**
-     * Returns the currency object that this token represents
-     */
-    currency() {
-        return this;
-    }
-    type() {
-        return TokenType.FUNGIBLE_TOKEN;
-    }
-    identifier() {
-        return `${this.chainId}+${this.address.toLowerCase()}`;
-    }
-}

package/dist/entities/financial/fungible_token_amount.d.ts

@@ -1,36 +0,0 @@
-import JSBI from "jsbi";
-import { Fraction, BigintIsh, Rounding } from "@uniswap/sdk-core";
-import { FungibleToken } from "./fungible_token.js";
-import { CurrencyAmount } from "./currency_amount.js";
-export declare class FungibleTokenAmount extends Fraction {
-    readonly token: FungibleToken;
-    readonly decimalScale: JSBI;
-    private amountInFiatCurrency?;
-    /**
-     * Returns a new fungibleToken amount instance from the unitless amount of token, i.e. the raw amount
-     * @param fungibleToken the fungibleToken in the amount
-     * @param rawAmount the raw token or ether amount
-     */
-    static fromRawAmount(fungibleToken: FungibleToken, rawAmount: BigintIsh | bigint, amountInFiatCurrency?: CurrencyAmount): FungibleTokenAmount;
-    /**
-     * Construct a fungibleToken amount with a denominator that is not equal to 1
-     * @param fungibleToken the fungibleToken
-     * @param numerator the numerator of the fractional token amount
-     * @param denominator the denominator of the fractional token amount
-     */
-    static fromFractionalAmount(fungibleToken: FungibleToken, numerator: BigintIsh, denominator: BigintIsh, amountInFiatCurrency?: CurrencyAmount): FungibleTokenAmount;
-    static toFungibleTokenAmount(amount?: any): FungibleTokenAmount;
-    protected constructor(fungibleToken: FungibleToken, numerator: BigintIsh | bigint, denominator?: BigintIsh | bigint, amountInFiatCurrency?: CurrencyAmount);
-    equals(other: FungibleTokenAmount): boolean;
-    add(other: FungibleTokenAmount): FungibleTokenAmount;
-    subtract(other: FungibleTokenAmount): FungibleTokenAmount;
-    multiply(other: Fraction | BigintIsh): FungibleTokenAmount;
-    divide(other: Fraction | BigintIsh): FungibleTokenAmount;
-    greaterThanOrEqual(other: FungibleTokenAmount): boolean;
-    toRawAmount(): bigint;
-    fiatValue(): CurrencyAmount;
-    toCurrencyValue(price: CurrencyAmount): CurrencyAmount;
-    toSignificant(significantDigits?: number, format?: object, rounding?: Rounding): string;
-    toFixed(decimalPlaces?: number, format?: object, rounding?: Rounding): string;
-    toExact(format?: object): string;
-}

package/dist/entities/financial/fungible_token_amount.js

@@ -1,95 +0,0 @@
-import invariant from "tiny-invariant";
-import JSBI from "jsbi";
-import { Fraction, Rounding, MaxUint256 } from "@uniswap/sdk-core";
-import { FungibleToken } from "./fungible_token.js";
-import { CurrencyAmount } from "./currency_amount.js";
-import { Big } from "../../constants.js";
-// This class is inspired by the Uniswap SDK's (@uniswap/sdk-core) CurrencyAmount class. Created this instance here
-// because we have a need to represent a currency amount that is not a fungible token amount.
-export class FungibleTokenAmount extends Fraction {
-    /**
-     * Returns a new fungibleToken amount instance from the unitless amount of token, i.e. the raw amount
-     * @param fungibleToken the fungibleToken in the amount
-     * @param rawAmount the raw token or ether amount
-     */
-    static fromRawAmount(fungibleToken, rawAmount, amountInFiatCurrency) {
-        return new FungibleTokenAmount(fungibleToken, rawAmount, undefined, amountInFiatCurrency);
-    }
-    /**
-     * Construct a fungibleToken amount with a denominator that is not equal to 1
-     * @param fungibleToken the fungibleToken
-     * @param numerator the numerator of the fractional token amount
-     * @param denominator the denominator of the fractional token amount
-     */
-    static fromFractionalAmount(fungibleToken, numerator, denominator, amountInFiatCurrency) {
-        return new FungibleTokenAmount(fungibleToken, numerator, denominator, amountInFiatCurrency);
-    }
-    static toFungibleTokenAmount(amount) {
-        if (!amount) {
-            return undefined;
-        }
-        const amountInFiatCurrency = CurrencyAmount.toCurrencyAmount(amount.amountInFiatCurrency);
-        return FungibleTokenAmount.fromRawAmount(FungibleToken.toFungibleToken(amount.token), amount.value, amountInFiatCurrency);
-    }
-    constructor(fungibleToken, numerator, denominator, amountInFiatCurrency) {
-        super(numerator.toString(), denominator?.toString());
-        invariant(JSBI.lessThanOrEqual(this.quotient, MaxUint256), "AMOUNT"); // TODO(imti): fix this
-        this.token = fungibleToken;
-        this.decimalScale = JSBI.exponentiate(JSBI.BigInt(10), JSBI.BigInt(fungibleToken.decimals));
-        this.amountInFiatCurrency = amountInFiatCurrency;
-    }
-    equals(other) {
-        return (this.token.equals(other.token) &&
-            this.toRawAmount() == other.toRawAmount());
-    }
-    add(other) {
-        invariant(this.token.equals(other.token), "FUNGIBLE_TOKEN");
-        const added = super.add(other);
-        return FungibleTokenAmount.fromFractionalAmount(this.token, added.numerator, added.denominator);
-    }
-    subtract(other) {
-        invariant(this.token.equals(other.token), "FUNGIBLE_TOKEN");
-        const subtracted = super.subtract(other);
-        return FungibleTokenAmount.fromFractionalAmount(this.token, subtracted.numerator, subtracted.denominator);
-    }
-    multiply(other) {
-        const multiplied = super.multiply(other);
-        return FungibleTokenAmount.fromFractionalAmount(this.token, multiplied.numerator, multiplied.denominator);
-    }
-    divide(other) {
-        const divided = super.divide(other);
-        return FungibleTokenAmount.fromFractionalAmount(this.token, divided.numerator, divided.denominator);
-    }
-    greaterThanOrEqual(other) {
-        return this.greaterThan(other) || this.equals(other);
-    }
-    toRawAmount() {
-        return BigInt(this.quotient.toString());
-    }
-    fiatValue() {
-        return this.amountInFiatCurrency;
-    }
-    toCurrencyValue(price) {
-        const fraction = price.multiply(this);
-        const denominator = JSBI.multiply(fraction.denominator, this.decimalScale);
-        this.amountInFiatCurrency = CurrencyAmount.fromFractionalAmount(price.currency, fraction.numerator, denominator);
-        return this.amountInFiatCurrency;
-    }
-    toSignificant(significantDigits = 6, format, rounding = Rounding.ROUND_DOWN) {
-        return super
-            .divide(this.decimalScale)
-            .toSignificant(significantDigits, format, rounding);
-    }
-    toFixed(decimalPlaces = this.token.decimals, format, rounding = Rounding.ROUND_DOWN) {
-        invariant(decimalPlaces <= this.token.decimals, "DECIMALS");
-        return super
-            .divide(this.decimalScale)
-            .toFixed(decimalPlaces, format, rounding);
-    }
-    toExact(format = { groupSeparator: "" }) {
-        Big.DP = this.token.decimals;
-        return new Big(this.quotient.toString())
-            .div(this.decimalScale.toString())
-            .toFormat(format);
-    }
-}

package/dist/entities/financial/non_fungible_token.d.ts

@@ -1,39 +0,0 @@
-import { Asset } from "./asset.js";
-import { TokenType } from "../../enums.js";
-/**
- * Represents an ERC721 token with a unique address and some metadata.
- */
-export declare class NonFungibleToken extends Asset {
-    readonly isNative: false;
-    readonly isToken: true;
-    /**
-     * The contract address on the chain on which this token lives
-     */
-    readonly address: string;
-    /**
-     * The chain ID on which this token resides
-     */
-    readonly chainId: bigint;
-    readonly url?: string;
-    /**
-     * @param chainId The chain ID on which this token resides
-     * @param address The contract address on the chain on which this token lives
-     * @param symbol {@link Currency#symbol}
-     * @param name {@link Currency#name}
-     * @param url The URL of the token's metadata
-     * @param bypassChecksum If true it only checks for length === 42, startsWith 0x and contains only hex characters
-     */
-    constructor(chainId: bigint, address: string, symbol: string, name: string, url?: string, bypassChecksum?: boolean, coinGeckoId?: string);
-    static toNonFungibleToken(nft?: any): NonFungibleToken;
-    /**
-     * Returns true if the two tokens are equivalent, i.e. have the same chainId and address.
-     * @param other other token to compare
-     */
-    equals(other: NonFungibleToken): boolean;
-    /**
-     * Returns the asset representation of this currency
-     */
-    asset(): Asset;
-    type(): TokenType;
-    identifier(): string;
-}

package/dist/entities/financial/non_fungible_token.js

@@ -1,61 +0,0 @@
-import { Asset } from "./asset.js";
-import { checkValidAddress, validateAndParseAddress, } from "../../utils/validateAndParseAddress.js";
-import { TokenType } from "../../enums.js";
-/**
- * Represents an ERC721 token with a unique address and some metadata.
- */
-export class NonFungibleToken extends Asset {
-    /**
-     * @param chainId The chain ID on which this token resides
-     * @param address The contract address on the chain on which this token lives
-     * @param symbol {@link Currency#symbol}
-     * @param name {@link Currency#name}
-     * @param url The URL of the token's metadata
-     * @param bypassChecksum If true it only checks for length === 42, startsWith 0x and contains only hex characters
-     */
-    constructor(chainId, address, symbol, name, url, bypassChecksum, coinGeckoId) {
-        // TODO(felix): add this back
-        // invariant(!_.isUndefined(getBlockchainFromBlockchainId(chainId)), "CHAIN_ID");
-        super(symbol, name, coinGeckoId);
-        this.isNative = false;
-        this.isToken = true;
-        if (bypassChecksum) {
-            this.address = checkValidAddress(address)?.toLowerCase();
-        }
-        else {
-            this.address = validateAndParseAddress(address)?.toLowerCase();
-        }
-        this.chainId = chainId;
-        this.url = url;
-    }
-    static toNonFungibleToken(nft) {
-        if (!nft) {
-            return undefined;
-        }
-        const asset = Asset.toAsset(nft.asset);
-        return new NonFungibleToken(nft.chainId, nft.address, asset.symbol, asset.name, nft.url);
-    }
-    /**
-     * Returns true if the two tokens are equivalent, i.e. have the same chainId and address.
-     * @param other other token to compare
-     */
-    equals(other) {
-        // short circuit on reference equality
-        if (this === other)
-            return true;
-        return (this.chainId === other.chainId &&
-            this.address === other.address.toLowerCase());
-    }
-    /**
-     * Returns the asset representation of this currency
-     */
-    asset() {
-        return this;
-    }
-    type() {
-        return TokenType.NON_FUNGIBLE_TOKEN;
-    }
-    identifier() {
-        return `${this.chainId}+${this.address.toLowerCase()}`;
-    }
-}

package/dist/entities/financial/semi_fungible_token.d.ts

@@ -1,41 +0,0 @@
-import { Currency } from "./currency.js";
-import { TokenType } from "../../enums.js";
-/**
- * Represents an ERC1155 token with a unique address and some metadata.
- */
-export declare class SemiFungibleToken extends Currency {
-    readonly isNative: false;
-    readonly isToken: true;
-    /**
-     * The contract address on the chain on which this token lives
-     */
-    readonly address: string;
-    /**
-     * The chain ID on which this token resides
-     */
-    readonly chainId: bigint;
-    readonly url?: string;
-    /**
-     *
-     * @param chainId The chain ID on which this token resides
-     * @param address The contract address on the chain on which this token lives
-     * @param decimals {@link Currency#decimals}
-     * @param symbol {@link Currency#symbol}
-     * @param name {@link Currency#name}
-     * @param url The URL of the token's metadata
-     * @param bypassChecksum If true it only checks for length === 42, startsWith 0x and contains only hex characters
-     */
-    constructor(chainId: bigint, address: string, decimals: number, symbol: string, name: string, url?: string, bypassChecksum?: boolean, coinGeckoId?: string);
-    static toSemiFungibleToken(sft?: any): SemiFungibleToken;
-    /**
-     * Returns true if the two tokens are equivalent, i.e. have the same chainId and address.
-     * @param other other token to compare
-     */
-    equals(other: SemiFungibleToken): boolean;
-    /**
-     * Returns the currency object that this token represents
-     */
-    currency(): Currency;
-    type(): TokenType;
-    identifier(): string;
-}

package/dist/entities/financial/semi_fungible_token.js

@@ -1,63 +0,0 @@
-import { Currency } from "./currency.js";
-import { checkValidAddress, validateAndParseAddress, } from "../../utils/validateAndParseAddress.js";
-import { TokenType } from "../../enums.js";
-/**
- * Represents an ERC1155 token with a unique address and some metadata.
- */
-export class SemiFungibleToken extends Currency {
-    /**
-     *
-     * @param chainId The chain ID on which this token resides
-     * @param address The contract address on the chain on which this token lives
-     * @param decimals {@link Currency#decimals}
-     * @param symbol {@link Currency#symbol}
-     * @param name {@link Currency#name}
-     * @param url The URL of the token's metadata
-     * @param bypassChecksum If true it only checks for length === 42, startsWith 0x and contains only hex characters
-     */
-    constructor(chainId, address, decimals, symbol, name, url, bypassChecksum, coinGeckoId) {
-        // TODO(felix): add this back
-        // invariant(!_.isUndefined(getBlockchainFromBlockchainId(chainId)), "CHAIN_ID");
-        super(decimals, symbol, name, url, false, true, coinGeckoId);
-        this.isNative = false;
-        this.isToken = true;
-        if (bypassChecksum) {
-            this.address = checkValidAddress(address)?.toLowerCase();
-        }
-        else {
-            this.address = validateAndParseAddress(address)?.toLowerCase();
-        }
-        this.chainId = chainId;
-        this.url = url;
-    }
-    static toSemiFungibleToken(sft) {
-        if (!sft) {
-            return undefined;
-        }
-        const currency = Currency.toCurrency(sft.currency);
-        return new SemiFungibleToken(sft.chainId, sft.address, currency.decimals, currency.symbol, currency.name, sft.url);
-    }
-    /**
-     * Returns true if the two tokens are equivalent, i.e. have the same chainId and address.
-     * @param other other token to compare
-     */
-    equals(other) {
-        // short circuit on reference equality
-        if (this === other)
-            return true;
-        return (this.chainId === other.chainId &&
-            this.address === other.address.toLowerCase());
-    }
-    /**
-     * Returns the currency object that this token represents
-     */
-    currency() {
-        return this;
-    }
-    type() {
-        return TokenType.SEMI_FUNGIBLE_TOKEN;
-    }
-    identifier() {
-        return `${this.chainId}+${this.address.toLowerCase()}`;
-    }
-}

package/dist/entities/library_request.d.ts

@@ -1,8 +0,0 @@
-import { LIBRARY_TYPE } from "../enums.js";
-export declare class LibraryRequest {
-    readonly library: LIBRARY_TYPE;
-    readonly client?: any;
-    readonly provider?: any;
-    constructor(library: LIBRARY_TYPE, client?: any, provider?: any);
-    sendRequest(method: string, params: any[]): Promise<any>;
-}

package/dist/entities/library_request.js

@@ -1,30 +0,0 @@
-import { LIBRARY_TYPE } from "../enums.js";
-import invariant from "tiny-invariant";
-export class LibraryRequest {
-    constructor(library, client, provider) {
-        if (library == LIBRARY_TYPE.VIEM) {
-            invariant(client, "CLIENT");
-            invariant(!provider, "PROVIDER");
-            this.client = client;
-        }
-        else if (library == LIBRARY_TYPE.ETHERS) {
-            invariant(provider, "PROVIDER");
-            invariant(!client, "CLIENT");
-            this.provider = provider;
-        }
-        else {
-            invariant(false, "LIBRARY");
-        }
-        this.library = library;
-        this.client = client;
-        this.provider = provider;
-    }
-    sendRequest(method, params) {
-        if (this.library == LIBRARY_TYPE.VIEM) {
-            return this.client.request({ method, params });
-        }
-        else if (this.library == LIBRARY_TYPE.ETHERS) {
-            return this.provider.send(method, params);
-        }
-    }
-}

package/dist/entities/state.d.ts

@@ -1,22 +0,0 @@
-import { FungibleToken } from "./financial/fungible_token.js";
-import { FungibleTokenAmount } from "./financial/fungible_token_amount.js";
-import { NonFungibleToken } from "./financial/non_fungible_token.js";
-import { SemiFungibleToken } from "./financial/semi_fungible_token.js";
-export declare class State {
-    private readonly fungibleTokens;
-    private readonly nonFungibleTokens;
-    private readonly semiFungibleTokens;
-    constructor(fungibleTokens: FungibleTokenAmount[], nonFungibleTokens: NonFungibleToken[], semiFungibleTokens: SemiFungibleToken[]);
-    static fromFungibleTokenAmounts(fungibleTokenAmounts: FungibleTokenAmount[]): State;
-    static fromTokenAndAmount(token?: FungibleToken, amount?: bigint): State;
-    getFungibleTokens(): FungibleTokenAmount[];
-    getNonFungibleTokens(): NonFungibleToken[];
-    getSemiFungibleTokens(): SemiFungibleToken[];
-    addTokens(fungibleTokens: FungibleTokenAmount[]): State;
-    addState(other: State): State;
-    deductState(other: State): State;
-    equals(other?: State): boolean;
-    addStates(states: State[]): State;
-    static mergeStates(states: State[]): State;
-    static toState(state: any): State;
-}

package/dist/entities/state.js

@@ -1,102 +0,0 @@
-import { FungibleTokenAmount } from "./financial/fungible_token_amount.js";
-import { NonFungibleToken } from "./financial/non_fungible_token.js";
-import { SemiFungibleToken } from "./financial/semi_fungible_token.js";
-export class State {
-    constructor(fungibleTokens, nonFungibleTokens, semiFungibleTokens) {
-        this.fungibleTokens = fungibleTokens.reduce((acc, amount) => {
-            acc.set(amount.token.identifier(), amount);
-            return acc;
-        }, new Map());
-        this.nonFungibleTokens = nonFungibleTokens.reduce((acc, token) => {
-            acc.set(token.identifier(), token);
-            return acc;
-        }, new Map());
-        this.semiFungibleTokens = semiFungibleTokens.reduce((acc, token) => {
-            acc.set(token.identifier(), token);
-            return acc;
-        }, new Map());
-    }
-    static fromFungibleTokenAmounts(fungibleTokenAmounts) {
-        return new State(fungibleTokenAmounts, [], []);
-    }
-    static fromTokenAndAmount(token, amount) {
-        if (!token || !amount) {
-            return undefined;
-        }
-        const fungibleTokenAmount = FungibleTokenAmount.fromRawAmount(token, amount);
-        return State.fromFungibleTokenAmounts([fungibleTokenAmount]);
-    }
-    getFungibleTokens() {
-        return Array.from(this.fungibleTokens.values());
-    }
-    getNonFungibleTokens() {
-        return Array.from(this.nonFungibleTokens.values());
-    }
-    getSemiFungibleTokens() {
-        return Array.from(this.semiFungibleTokens.values());
-    }
-    addTokens(fungibleTokens) {
-        fungibleTokens.forEach((amount) => {
-            const identifier = amount.token.identifier();
-            const currentAmount = this.fungibleTokens.get(identifier);
-            if (currentAmount) {
-                this.fungibleTokens.set(identifier, currentAmount.add(amount));
-            }
-            else {
-                this.fungibleTokens.set(identifier, amount);
-            }
-        });
-        return this;
-    }
-    addState(other) {
-        other?.fungibleTokens?.forEach((amount) => {
-            const identifier = amount.token.identifier();
-            const currentAmount = this.fungibleTokens.get(identifier);
-            if (currentAmount) {
-                this.fungibleTokens.set(identifier, currentAmount.add(amount));
-            }
-            else {
-                this.fungibleTokens.set(identifier, amount);
-            }
-        });
-        return this;
-    }
-    deductState(other) {
-        other.fungibleTokens.forEach((amount) => {
-            const identifier = amount.token.identifier();
-            const currentAmount = this.fungibleTokens.get(identifier);
-            if (currentAmount?.toRawAmount() > amount?.toRawAmount()) {
-                this.fungibleTokens.set(identifier, currentAmount.subtract(amount));
-            }
-            else if (currentAmount) {
-                this.fungibleTokens.delete(identifier);
-            }
-        });
-        return this;
-    }
-    equals(other) {
-        if (!other) {
-            return false;
-        }
-        return (this.fungibleTokens.size == other.fungibleTokens.size &&
-            Array.from(this.fungibleTokens.entries()).every(([key, value]) => {
-                const otherValue = other.fungibleTokens.get(key);
-                return otherValue && value.equals(otherValue);
-            }));
-    }
-    addStates(states) {
-        states.forEach((state) => this.addState(state));
-        return this;
-    }
-    static mergeStates(states) {
-        return states.reduce((acc, state) => acc.addState(state), new State([], [], []));
-    }
-    static toState(state) {
-        if (!state)
-            return undefined;
-        const fungibleTokenAmounts = state.fungibleTokenAmounts.map((ft) => FungibleTokenAmount.toFungibleTokenAmount(ft));
-        const nonFungibleTokenAmounts = state.nonFungibleTokenAmounts.map((nft) => NonFungibleToken.toNonFungibleToken(nft));
-        const semiFungibleTokenAmounts = state.semiFungibleTokenAmounts.map((sft) => SemiFungibleToken.toSemiFungibleToken(sft));
-        return new State(fungibleTokenAmounts, nonFungibleTokenAmounts, semiFungibleTokenAmounts);
-    }
-}