@aurigami/sdk 1.5.10 → 1.6.0-no-src

package/dist/SDK.d.ts

@@ -1,31 +1,38 @@
 import { AuriFairLaunch, AuriLens, Comptroller } from '@aurigami/contracts/typechain';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
-import { BlockchainEntity, BlockchainEntityRead } from './BlockchainEntity';
-import { StakingRead } from './Staking';
-import { Token } from './token';
-import { TokenAmount } from './tokenAmount';
-import { CurrencyAmount, HypotheticalStats, MarketAction, NetworkConnection, PLYWNEARPoolDetails, UserDetails, UserMarketDetails } from './types';
+import { StakingRead } from './contracts';
+import { BlockchainEntity, BlockchainEntityRead, Token, TokenAmount } from './entities';
+import * as types from './types';
 export declare class SdkRead extends BlockchainEntityRead {
     protected _comptroller: Comptroller;
     protected _auriFairLaunch: AuriFairLaunch;
     protected _auriLens: AuriLens;
     protected _stakingRead: StakingRead;
-    constructor(networkConnection: NetworkConnection);
-    getUserDetails(userAddress: string): Promise<UserDetails>;
-    getPLYWNEARPoolDetails(): Promise<PLYWNEARPoolDetails>;
-    getTokenPrice(token: Token): Promise<CurrencyAmount>;
+    constructor(networkConnection: types.NetworkConnection);
+    getUserDetails(userAddress: string): Promise<types.UserDetails>;
+    getPLYWNEARPoolDetails(): Promise<types.PLYWNEARPoolDetails>;
+    getTokenPrice(token: Token): Promise<types.CurrencyAmount>;
+    /**
+     * Get amount of staked LP tokens
+     */
     stakeBalanceOf(user: string): Promise<TokenAmount>;
+    /**
+     * Get amount of LP token in user wallet
+     */
     LpBalanceOf(user: string): Promise<TokenAmount>;
     unclaimedRewardsOf(user: string): Promise<TokenAmount[]>;
     calcHypotheticalStats({ userMarketDetail, currentBorrowLimit, currentBorrowValuation, action, tokenAmount, }: {
-        userMarketDetail: UserMarketDetails;
-        currentBorrowLimit: CurrencyAmount;
-        currentBorrowValuation: CurrencyAmount;
-        action: MarketAction;
+        userMarketDetail: types.UserMarketDetails;
+        currentBorrowLimit: types.CurrencyAmount;
+        currentBorrowValuation: types.CurrencyAmount;
+        action: types.MarketAction;
         tokenAmount?: TokenAmount;
-    }): HypotheticalStats;
+    }): types.HypotheticalStats;
 }
 export declare class SdkReadWrite extends SdkRead {
+    /**
+     * Claim PLY reward in all markets + staking pools
+     */
     claim(): Promise<TransactionResponse>;
     claimLpRewards(): Promise<TransactionResponse>;
     stake(amount: TokenAmount): Promise<TransactionResponse>;
@@ -34,6 +41,6 @@ export declare class SdkReadWrite extends SdkRead {
 }
 export declare class SDK extends BlockchainEntity {
     constructor();
-    read(networkConnection: NetworkConnection): SdkRead;
-    readWrite(networkConnection: NetworkConnection): SdkReadWrite;
+    read(networkConnection: types.NetworkConnection): SdkRead;
+    readWrite(networkConnection: types.NetworkConnection): SdkReadWrite;
 }

package/dist/consts/deployments.d.ts

@@ -0,0 +1,3 @@
+import MAINNET_ADDRESSES from '@aurigami/contracts/deployments/aurora_mainnet.json';
+import TESTNET_ADDRESSES from '@aurigami/contracts/deployments/aurora_testnet.json';
+export { MAINNET_ADDRESSES, TESTNET_ADDRESSES };

package/dist/{dummy.d.ts → consts/dummy.d.ts}

@@ -1,6 +1,6 @@
-import { Token } from './token';
-import { TokenAmount } from './tokenAmount';
-import { UserMarketDetails } from './types';
+import { Token } from '../entities';
+import { TokenAmount } from '../entities';
+import { UserMarketDetails } from '../types';
 export declare const dummyToken: Token;
 export declare const dummyPly: Token;
 export declare const dummyPlyAurora: Token;

package/dist/consts/index.d.ts

@@ -0,0 +1,4 @@
+export * from './constants';
+export * from './decimals';
+export * from './dummy';
+export * from './deployments';

package/dist/{MoneyMarket.d.ts → contracts/MoneyMarket.d.ts}

@@ -1,11 +1,9 @@
-import { BlockchainEntity, BlockchainEntityRead } from './BlockchainEntity';
-import { MoneyMarketDetails, NetworkConnection, Address } from './types';
-import { BigNumber as BN } from 'ethers';
 import { AuErc20, AuETH, AuriLens, Comptroller, EthRepayHelper } from '@aurigami/contracts/typechain';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
 import BigNumber from 'bignumber.js';
-import { Token } from './token';
-import { TokenAmount } from './tokenAmount';
+import { BigNumber as BN } from 'ethers';
+import { BlockchainEntity, BlockchainEntityRead, Token, TokenAmount } from '../entities';
+import { Address, MoneyMarketDetails, NetworkConnection } from '../types';
 declare type RewardSpeeds = {
     plyRewardSupplySpeed: BN;
     plyRewardBorrowSpeed: BN;

package/dist/{Papermill.d.ts → contracts/Papermill.d.ts}

@@ -1,9 +1,7 @@
-import { BlockchainEntity, BlockchainEntityRead } from './BlockchainEntity';
-import { NetworkConnection, Address, UserLockingDetails } from './types';
 import { AuriFairLaunch, AuriLens, Comptroller, IERC20, PULP } from '@aurigami/contracts/typechain';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
-import { Token } from './token';
-import { TokenAmount } from './tokenAmount';
+import { BlockchainEntity, BlockchainEntityRead, Token, TokenAmount } from '../entities';
+import { Address, NetworkConnection, UserLockingDetails } from '../types';
 export declare class PapermillRead extends BlockchainEntityRead {
     plyToken: Token;
     pulpToken: Token;
@@ -15,15 +13,38 @@ export declare class PapermillRead extends BlockchainEntityRead {
     constructor(networkConnection: NetworkConnection);
     getPlyBalance(userAddress: Address): Promise<TokenAmount>;
     getPulpBalance(userAddress: Address): Promise<TokenAmount>;
+    /**
+     * Get all unclaimed PLY reward of the user in all markets + all staking pools
+     */
     getUnclaimedPlyReward(userAddress: Address): Promise<TokenAmount>;
     private getWeek;
+    /**
+     * Get all locking details of the user in all markets + all staking pools
+     */
     getLockingDetails(userAddress: Address): Promise<UserLockingDetails>;
+    /**
+     * Get the first timestamp that the unlockPortion reach the target
+     *
+     * @param userAddress currently doesn't matter
+     * @param targetUnlockPortion unlockPortion target
+     */
     getTimestampToUnlock(userAddress: Address, targetUnlockPortion: number): Promise<number>;
     getUnlockPortionAt(userAddress: Address, timestamp: number): Promise<number>;
 }
 export declare class PapermillReadWrite extends PapermillRead {
     constructor(networkConnection: NetworkConnection);
+    /**
+     * Redeem PLY from PULP and transfer PLY to another address
+     * @param recipient Address that will receive the PLY.
+     * @param amount Amount of PULP to be converted to PLY.
+     * Set to ethers.constants.MaxUint256 for max redeem.
+     */
     redeem(recipient: Address, amount: TokenAmount): Promise<TransactionResponse>;
+    /**
+     * Redeem PLY from PULP and transfer PLY to msg.sender
+     * @param amount Amount of PULP to be converted to PLY.
+     * Set to ethers.constants.MaxUint256 for max redeem.
+     */
     selfRedeem(amount: TokenAmount): Promise<TransactionResponse>;
 }
 export declare class Papermill extends BlockchainEntity {

package/dist/{Staking.d.ts → contracts/Staking.d.ts}

@@ -1,15 +1,20 @@
 import { AuriFairLaunch, AuriLens, Comptroller } from '@aurigami/contracts/typechain';
 import { TransactionResponse } from '@ethersproject/abstract-provider';
-import { BlockchainEntity, BlockchainEntityRead } from './BlockchainEntity';
-import { TokenAmount } from './tokenAmount';
-import { NetworkConnection, PLYWNEARPoolDetails } from './types';
+import { BlockchainEntity, BlockchainEntityRead, TokenAmount } from '../entities';
+import { NetworkConnection, PLYWNEARPoolDetails } from '../types';
 export declare class StakingRead extends BlockchainEntityRead {
     protected _comptroller: Comptroller;
     protected _auriFairLaunch: AuriFairLaunch;
     protected _auriLens: AuriLens;
     constructor(networkConnection: NetworkConnection);
     getPLYWNEARPoolDetails(): Promise<PLYWNEARPoolDetails>;
+    /**
+     * Get amount of staked LP tokens
+     */
     stakeBalanceOf(user: string): Promise<TokenAmount>;
+    /**
+     * Get amount of LP token in user wallet
+     */
     LpBalanceOf(user: string): Promise<TokenAmount>;
     unclaimedRewardsOf(user: string): Promise<TokenAmount[]>;
 }

package/dist/{airdrop-lottery.d.ts → contracts/airdrop-lottery.d.ts}

@@ -1,8 +1,7 @@
-import { TransactionResponse } from '@ethersproject/abstract-provider';
-import { BlockchainEntity, BlockchainEntityRead } from './BlockchainEntity';
-import { Address, NetworkConnection } from './types';
 import { AuriAirdrop } from '@aurigami/contracts/typechain';
-import { TokenAmount } from './tokenAmount';
+import { TransactionResponse } from '@ethersproject/abstract-provider';
+import { BlockchainEntity, BlockchainEntityRead, TokenAmount } from '../entities';
+import { Address, NetworkConnection } from '../types';
 export declare class AirdropRead extends BlockchainEntityRead {
     protected _airDrop: AuriAirdrop;
     private _whitelistedAddresses;
@@ -11,10 +10,19 @@ export declare class AirdropRead extends BlockchainEntityRead {
     countWhitelistedAddresses(): number;
     isWhitelisted(user: string): boolean;
     hasCompletedChallenge(user: string): Promise<boolean>;
+    /**
+     * Get redeemable rewards amount of user
+     */
     getRedeemableReward(campaign: string, token: Address, user: Address): Promise<TokenAmount>;
 }
 export declare class AirdropReadWrite extends AirdropRead {
+    /**
+     * Transfer rewards from multiple campaigns to msg.sender
+     */
     redeemMultiple(campaigns: string[], tokens: Address[]): Promise<TransactionResponse>;
+    /**
+     * Redeem reward from a single campaign
+     */
     redeemSingle(campaign: string, token: Address): Promise<TransactionResponse>;
 }
 export declare class Airdrop extends BlockchainEntity {

package/dist/contracts/index.d.ts

@@ -0,0 +1,4 @@
+export * from './airdrop-lottery';
+export * from './MoneyMarket';
+export * from './Papermill';
+export * from './Staking';

package/dist/{BlockchainEntity.d.ts → entities/BlockchainEntity.d.ts}

@@ -1,4 +1,4 @@
-import { NetworkConnection } from './types';
+import { NetworkConnection } from '../types';
 export declare class BlockchainEntityRead {
     protected _networkConnection: NetworkConnection;
     constructor(networkConnection: NetworkConnection);

package/dist/entities/index.d.ts

@@ -0,0 +1,3 @@
+export * from './BlockchainEntity';
+export * from './token';
+export * from './tokenAmount';

package/dist/{tokenAmount.d.ts → entities/tokenAmount.d.ts}

@@ -1,5 +1,5 @@
 import { Token } from './token';
-import { Address } from './types';
+import { Address } from '../types';
 export declare class TokenAmount {
     readonly token: Token;
     private rawAmnt;

package/dist/{helpers.d.ts → helpers/helpers.d.ts}

@@ -1,6 +1,6 @@
 import { Provider } from '@ethersproject/abstract-provider';
 import BigNumber from 'bignumber.js';
-import { Address } from './types';
+import { Address } from '../types';
 export declare function assert(condition: boolean, message?: string): void;
 export declare function formatObject(object: Object): string;
 export declare function decimalFactor(decimal: number): string;
@@ -10,4 +10,13 @@ export declare function validateAndParseAddress(address: Address): Address;
 export declare function getDecimal(address: Address): number;
 export declare function calcLMRewardApr(rewardsValue: BigNumber, totalStakeValue: BigNumber, frequencyPerYear: number): BigNumber;
 export declare function getBlockTimestamp(provider: Provider, blockNumber: number): Promise<number>;
+/**
+ * Get the block number of the last block that has a timestamp before the given timestamp
+ * @param timestamp input timestamp
+ * @returns return the last block that its timestamp <= the give timestamp
+ * @note Check this API for more information: https://aurorascan.dev/apis#blocks
+ *
+ * This function is much faster than using binary search.
+ */
 export declare function getBlockBeforeTimestamp(provider: Provider, timestamp: number): Promise<number>;
+export declare function devLog(message?: any, ...optionalParams: any[]): void;

package/dist/helpers/index.d.ts

@@ -0,0 +1,4 @@
+export * from './aurora-api-helpers';
+export * from './helpers';
+export * from './priceFetcher';
+export * from './transfer-event-query';

package/dist/{priceFetcher.d.ts → helpers/priceFetcher.d.ts}

@@ -1,7 +1,7 @@
 import BigNumber from 'bignumber.js';
 import { providers, BigNumber as BN } from 'ethers';
-import { TokenAmount } from './tokenAmount';
-import { Address, TokenValuation } from './types';
+import { TokenAmount } from '../entities/tokenAmount';
+import { Address, TokenValuation } from '../types';
 export declare function fetchPriceFromCoingeckoAPI(id: string): Promise<BigNumber>;
 export declare function fetchPriceFromCoingecko(id: Address): Promise<BigNumber>;
 export declare function fetchLPPositions(LPAddress: Address, provider: providers.Provider): Promise<{

package/dist/{transfer-event-query.d.ts → helpers/transfer-event-query.d.ts}

@@ -1,5 +1,5 @@
-import { BlockchainEntityRead } from './BlockchainEntity';
-import { NetworkConnection } from './types';
+import { BlockchainEntityRead } from '../entities/BlockchainEntity';
+import { NetworkConnection } from '../types';
 import { AuToken } from '@aurigami/contracts/typechain';
 import { BigNumber as BN } from 'ethers';
 declare type SimpleTransfer = {
@@ -11,7 +11,16 @@ declare type SimpleTransfer = {
 export declare class TransferEventQuery extends BlockchainEntityRead {
     auToken: AuToken;
     constructor(tokenAddr: string, networkConnection: NetworkConnection);
+    /**
+     * query ERC20 transfers from/to an address & auto convert them into SimpleTransfer.
+     * The result will be sorted by blocknumber.
+     */
     queryERC20TransfersOf(address: string, fromBlock: number, toBlock: number): Promise<SimpleTransfer[]>;
+    /**
+     * Get the balance of an address at a given block number.
+     *
+     * Note that this will return the balance after the block get mined.
+     */
     queryERC20BalanceAt(address: string, endBlock: number): Promise<BN>;
 }
 export {};

package/dist/index.d.ts

@@ -1,13 +1,6 @@
-export * from './SDK';
-export * from './MoneyMarket';
-export * from './BlockchainEntity';
+export * from './consts';
+export * from './contracts';
+export * from './entities';
 export * from './helpers';
-export * from './constants';
-export * from './dummy';
-export * from './priceFetcher';
-export * from './token';
-export * from './tokenAmount';
 export * from './types';
-export * from './airdrop-lottery';
-export * from './transfer-event-query';
-export * from './Papermill';
+export * from './SDK';