feat(limit-order-contract): add methods without args (#12)

README.md

@@ -8,6 +8,7 @@ npm install '@1inch/limit-order-sdk'
 
 ## Docs
 - [Limit Order](./src/limit-order/README.md)
+- [Limit Order Contract](./src/limit-order-contract/README.md)
 
 ## Usage examples
 

package.json

@@ -23,7 +23,7 @@
   },
   "scripts": {
     "build": "tsc",
-    "docs:generate": "tsdoc --src=src/limit-order/* --dest=src/limit-order/README.md",
+    "docs:generate": "tsdoc --src=src/limit-order/* --dest=src/limit-order/README.md && tsdoc --src=src/limit-order-contract/* --dest=src/limit-order-contract/README.md",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
     "lint:ci": "eslint \"{src,apps,libs,test}/**/*.ts\"",
     "lint": "eslint  \"{src,apps,libs,test}/**/*.ts\" --ignore-path .eslintignore --fix",

src/limit-order-contract/README.md

@@ -0,0 +1,41 @@
+## :factory: LimitOrderContract
+
+### Methods
+
+- [getFillOrderCalldata](#gear-getfillordercalldata)
+- [getFillContractOrderCalldata](#gear-getfillcontractordercalldata)
+- [getFillOrderArgsCalldata](#gear-getfillorderargscalldata)
+- [getFillContractOrderArgsCalldata](#gear-getfillcontractorderargscalldata)
+
+#### :gear: getFillOrderCalldata
+
+Fill order WITHOUT an extension and taker interaction
+
+| Method | Type |
+| ---------- | ---------- |
+| `getFillOrderCalldata` | `(order: LimitOrderV4Struct, signature: string, takerTraits: TakerTraits, amount: bigint) => string` |
+
+#### :gear: getFillContractOrderCalldata
+
+Fill contract order (order maker is smart-contract) WITHOUT an extension and taker interaction
+
+| Method | Type |
+| ---------- | ---------- |
+| `getFillContractOrderCalldata` | `(order: LimitOrderV4Struct, signature: string, takerTraits: TakerTraits, amount: bigint) => string` |
+
+#### :gear: getFillOrderArgsCalldata
+
+Fill order WITH an extension or taker interaction
+
+| Method | Type |
+| ---------- | ---------- |
+| `getFillOrderArgsCalldata` | `(order: LimitOrderV4Struct, signature: string, takerTraits: TakerTraits, amount: bigint) => string` |
+
+#### :gear: getFillContractOrderArgsCalldata
+
+Fill contract order (order maker is smart-contract) WITH an extension or taker interaction
+
+| Method | Type |
+| ---------- | ---------- |
+| `getFillContractOrderArgsCalldata` | `(order: LimitOrderV4Struct, signature: string, takerTraits: TakerTraits, amount: bigint) => string` |
+

src/limit-order-contract/limit-order-contract.ts

@@ -1,10 +1,78 @@
 import {Interface, Signature} from 'ethers'
+import assert from 'assert'
 import {LimitOrderV4Struct, TakerTraits} from '../limit-order'
 import LOP_V4_ABI from '../abi/AggregationRouterV6.abi.json'
+import {ZX} from '../constants'
 
 const lopContract = new Interface(LOP_V4_ABI)
 
+/**
+ * @see https://github.com/1inch/limit-order-protocol/blob/3169ea46932ef44114a215a60d1d91ef022b416d/contracts/OrderMixin.sol#L27
+ */
 export class LimitOrderContract {
+    /**
+     *  Fill order WITHOUT an extension and taker interaction
+     *
+     *  @see getFillOrderArgsCalldata
+     *  @see getFillContractOrderCalldata
+     */
+    static getFillOrderCalldata(
+        order: LimitOrderV4Struct,
+        signature: string,
+        takerTraits: TakerTraits,
+        amount: bigint
+    ): string {
+        const {r, yParityAndS: vs} = Signature.from(signature)
+        const {args, trait} = takerTraits.encode()
+
+        assert(
+            args === ZX,
+            'takerTraits contains args data, use LimitOrderContract.getFillOrderArgsCalldata method'
+        )
+
+        return lopContract.encodeFunctionData('fillOrder', [
+            order,
+            r,
+            vs,
+            amount,
+            trait
+        ])
+    }
+
+    /**
+     *  Fill contract order (order maker is smart-contract) WITHOUT an extension and taker interaction
+     *
+     *  @see getFillContractOrderArgsCalldata
+     *  @see getFillOrderCalldata
+     */
+    static getFillContractOrderCalldata(
+        order: LimitOrderV4Struct,
+        signature: string,
+        takerTraits: TakerTraits,
+        amount: bigint
+    ): string {
+        const {args, trait} = takerTraits.encode()
+
+        assert(
+            args === ZX,
+            'takerTraits contains args data, use LimitOrderContract.getFillContractOrderArgsCalldata method'
+        )
+
+        return lopContract.encodeFunctionData('fillContractOrder', [
+            order,
+            signature,
+            amount,
+            trait,
+            args
+        ])
+    }
+
+    /**
+     *  Fill order WITH an extension or taker interaction
+     *
+     *  @see getFillOrderCalldata
+     *  @see getFillContractOrderArgsCalldata
+     */
     static getFillOrderArgsCalldata(
         order: LimitOrderV4Struct,
         signature: string,
@@ -24,6 +92,12 @@ export class LimitOrderContract {
         ])
     }
 
+    /**
+     *  Fill contract order (order maker is smart-contract) WITH an extension or taker interaction
+     *
+     *  @see getFillOrderArgsCalldata
+     *  @see getFillContractOrderCalldata
+     */
     static getFillContractOrderArgsCalldata(
         order: LimitOrderV4Struct,
         signature: string,

src/limit-order/README.md

@@ -24,11 +24,18 @@ Calculates maker amount by linear proportion
 
 ### Methods
 
+- [decode](#gear-decode)
 - [default](#gear-default)
 - [keccak256](#gear-keccak256)
 - [isEmpty](#gear-isempty)
 - [encode](#gear-encode)
 
+#### :gear: decode
+
+| Method | Type |
+| ---------- | ---------- |
+| `decode` | `(bytes: string) => Extension` |
+
 #### :gear: default
 
 | Method | Type |

src/limit-order/taker-traits.ts

@@ -2,6 +2,7 @@ import {BitMask, BN, getBytesCount, trim0x} from '@1inch/byte-utils'
 import {Extension} from './extension'
 import {Interaction} from './interaction'
 import {Address} from '../address'
+import {ZX} from '../constants'
 
 export enum AmountMode {
     /**
@@ -251,7 +252,7 @@ export class TakerTraits {
             .setMask(TakerTraits.ARGS_INTERACTION_LENGTH_MASK, interactionLen)
 
         const args =
-            (this.receiver?.toString() || '0x') +
+            (this.receiver?.toString() || ZX) +
             trim0x(this.extension?.encode() || '') +
             trim0x(this.interaction?.encode() || '')