@cowprotocol/cow-sdk 5.7.0 → 5.7.1-next

package/dist/composable/orderTypes/Twap.d.ts

@@ -1,242 +0,0 @@
-import { BigNumber } from 'ethers';
-import { ConditionalOrder } from '../ConditionalOrder';
-import { ConditionalOrderArguments, ConditionalOrderParams, ContextFactory, OwnerContext, IsValidResult, PollParams, PollResultErrors } from '../types';
-import { GPv2Order } from '../../common/generated/ComposableCoW';
-export declare const TWAP_ADDRESS = "0x6cF1e9cA41f7611dEf408122793c358a3d11E5a5";
-/**
- * The address of the `CurrentBlockTimestampFactory` contract
- *
- * **NOTE**: This is used in the event that TWAP's have a `t0` of `0`.
- */
-export declare const CURRENT_BLOCK_TIMESTAMP_FACTORY_ADDRESS = "0x52eD56Da04309Aca4c3FECC595298d80C2f16BAc";
-export declare const MAX_UINT32: BigNumber;
-export declare const MAX_FREQUENCY: BigNumber;
-/**
- * Base parameters for a TWAP order. Shared by:
- *   - TwapStruct (modelling the contract's struct used for `staticInput`).
- *   - TwapData (modelling the friendly SDK interface).
- */
-export type TwapDataBase = {
-    /**
-     * which token to sell
-     */
-    readonly sellToken: string;
-    /**
-     * which token to buy
-     */
-    readonly buyToken: string;
-    /**
-     * who to send the tokens to
-     */
-    readonly receiver: string;
-    /**
-     * Meta-data associated with the order. Normally would be the keccak256 hash of the document generated in http://github.com/cowprotocol/app-data
-     *
-     * This hash should have been uploaded to the API https://api.cow.fi/docs/#/default/put_api_v1_app_data__app_data_hash_ and potentially to other data availability protocols like IPFS.
-     *
-     */
-    readonly appData: string;
-};
-/**
- * Parameters for a TWAP order, as expected by the contract's `staticInput`.
- */
-export interface TwapStruct extends TwapDataBase {
-    /**
-     * amount of sellToken to sell in each part
-     */
-    readonly partSellAmount: BigNumber;
-    /**
-     * minimum amount of buyToken that must be bought in each part
-     */
-    readonly minPartLimit: BigNumber;
-    /**
-     * start time of the TWAP
-     */
-    readonly t0: BigNumber;
-    /**
-     * number of parts
-     */
-    readonly n: BigNumber;
-    /**
-     * duration of the TWAP interval
-     */
-    readonly t: BigNumber;
-    /**
-     * whether the TWAP is valid for the entire interval or not
-     */
-    readonly span: BigNumber;
-}
-/**
- * Parameters for a TWAP order, made a little more user-friendly for SDK users.
- *
- * @see {@link TwapStruct} for the native struct.
- */
-export interface TwapData extends TwapDataBase {
-    /**
-     * total amount of sellToken to sell across the entire TWAP
-     */
-    readonly sellAmount: BigNumber;
-    /**
-     * minimum amount of buyToken that must be bought across the entire TWAP
-     */
-    readonly buyAmount: BigNumber;
-    /**
-     * start time of the TWAP
-     */
-    readonly startTime?: StartTime;
-    /**
-     * number of parts
-     */
-    readonly numberOfParts: BigNumber;
-    /**
-     * duration of the TWAP interval
-     */
-    readonly timeBetweenParts: BigNumber;
-    /**
-     * whether the TWAP is valid for the entire interval or not
-     */
-    readonly durationOfPart?: DurationOfPart;
-}
-export type DurationOfPart = {
-    durationType: DurationType.AUTO;
-} | {
-    durationType: DurationType.LIMIT_DURATION;
-    duration: BigNumber;
-};
-export declare enum DurationType {
-    AUTO = "AUTO",
-    LIMIT_DURATION = "LIMIT_DURATION"
-}
-export type StartTime = {
-    startType: StartTimeValue.AT_MINING_TIME;
-} | {
-    startType: StartTimeValue.AT_EPOCH;
-    epoch: BigNumber;
-};
-export declare enum StartTimeValue {
-    AT_MINING_TIME = "AT_MINING_TIME",
-    AT_EPOCH = "AT_EPOCH"
-}
-/**
- * `ComposableCoW` implementation of a TWAP order.
- * @author mfw78 <mfw78@rndlabs.xyz>
- */
-export declare class Twap extends ConditionalOrder<TwapData, TwapStruct> {
-    isSingleOrder: boolean;
-    /**
-     * @see {@link ConditionalOrder.constructor}
-     * @throws If the TWAP order is invalid.
-     * @throws If the TWAP order is not ABI-encodable.
-     * @throws If the handler is not the TWAP address.
-     */
-    constructor(params: ConditionalOrderArguments<TwapData>);
-    /**
-     * Create a TWAP order with sound defaults.
-     * @param data The TWAP order parameters in a more user-friendly format.
-     * @returns An instance of the TWAP order.
-     */
-    static fromData(data: TwapData, salt?: string): Twap;
-    /**
-     * Create a TWAP order with sound defaults.
-     * @param data The TWAP order parameters in a more user-friendly format.
-     * @returns An instance of the TWAP order.
-     */
-    static fromParams(params: ConditionalOrderParams): Twap;
-    /**
-     * Enforces that TWAPs will commence at the beginning of a block by use of the
-     * `CurrentBlockTimestampFactory` contract to provide the current block timestamp
-     * as the start time of the TWAP.
-     */
-    get context(): ContextFactory | undefined;
-    /**
-     * @inheritdoc {@link ConditionalOrder.orderType}
-     */
-    get orderType(): string;
-    /**
-     * Validate the TWAP order.
-     * @param data The TWAP order to validate.
-     * @returns Whether the TWAP order is valid.
-     * @throws If the TWAP order is invalid.
-     * @see {@link TwapStruct} for the native struct.
-     */
-    isValid(): IsValidResult;
-    protected startTimestamp(params: OwnerContext): Promise<number>;
-    /**
-     * Given the start timestamp of the TWAP, calculate the end timestamp.
-     * @dev As usually the `endTimestamp` is used when determining a TWAP's validity, we don't
-     *      do any lookup to the blockchain to determine the start timestamp, as this has likely
-     *      already been done during the verification flow.
-     * @dev Beware to handle the case of `span != 0` ie. `durationOfPart.durationType !== DurationType.AUTO`.
-     * @param startTimestamp The start timestamp of the TWAP.
-     * @returns The timestamp at which the TWAP will end.
-     */
-    protected endTimestamp(startTimestamp: number): number;
-    /**
-     * Checks if the owner authorized the conditional order.
-     *
-     * @param owner The owner of the conditional order.
-     * @param chain Which chain to use for the ComposableCoW contract.
-     * @param provider An RPC provider for the chain.
-     * @returns true if the owner authorized the order, false otherwise.
-     */
-    protected pollValidate(params: PollParams): Promise<PollResultErrors | undefined>;
-    /**
-     * Handles the error when the order is already present in the orderbook.
-     *
-     * Given the current part is in the book, it will signal to Watch Tower what to do:
-     *   - Wait until the next part starts
-     *   - Don't try again if current part is the last one
-     *
-     * NOTE: The error messages will refer to the parts 1-indexed, so first part is 1, second part is 2, etc.
-     */
-    protected handlePollFailedAlreadyPresent(_orderUid: string, _order: GPv2Order.DataStruct, params: PollParams): Promise<PollResultErrors | undefined>;
-    /**
-     * Serialize the TWAP order into it's ABI-encoded form.
-     * @returns {string} The ABI-encoded TWAP order.
-     */
-    serialize(): string;
-    /**
-     * Get the encoded static input for the TWAP order.
-     * @returns {string} The ABI-encoded TWAP order.
-     */
-    encodeStaticInput(): string;
-    /**
-     * Deserialize a TWAP order from it's ABI-encoded form.
-     * @param {string} twapSerialized ABI-encoded TWAP order to deserialize.
-     * @returns A deserialized TWAP order.
-     */
-    static deserialize(twapSerialized: string): Twap;
-    /**
-     * Create a human-readable string representation of the TWAP order.
-     * @returns {string} A human-readable string representation of the TWAP order.
-     */
-    toString(): string;
-    /**
-     * Transform parameters into a native struct.
-     *
-     * @param {TwapData} data As passed by the consumer of the API.
-     * @returns {TwapStruct} A formatted struct as expected by the smart contract.
-     */
-    transformDataToStruct(data: TwapData): TwapStruct;
-    /**
-     * Transform parameters into a TWAP order struct.
-     *
-     * @param {TwapData} params As passed by the consumer of the API.
-     * @returns {TwapStruct} A formatted struct as expected by the smart contract.
-     */
-    transformStructToData(struct: TwapStruct): TwapData;
-}
-/**
- * Transform parameters into a native struct.
- *
- * @param {TwapData} data As passed by the consumer of the API.
- * @returns {TwapStruct} A formatted struct as expected by the smart contract.
- */
-export declare function transformDataToStruct(data: TwapData): TwapStruct;
-/**
- * Transform parameters into a TWAP order struct.
- *
- * @param {TwapData} params As passed by the consumer of the API.
- * @returns {TwapStruct} A formatted struct as expected by the smart contract.
- */
-export declare function transformStructToData(struct: TwapStruct): TwapData;

