@1inch/limit-order-protocol-contract NPM

1inch Limit Order Protocol Smart Contract

Version warning

The master branch contains the latest work-in-progress version of limit orders. It hasn't been audited and may contain severe security issues or may not work at all.

Please, use the commit tagged version to get the latest production version that has passed through a series of security audits:

tag 4.0.0 Limit order protocol v4 / security audits
tag 3.0.1 Limit order protocol v3 / security audits
tag v2 - Limit order protocol v2 / security audits

About

You can find the latest general overview and documentation on the 1inch limit orders protocol in the description.md. Documentation for this and previous versions can be found on the 1inch documentation portal.

The repository contains smart contracts for EVM-based blockchains (such as Ethereum, Binance Smart Chain, etc.). These contracts are a core part of the 1inch limit order protocol, allowing users to create limit orders off-chain that can be filled on-chain. A limit order is a data structure signed according to EIP-712.

Limit Order

The key features of the protocol are extreme flexibility and high gas efficiency, which are achieved with the following features

Basic features

Select an asset receiver for an order.
Choose whether to allow or disallow partial and multiple fills.
Define conditions that must be met before execution can proceed (e.g. stop-loss, take-profit orders).
Specify interactions (arbitrary maker's code) to execute before and after order filling.
Choose an approval scheme for token spend (approve, permit, permit2).
Request that WETH be unwrapped to ETH either before (to sell ETH) or after the swap (to receive ETH).
Make an order private by specifying the only allowed taker's address.
Set the order's expiration date.
Assign a nonce or epoch to the order for easy cancellation later.

Advanced features

Define a proxy to handle transfers of assets that are not compliant with IERC20, allowing the swapping of non-ERC20 tokens, such as ERC721 or ERC1155.
Define functions to calculate, on-chain, the exchange rate for maker and taker assets. These functions can be used to implement dutch auctions (where the rate decreases over time) or range orders (where the rate depends on the volume already filled), among others.