@devprotocol/dev-kit - npm Package Compare versions

Comparing version 8.6.0-alpha.0 to 8.6.0

dist/dev-kit.d.ts

@@ -1,2 +0,3 @@
-import { TransactionResponse, ethers, ContractRunner } from 'ethers';
+import { TransactionResponse, ethers, ContractRunner, TransactionReceipt } from 'ethers';
+import { UndefinedOr } from '@devprotocol/util-ts';
 
@@ -260,3 +261,3 @@ declare const addresses: {
 
-type PropertyContract = {
+type PropertyContract$1 = {
     readonly totalSupply: () => Promise<string>;
@@ -277,3 +278,3 @@ readonly balanceOf: (address: string) => Promise<string>;
 };
-type CreatePropertyContract = (provider: ContractRunner) => (address: string) => PropertyContract;
+type CreatePropertyContract = (provider: ContractRunner) => (address: string) => PropertyContract$1;
 declare const createPropertyContract: CreatePropertyContract;
@@ -285,3 +286,3 @@
 
-type PropertyFactoryContract = {
+type PropertyFactoryContract$1 = {
     readonly create: (name: string, symbol: string, author: string, overrides?: FallbackableOverrides) => Promise<string>;
@@ -295,3 +296,3 @@ readonly createAndAuthenticate: (name: string, symbol: string, marketAddress: string, args: readonly string[], options: WaitForEventOptions, overrides?: FallbackableOverrides) => Promise<{
 };
-declare const createPropertyFactoryContract: (provider: ContractRunner) => (address: string) => PropertyFactoryContract;
+declare const createPropertyFactoryContract: (provider: ContractRunner) => (address: string) => PropertyFactoryContract$1;
 
@@ -304,3 +305,3 @@ type CreateAllocatorContract = {
 
-type LockupContract = {
+type LockupContract$1 = {
     readonly getValue: (propertyAddress: string, accountAddress: string) => Promise<string>;
@@ -323,5 +324,5 @@ readonly getAllValue: () => Promise<string>;
 };
-declare const createLockupContract: (provider: ContractRunner) => (address: string) => LockupContract;
+declare const createLockupContract: (provider: ContractRunner) => (address: string) => LockupContract$1;
 
-type DevContract = {
+type DevContract$1 = {
     readonly totalSupply: () => Promise<string>;
@@ -339,3 +340,3 @@ readonly balanceOf: (address: string) => Promise<string>;
 };
-declare const createDevContract: (provider: ContractRunner) => (address: string) => DevContract;
+declare const createDevContract: (provider: ContractRunner) => (address: string) => DevContract$1;
 
@@ -352,3 +353,3 @@ type WithdrawContract = {
 
-type RegistryContract = {
+type RegistryContract$1 = {
     readonly allocator: () => Promise<string>;
@@ -373,6 +374,6 @@ readonly allocatorStorage: () => Promise<string>;
 };
-type CreateRegistryContract = (provider: ContractRunner) => (address: string) => RegistryContract;
+type CreateRegistryContract = (provider: ContractRunner) => (address: string) => RegistryContract$1;
 declare const createRegistryContract: CreateRegistryContract;
 
-type PolicyContract = {
+type PolicyContract$1 = {
     readonly holdersShare: (amount: string, lockups: string) => Promise<string>;
@@ -388,3 +389,3 @@ readonly rewards: (lockups: string, assets: string) => Promise<string>;
 };
-declare const createPolicyContract: (provider: ContractRunner) => (address: string) => PolicyContract;
+declare const createPolicyContract: (provider: ContractRunner) => (address: string) => PolicyContract$1;
 
@@ -460,7 +461,7 @@ type PolicyGroupContract = {
 
-type MarketFactoryContract = {
+type MarketFactoryContract$1 = {
     readonly create: (marketBehaviorAddress: string, overrides?: FallbackableOverrides) => Promise<TransactionResponse>;
     readonly contract: () => ethers.Contract;
 };
-declare const createMarketFactoryContract: (provider: ContractRunner) => (address: string) => MarketFactoryContract;
+declare const createMarketFactoryContract: (provider: ContractRunner) => (address: string) => MarketFactoryContract$1;
 
@@ -1229,2 +1230,335 @@ declare const erc20Abi: ({
 
-export { type ContractFactory, type CreateAllocatorContract, type CreateDevkitContract, type CreateMarketBehaviorContract, type CreateMarketContract, type CreateMetricsContract, type CreateMetricsGroupContract, type CreatePolicyFactoryContract, type CreatePolicyGroupContract, type CreatePropertyContract, type CreateRegistryContract, type CustomOptions, type DevContract, type DevkitClient, type DevkitContract, type DevkitUtils, type Erc20Contract, type Image, type LockupContract, type MarketFactoryContract, type PolicyContract, type PolicyFactoryContract, type PolicyGroupContract, type Positions, type PropertyContract, type PropertyFactoryContract, type RegistryContract, type STokensContract, type ValidProvider, type WithdrawContract, addressConfigAbi, addresses, allocatorAbi, arrayify, client, contractFactory, createAllocatorContract, createDetectSTokens, createDevContract, createDevkitContract, createErc20Contract, createLockupContract, createMarketBehaviorContract, createMarketContract, createMarketFactoryContract, createMetricsContract, createMetricsGroupContract, createPolicyContract, createPolicyFactoryContract, createPolicyGroupContract, createPropertyContract, createPropertyFactoryContract, createRegistryContract, createSTokensContract, createSimpleCollectionsContract, createWithdrawContract, devAbi, erc20Abi, execute, lockupAbi, marketAbi, marketAddresses, marketBehaviorAbi, marketFactoryAbi, metricsAbi, metricsFactoryAbi, metricsGroupAbi, policyAbi, policyFactoryAbi, policyGroupAbi, propertyAbi, propertyFactoryAbi, sTokensAbi, simpleCollectionsAbi, utils, withdrawAbi };
+type ApproveIfNeededResultForApproveIsNeeded = {
+    readonly approvalNeeded: true;
+    readonly approveIfNeeded: (options?: {
+        readonly amount?: string;
+        readonly overrides?: FallbackableOverrides;
+    }) => Promise<TransactionResponse & {
+        readonly waitNeeded: true;
+        readonly waitOrSkipApproval: () => Promise<(TransactionReceipt | null) & {
+            readonly run: () => Promise<TransactionResponse>;
+        }>;
+    }>;
+};
+type ApproveIfNeededResultForApproveIsNotNeeded = {
+    readonly approvalNeeded: false;
+    readonly approveIfNeeded: (options?: {
+        readonly amount?: string;
+        readonly overrides?: FallbackableOverrides;
+    }) => Promise<{
+        readonly waitNeeded: false;
+        readonly waitOrSkipApproval: () => Promise<{
+            readonly run: () => Promise<TransactionResponse>;
+        }>;
+    }>;
+};
+type ApproveIfNeededResult = ApproveIfNeededResultForApproveIsNeeded | ApproveIfNeededResultForApproveIsNotNeeded;
+type ApproveIfNeeded = (factoryOptions: {
+    readonly provider: ContractRunner;
+    readonly requiredAmount: string;
+    readonly from: string;
+    readonly to?: string;
+    readonly token?: string;
+    readonly callback: (receipt?: TransactionReceipt | null) => Promise<TransactionResponse>;
+}) => Promise<UndefinedOr<ApproveIfNeededResult>>;
+declare const approveIfNeeded: ApproveIfNeeded;
+
+type PositionsCreate = (options: {
+    readonly provider: ContractRunner;
+    readonly from: string;
+    readonly destination: string;
+    readonly amount: string;
+    readonly payload?: string | Uint8Array;
+    readonly overrides?: FallbackableOverrides;
+}) => Promise<UndefinedOr<ApproveIfNeededResult>>;
+declare const positionsCreate: PositionsCreate;
+
+type PositionsCreateWithEth = (options: {
+    readonly provider: ContractRunner;
+    readonly ethAmount?: string;
+    readonly devAmount?: string;
+    readonly destination: string;
+    readonly deadline?: number;
+    readonly gatewayAddress?: string;
+    readonly gatewayBasisPoints?: number;
+    readonly payload?: string | Uint8Array;
+    readonly overrides?: FallbackableOverrides;
+}) => Promise<{
+    readonly estimatedDev: string;
+    readonly estimatedEth: string;
+    readonly create: () => Promise<TransactionResponse>;
+}>;
+declare const positionsCreateWithEth: PositionsCreateWithEth;
+
+type PositionsCreateWithEthForPolygon = (options: {
+    readonly provider: ContractRunner;
+    readonly ethAmount?: string;
+    readonly devAmount?: string;
+    readonly destination: string;
+    readonly from?: string;
+    readonly overrides?: FallbackableOverrides;
+    readonly payload?: string | Uint8Array;
+    readonly deadline?: number;
+    readonly gatewayAddress?: string;
+    readonly gatewayBasisPoints?: number;
+}) => Promise<{
+    readonly estimatedDev: string;
+    readonly estimatedEth: string;
+    readonly create: () => Promise<UndefinedOr<ApproveIfNeededResult>>;
+}>;
+declare const positionsCreateWithEthForPolygon: PositionsCreateWithEthForPolygon;
+
+type Params = {
+    readonly provider: ContractRunner;
+    readonly mintTo: string;
+    readonly destination: string;
+    readonly path: readonly (string | bigint)[];
+    readonly token?: string;
+    readonly tokenAmount?: string;
+    readonly devAmount?: string;
+    readonly devAmountOut?: string;
+    readonly from?: string;
+    readonly overrides?: FallbackableOverrides;
+    readonly payload?: string | Uint8Array;
+    readonly deadline?: number;
+    readonly gatewayAddress?: string;
+    readonly gatewayBasisPoints?: number;
+};
+type ParamsWithToken = Omit<Params, 'token'> & {
+    readonly token: string;
+};
+type ReturnOfPositionsCreateWithAnyTokensERC20 = Promise<UndefinedOr<{
+    readonly estimatedDev: string;
+    readonly estimatedTokens: string;
+    readonly create: () => Promise<ApproveIfNeededResult>;
+}>>;
+type ReturnOfPositionsCreateWithAnyTokensNative = Promise<UndefinedOr<{
+    readonly estimatedDev: string;
+    readonly estimatedTokens: string;
+    readonly create: () => Promise<ApproveIfNeededResultForApproveIsNotNeeded>;
+}>>;
+declare function positionsCreateWithAnyTokens(opts: ParamsWithToken): ReturnOfPositionsCreateWithAnyTokensERC20;
+declare function positionsCreateWithAnyTokens(opts: Params): ReturnOfPositionsCreateWithAnyTokensNative;
+
+type EstimationsAPY = (options: {
+    readonly provider: ContractRunner;
+}) => Promise<readonly [UndefinedOr<number>, UndefinedOr<number>]>;
+declare const estimationsAPY: EstimationsAPY;
+
+type Asset = {
+    readonly market: string;
+    readonly marketSlug?: string;
+    readonly id: string;
+};
+type PropertiesAssets = (options: {
+    readonly provider: ContractRunner;
+    readonly destination: string;
+}) => Promise<UndefinedOr<readonly Asset[]>>;
+declare const propertiesAssets: PropertiesAssets;
+
+type DevContract = Erc20Contract;
+
+type Results$a = readonly [UndefinedOr<DevContract$1>, UndefinedOr<DevContract>];
+declare const clientsDev: (provider: ContractRunner) => Promise<Results$a>;
+
+type LockedupProperty = Readonly<{
+    readonly property: string;
+    readonly value: string;
+}>;
+
+type LockupContract = {
+    readonly withdrawByPosition: (positionTokenId: string, amount: string, overrides?: FallbackableOverrides) => Promise<TransactionResponse>;
+    readonly calculateWithdrawableInterestAmountByPosition: (positionTokenId: string) => Promise<string>;
+    readonly calculateCumulativeHoldersRewardAmount: (propertyAddress: string) => Promise<string>;
+    readonly calculateCumulativeRewardPrices: () => Promise<readonly [string, string, string, string]>;
+    readonly calculateRewardAmount: (propertyAddress: string) => Promise<readonly [string, string]>;
+    readonly cap: () => Promise<string>;
+    readonly depositToProperty: (propertyAddress: string, amount: string, payload?: string | Uint8Array, overrides?: FallbackableOverrides) => Promise<TransactionResponse>;
+    readonly depositToPosition: (positionTokenId: string, amount: string, overrides?: FallbackableOverrides) => Promise<TransactionResponse>;
+    readonly totalLocked: () => Promise<string>;
+    readonly totalLockedForProperty: (address: string) => Promise<string>;
+    readonly getLockedupProperties: () => Promise<readonly LockedupProperty[]>;
+    readonly contract: () => ethers.Contract;
+};
+
+type Results$9 = readonly [
+    UndefinedOr<LockupContract$1>,
+    UndefinedOr<LockupContract>
+];
+declare const clientsLockup: (provider: ContractRunner) => Promise<Results$9>;
+
+type MarketFactoryContract = {
+    readonly create: (marketBehaviorAddress: string) => Promise<TransactionResponse>;
+    readonly getEnabledMarkets: () => Promise<readonly string[]>;
+    readonly contract: () => ethers.Contract;
+};
+
+type Results$8 = readonly [
+    UndefinedOr<MarketFactoryContract$1>,
+    UndefinedOr<MarketFactoryContract>
+];
+declare const clientsMarketFactory: (provider: ContractRunner) => Promise<Results$8>;
+
+type MetricsFactoryContract = {
+    readonly authenticatedPropertiesCount: () => Promise<string>;
+    readonly metricsCount: () => Promise<number>;
+    readonly metricsOfProperty: (propertyAddress: string) => Promise<readonly string[]>;
+    readonly contract: () => ethers.Contract;
+};
+
+type Results$7 = readonly [undefined, UndefinedOr<MetricsFactoryContract>];
+declare const clientsMetricsFactory: (provider: ContractRunner) => Promise<Results$7>;
+
+type PropertyBalance = Readonly<{
+    readonly account: string;
+    readonly balance: string;
+}>;
+
+type PropertyContract = {
+    readonly totalSupply: () => Promise<string>;
+    readonly balanceOf: (address: string) => Promise<string>;
+    readonly transfer: (to: string, value: string, overrides?: FallbackableOverrides) => Promise<TransactionResponse>;
+    readonly allowance: (from: string, to: string) => Promise<string>;
+    readonly approve: (to: string, value: string, overrides?: FallbackableOverrides) => Promise<TransactionResponse>;
+    readonly transferFrom: (from: string, to: string, value: string, overrides?: FallbackableOverrides) => Promise<TransactionResponse>;
+    readonly name: () => Promise<string>;
+    readonly symbol: () => Promise<string>;
+    readonly decimals: () => Promise<string>;
+    readonly author: () => Promise<string>;
+    readonly changeName: (nextName: string, overrides?: FallbackableOverrides) => Promise<TransactionResponse>;
+    readonly changeSymbol: (nextSymbol: string, overrides?: FallbackableOverrides) => Promise<TransactionResponse>;
+    readonly getBalances: () => Promise<readonly PropertyBalance[]>;
+    readonly contract: () => ethers.Contract;
+};
+
+type Results$6 = readonly [
+    UndefinedOr<PropertyContract$1>,
+    UndefinedOr<PropertyContract>
+];
+declare const clientsProperty: (provider: ContractRunner, tokenAddress: string) => Promise<Results$6>;
+
+type PropertyFactoryContract = {
+    readonly create: (name: string, symbol: string, author: string, overrides?: FallbackableOverrides) => Promise<string>;
+    readonly createAndAuthenticate: (name: string, symbol: string, marketAddress: string, args: readonly string[], options: WaitForEventOptions, overrides?: FallbackableOverrides) => Promise<{
+        readonly property: string;
+        readonly transaction: TransactionResponse;
+        readonly waitForAuthentication: () => Promise<string>;
+    }>;
+    readonly getPropertiesOfAuthor: (author: string) => Promise<readonly string[]>;
+    readonly contract: () => ethers.Contract;
+};
+
+type Results$5 = readonly [
+    UndefinedOr<PropertyFactoryContract$1>,
+    UndefinedOr<PropertyFactoryContract>
+];
+declare const clientsPropertyFactory: (provider: ContractRunner) => Promise<Results$5>;
+
+type RegistryContract = {
+    readonly registries: (key: string) => Promise<string>;
+    readonly contract: () => ethers.Contract;
+};
+
+type Results$4 = readonly [
+    UndefinedOr<RegistryContract$1>,
+    UndefinedOr<RegistryContract>
+];
+declare const clientsRegistry: (provider: ContractRunner) => Promise<Results$4>;
+
+type PolicyContract = {
+    readonly holdersShare: (amount: string, lockups: string) => Promise<string>;
+    readonly rewards: (lockups: string, assets: string) => Promise<string>;
+    readonly authenticationFee: (assets: string, propertyAssets: string) => Promise<string>;
+    readonly marketVotingSeconds: () => Promise<string>;
+    readonly policyVotingSeconds: () => Promise<string>;
+    readonly shareOfTreasury: (supply: string) => Promise<string>;
+    readonly contract: () => ethers.Contract;
+};
+
+type Results$3 = readonly [
+    UndefinedOr<PolicyContract$1>,
+    UndefinedOr<PolicyContract>
+];
+declare const clientsPolicy: (provider: ContractRunner) => Promise<Results$3>;
+
+type Results$2 = readonly [
+    UndefinedOr<STokensContract>,
+    UndefinedOr<STokensContract>
+];
+declare const clientsSTokens: (provider: ContractRunner) => Promise<Results$2>;
+
+type SwapContract = {
+    readonly getEstimatedDevForEth: (ethAmount: string) => Promise<string>;
+    readonly getEstimatedEthForDev: (devAmount: string) => Promise<string>;
+    readonly swapEthAndStakeDevCaller: (propertyAddress: string, deadline: number, payload: string | Uint8Array, overrides: FallbackableOverrides, gatewayAddress?: string, gatewayBasisPoints?: string) => Promise<TransactionResponse>;
+    readonly swapEthAndStakeDevPolygonCaller: (propertyAddress: string, amount: string, deadline: number, payload: string | Uint8Array, overrides: FallbackableOverrides, gatewayAddress?: string, gatewayBasisPoints?: string) => Promise<TransactionResponse>;
+    readonly contract: () => ethers.Contract;
+};
+
+type Results$1 = readonly [
+    undefined,
+    UndefinedOr<SwapContract>,
+    UndefinedOr<string>
+];
+declare const clientsUtilsSwapForStake: (provider: ContractRunner) => Promise<Results$1>;
+
+type SwapArbitraryTokensContract = {
+    readonly getEstimatedDevForTokens: (path: readonly (string | bigint)[], tokenAmount: string) => Promise<string>;
+    readonly getEstimatedTokensForDev: (path: readonly (string | bigint)[], devAmount: string) => Promise<string>;
+    readonly swapTokensAndStakeDev: (to: string, path: readonly (string | bigint)[], propertyAddress: string, amountOut: string, deadline: number, amount: string, payload?: string | Uint8Array, token?: string, gatewayAddress?: string, gatewayBasisPoints?: string, overrides?: FallbackableOverrides) => Promise<TransactionResponse>;
+    readonly contract: () => ethers.Contract;
+};
+
+type Results = readonly [undefined, UndefinedOr<SwapArbitraryTokensContract>];
+declare const clientsUtilsSwapTokensForStake: (provider: ContractRunner) => Promise<Results>;
+
+declare const agentAddresses: {
+    readonly eth: {
+        readonly main: {
+            readonly swap: {
+                readonly v2: "0x6400264F991de614048838a7d4B536733BCE3069";
+                readonly v3: undefined;
+            };
+        };
+    };
+    readonly arbitrum: {
+        readonly one: {
+            readonly swap: {
+                readonly v2: undefined;
+                readonly v3: "0x60Ca7E3960e5F143DdB42B19B64F65c27cAD561d";
+            };
+        };
+        readonly rinkeby: {
+            readonly swap: {
+                readonly v2: undefined;
+                readonly v3: "0x4cd6B431B7A242D51B4D96aE5839a8b8f060F7A9";
+            };
+        };
+    };
+    readonly polygon: {
+        readonly mainnet: {
+            readonly swap: {
+                readonly v2: undefined;
+                readonly v3: "0x9265Cf9e6Dc5B163bDB75d51661Ca8EA3b6150c4";
+            };
+            readonly swapArbitraryTokens: {
+                readonly swap: "0xad7CaC908DfF8Dcd1D0d8d0FE3edD25bf339EB57";
+            };
+            readonly usdc: "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174";
+            readonly weth: "0x7ceB23fD6bC0adD59E62ac25578270cFf1b9f619";
+        };
+        readonly mumbai: {
+            readonly swap: {
+                readonly v2: undefined;
+                readonly v3: "0x60650E5a95864b989C8b7B0357a2d4979a34c6AF";
+            };
+            readonly swapArbitraryTokens: {
+                readonly swap: "0x927B51D9Edd43BFDE3586E99BfaCBE08135374AA";
+            };
+            readonly usdc: "0xFEca406dA9727A25E71e732F9961F680059eF1F9";
+            readonly weth: "0x3c8d6A6420C922c88577352983aFFdf7b0F977cA";
+        };
+    };
+};
+
+export { type ApproveIfNeeded, type ApproveIfNeededResult, type ApproveIfNeededResultForApproveIsNeeded, type ApproveIfNeededResultForApproveIsNotNeeded, type ContractFactory, type CreateAllocatorContract, type CreateDevkitContract, type CreateMarketBehaviorContract, type CreateMarketContract, type CreateMetricsContract, type CreateMetricsGroupContract, type CreatePolicyFactoryContract, type CreatePolicyGroupContract, type CreatePropertyContract, type CreateRegistryContract, type CustomOptions, type DevContract$1 as DevContract, type DevkitClient, type DevkitContract, type DevkitUtils, type Erc20Contract, type Image, type LockupContract$1 as LockupContract, type MarketFactoryContract$1 as MarketFactoryContract, type PolicyContract$1 as PolicyContract, type PolicyFactoryContract, type PolicyGroupContract, type Positions, type PropertyContract$1 as PropertyContract, type PropertyFactoryContract$1 as PropertyFactoryContract, type RegistryContract$1 as RegistryContract, type ReturnOfPositionsCreateWithAnyTokensERC20, type ReturnOfPositionsCreateWithAnyTokensNative, type STokensContract, type ValidProvider, type WithdrawContract, addressConfigAbi, addresses, agentAddresses, allocatorAbi, approveIfNeeded, arrayify, client, clientsDev, clientsLockup, clientsMarketFactory, clientsMetricsFactory, clientsPolicy, clientsProperty, clientsPropertyFactory, clientsRegistry, clientsSTokens, clientsUtilsSwapForStake, clientsUtilsSwapTokensForStake as clientsUtilsSwapUsdcForStake, contractFactory, createAllocatorContract, createDetectSTokens, createDevContract, createDevkitContract, createErc20Contract, createLockupContract, createMarketBehaviorContract, createMarketContract, createMarketFactoryContract, createMetricsContract, createMetricsGroupContract, createPolicyContract, createPolicyFactoryContract, createPolicyGroupContract, createPropertyContract, createPropertyFactoryContract, createRegistryContract, createSTokensContract, createSimpleCollectionsContract, createWithdrawContract, devAbi, erc20Abi, estimationsAPY, execute, lockupAbi, marketAbi, marketAddresses, marketBehaviorAbi, marketFactoryAbi, metricsAbi, metricsFactoryAbi, metricsGroupAbi, policyAbi, policyFactoryAbi, policyGroupAbi, positionsCreate, positionsCreateWithAnyTokens, positionsCreateWithEth, positionsCreateWithEthForPolygon, propertiesAssets, propertyAbi, propertyFactoryAbi, sTokensAbi, simpleCollectionsAbi, utils, withdrawAbi };

lib/index.ts

@@ -46,1 +46,3 @@ export * from './addresses'
 export * from './ethereum/withdraw/abi'
+
+export * from './agent'

package.json

 {
 	"name": "@devprotocol/dev-kit",
 	"type": "module",
-	"version": "8.6.0-alpha.0",
+	"version": "8.6.0",
 	"description": "Dev Kit for JavaScript",
@@ -6,0 +6,0 @@ "author": "abyssparanoia",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1710131

increased by14.18%

Lines of code

68425

increased by12.22%

Number of low quality alerts

0

decreased by-100%

No dependency changes