package/dist/composable/orderTypes/index.d.ts

@@ -1,3 +0,0 @@
-import { ConditionalOrderRegistry } from '../ConditionalOrderFactory';
-export * from './Twap';
-export declare const DEFAULT_CONDITIONAL_ORDER_REGISTRY: ConditionalOrderRegistry;

package/dist/composable/orderTypes/test/TestConditionalOrder.d.ts

@@ -1,25 +0,0 @@
-import { GPv2Order } from '../../../common/generated/ComposableCoW';
-import { ConditionalOrder } from '../../ConditionalOrder';
-import { IsValidResult, PollParams, PollResultErrors } from '../../types';
-export declare const DEFAULT_ORDER_PARAMS: TestConditionalOrderParams;
-export type TestConditionalOrderParams = {
-    handler: string;
-    salt?: string;
-    data: string;
-    isSingleOrder: boolean;
-};
-export declare class TestConditionalOrder extends ConditionalOrder<string, string> {
-    isSingleOrder: boolean;
-    constructor(params: TestConditionalOrderParams);
-    get orderType(): string;
-    encodeStaticInput(): string;
-    testEncodeStaticInput(): string;
-    transformStructToData(params: string): string;
-    transformDataToStruct(params: string): string;
-    protected pollValidate(_params: PollParams): Promise<PollResultErrors | undefined>;
-    protected handlePollFailedAlreadyPresent(_orderUid: string, _order: GPv2Order.DataStruct, _params: PollParams): Promise<PollResultErrors | undefined>;
-    isValid(): IsValidResult;
-    serialize(): string;
-    toString(): string;
-}
-export declare const createTestConditionalOrder: (params?: Partial<TestConditionalOrderParams>) => TestConditionalOrder;

package/dist/composable/types.d.ts

@@ -1,133 +0,0 @@
-import { OrderBookApi } from '../order-book';
-import { SupportedChainId } from '../common';
-import { GPv2Order } from '../common/generated/ComposableCoW';
-import { providers } from 'ethers';
-export interface ConditionalOrderArguments<T> {
-    handler: string;
-    data: T;
-    salt?: string;
-    hasOffChainInput?: boolean;
-}
-export type ConditionalOrderParams = {
-    readonly handler: string;
-    readonly salt: string;
-    readonly staticInput: string;
-};
-export declare enum ProofLocation {
-    PRIVATE = 0,
-    EMITTED = 1,
-    SWARM = 2,
-    WAKU = 3,
-    RESERVED = 4,
-    IPFS = 5
-}
-/**
- * A factory and it's arguments that are called at transaction mining time to generate the context
- * for a conditional order(s).
- *
- * This allows to support the case where conditional orders may want to *commence* validity at the
- * time of transaction mining, like in the case of a `TWAP` executed by a DAO or `Safe` that takes
- * a reasonable amount of time to aggregate signatures or collect votes.
- *
- * @remarks This is used in conjunction with `setRootWithContext` or `createWithContext`.
- */
-export type ContextFactory = {
-    address: string;
-    factoryArgs?: {
-        args: unknown[];
-        argsType: string[];
-    };
-};
-/**
- * A struct for a proof that can be used with `setRoot` and `setRootWithContext` on a
- * ComposableCoW-enabled Safe.
- */
-export type ProofStruct = {
-    location: ProofLocation;
-    data: string | '0x';
-};
-/**
- * Payload for emitting a merkle root to a ComposableCoW-enabled Safe.
- *
- * If setting `ProofLocation.EMITTED`, this type should be used as the `data` in the `Proof` struct.
- */
-export type PayloadLocationEmitted = {
-    proofs: ProofWithParams[];
-};
-/**
- * A proof for a conditional order and it's parameters.
- */
-export type ProofWithParams = {
-    proof: string[];
-    params: ConditionalOrderParams;
-};
-export type OwnerContext = {
-    owner: string;
-    chainId: SupportedChainId;
-    provider: providers.Provider;
-};
-export type PollParams = OwnerContext & {
-    orderBookApi: OrderBookApi;
-    offchainInput?: string;
-    proof?: string[];
-    /**
-     * If present, it can be used for custom conditional order validations. If not present, the orders will need to get the block info themselves
-     */
-    blockInfo?: BlockInfo;
-};
-export type BlockInfo = {
-    blockNumber: number;
-    blockTimestamp: number;
-};
-export type PollResult = PollResultSuccess | PollResultErrors;
-export type PollResultErrors = PollResultTryNextBlock | PollResultTryOnBlock | PollResultTryAtEpoch | PollResultUnexpectedError | PollResultDontTryAgain;
-export declare enum PollResultCode {
-    SUCCESS = "SUCCESS",
-    UNEXPECTED_ERROR = "UNEXPECTED_ERROR",
-    TRY_NEXT_BLOCK = "TRY_NEXT_BLOCK",
-    TRY_ON_BLOCK = "TRY_ON_BLOCK",
-    TRY_AT_EPOCH = "TRY_AT_EPOCH",
-    DONT_TRY_AGAIN = "DONT_TRY_AGAIN"
-}
-export interface PollResultSuccess {
-    readonly result: PollResultCode.SUCCESS;
-    readonly order: GPv2Order.DataStruct;
-    readonly signature: string;
-}
-export interface PollResultUnexpectedError {
-    readonly result: PollResultCode.UNEXPECTED_ERROR;
-    readonly error: unknown;
-    reason?: string;
-}
-export interface PollResultTryNextBlock {
-    readonly result: PollResultCode.TRY_NEXT_BLOCK;
-    reason?: string;
-}
-export interface PollResultTryOnBlock {
-    readonly result: PollResultCode.TRY_ON_BLOCK;
-    readonly blockNumber: number;
-    reason?: string;
-}
-export interface PollResultTryAtEpoch {
-    readonly result: PollResultCode.TRY_AT_EPOCH;
-    /**
-     * The epoch after which it is ok to retry to to poll this order.
-     * The value is expressed as a Unix timestamp (in seconds).
-     *
-     * This epoch will be inclusive, meaning that it is ok to retry at the block mined precisely at this epoch or later.
-     */
-    readonly epoch: number;
-    reason?: string;
-}
-export interface PollResultDontTryAgain {
-    readonly result: PollResultCode.DONT_TRY_AGAIN;
-    reason?: string;
-}
-export type IsValidResult = IsValid | IsNotValid;
-export interface IsValid {
-    isValid: true;
-}
-export interface IsNotValid {
-    isValid: false;
-    reason: string;
-}

package/dist/composable/utils.d.ts

@@ -1,36 +0,0 @@
-import { utils, providers, BigNumber } from 'ethers';
-import { SupportedChainId } from '../common';
-import { BlockInfo, ConditionalOrderParams } from './types';
-import { Order } from '@cowprotocol/contracts';
-import { GPv2Order } from '../common/generated/ComposableCoW';
-export declare const CONDITIONAL_ORDER_PARAMS_ABI: string[];
-export declare const DEFAULT_TOKEN_FORMATTER: (address: string, amount: BigNumber) => string;
-export declare function isExtensibleFallbackHandler(handler: string, chainId: SupportedChainId): boolean;
-export declare function isComposableCow(handler: string, chainId: SupportedChainId): boolean;
-export declare function getDomainVerifier(safe: string, domain: string, chainId: SupportedChainId, provider: providers.Provider): Promise<string>;
-export declare function createSetDomainVerifierTx(domain: string, verifier: string): string;
-/**
- * Encode the `ConditionalOrderParams` for the conditional order.
- *
- * @param params The `ConditionalOrderParams` struct representing the conditional order as taken from a merkle tree.
- * @returns The ABI-encoded conditional order.
- * @see ConditionalOrderParams
- */
-export declare function encodeParams(params: ConditionalOrderParams): string;
-/**
- * Decode the `ConditionalOrderParams` for the conditional order.
- *
- * @param encoded The encoded conditional order.
- * @returns The decoded conditional order.
- */
-export declare function decodeParams(encoded: string): ConditionalOrderParams;
-/**
- * Helper method for validating ABI types.
- * @param types ABI types to validate against.
- * @param values The values to validate.
- * @returns {boolean} Whether the values are valid ABI for the given types.
- */
-export declare function isValidAbi(types: readonly (string | utils.ParamType)[], values: any[]): boolean;
-export declare function getBlockInfo(provider: providers.Provider): Promise<BlockInfo>;
-export declare function formatEpoch(epoch: number): string;
-export declare function fromStructToOrder(order: GPv2Order.DataStruct): Order;

package/dist/cow-shed/CoWShedHooks.d.ts

@@ -1,35 +0,0 @@
-import { SupportedChainId } from 'src/common';
-import { ICoWShedCall, ICoWShedOptions } from './types';
-import type { Signer } from '@ethersproject/abstract-signer';
-import { TypedDataDomain } from 'ethers';
-import { EcdsaSigningScheme } from '@cowprotocol/contracts';
-export declare class CowShedHooks {
-    private chainId;
-    private customOptions?;
-    constructor(chainId: SupportedChainId, customOptions?: ICoWShedOptions | undefined);
-    proxyOf(user: string): string;
-    encodeExecuteHooksForFactory(calls: ICoWShedCall[], nonce: string, deadline: bigint, user: string, signature: string): string;
-    signCalls(calls: ICoWShedCall[], nonce: string, deadline: bigint, signer: Signer, signingScheme: EcdsaSigningScheme): Promise<string>;
-    infoToSign(calls: ICoWShedCall[], nonce: string, deadline: bigint, proxy: string): {
-        domain: TypedDataDomain;
-        types: {
-            ExecuteHooks: {
-                type: string;
-                name: string;
-            }[];
-            Call: {
-                type: string;
-                name: string;
-            }[];
-        };
-        message: {
-            calls: ICoWShedCall[];
-            nonce: string;
-            deadline: bigint;
-        };
-    };
-    getDomain(proxy: string): TypedDataDomain;
-    proxyCreationCode(): string;
-    getFactoryAddress(): string;
-    getImplementationAddress(): string;
-}

package/dist/cow-shed/contracts.d.ts

@@ -1,4 +0,0 @@
-import { CoWShedInterface } from 'src/common/generated/CoWShed';
-import { CoWShedFactoryInterface } from 'src/common/generated/CoWShedFactory';
-export declare function getCoWShedInterface(): CoWShedInterface;
-export declare function getCoWShedFactoryInterface(): CoWShedFactoryInterface;

package/dist/cow-shed/index.d.ts

@@ -1,4 +0,0 @@
-export * from './types';
-export * from './CoWShedHooks';
-export * from './contracts';
-export * from './proxyInitCode';

package/dist/cow-shed/proxyInitCode.d.ts

@@ -1 +0,0 @@
-export declare const COW_SHED_PROXY_INIT_CODE = "0x60a034608e57601f61037138819003918201601f19168301916001600160401b038311848410176093578084926040948552833981010312608e57604b602060458360a9565b920160a9565b6080527f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc556040516102b490816100bd8239608051818181608f01526101720152f35b600080fd5b634e487b7160e01b600052604160045260246000fd5b51906001600160a01b0382168203608e5756fe60806040526004361015610018575b3661019457610194565b6000803560e01c908163025b22bc1461003b575063f851a4400361000e5761010d565b3461010a5760207ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffc36011261010a5773ffffffffffffffffffffffffffffffffffffffff60043581811691828203610106577f0000000000000000000000000000000000000000000000000000000000000000163314600014610101577f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc557fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b8280a280f35b61023d565b8380fd5b80fd5b346101645760007ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffc360112610164576020610146610169565b73ffffffffffffffffffffffffffffffffffffffff60405191168152f35b600080fd5b333003610101577f000000000000000000000000000000000000000000000000000000000000000090565b60ff7f68df44b1011761f481358c0f49a711192727fb02c377d697bcb0ea8ff8393ac0541615806101ef575b1561023d5760046040517ff92ee8a9000000000000000000000000000000000000000000000000000000008152fd5b507f400ada75000000000000000000000000000000000000000000000000000000007fffffffff000000000000000000000000000000000000000000000000000000006000351614156101c0565b7f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc546000808092368280378136915af43d82803e1561027a573d90f35b3d90fdfea2646970667358221220c7c26ff3040b96a28e96d6d27b743972943aeaef81cc821544c5fe1e24f9b17264736f6c63430008190033";

package/dist/cow-shed/types.d.ts

@@ -1,33 +0,0 @@
-export interface ICoWShedOptions {
-    factoryAddress: string;
-    proxyCreationCode?: string;
-    implementationAddress: string;
-}
-export interface ICoWShedCall {
-    target: string;
-    value: bigint;
-    callData: string;
-    allowFailure: boolean;
-    isDelegateCall: boolean;
-}
-export interface ICoWShedOptions {
-    factoryAddress: string;
-    proxyCreationCode?: string;
-    implementationAddress: string;
-}
-export declare const DOMAIN_TYPE: {
-    EIP712Domain: {
-        type: string;
-        name: string;
-    }[];
-};
-export declare const COW_SHED_712_TYPES: {
-    ExecuteHooks: {
-        type: string;
-        name: string;
-    }[];
-    Call: {
-        type: string;
-        name: string;
-    }[];
-};