Skip to content

Commit 5357ad0

Browse files
authored
docs:(aqua) cleanup (#16)
1 parent fe9d632 commit 5357ad0

File tree

6 files changed

+13
-14
lines changed

6 files changed

+13
-14
lines changed

typescript/aqua/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Aqua Protocol is a decentralized protocol for liquidity management. This SDK
88

99
- **Encoding/Decoding**: Build typed call data for `ship`, `dock` operations
1010
- **Event Parsing**: Decode and parse `Pushed`, `Pulled`, `Shipped`, and `Docked` events
11-
- **Multi-Chain Support**: Pre-configured addresses for 13+ blockchain networks
11+
- **Multi-Chain Support**: Pre-configured addresses for 10+ blockchain networks
1212

1313
For detailed protocol documentation, see the [Aqua Protocol Documentation](https://github.com/1inch/aqua#table-of-contents).
1414

@@ -103,13 +103,12 @@ const dockTx = aqua.dock({
103103

104104
### Pushed Event
105105

106-
Emitted when funds are pushed to a strategy.
106+
Emitted when funds are pushed to a strategy/wallet.
107107

108108
```typescript
109109
import { PushedEvent } from '@1inch/aqua-sdk'
110-
import { Log } from 'viem'
111110

112-
const log: Log = { /* ... */ }
111+
const log = { data: '0x...', topics: ['0x...'] }
113112
const event = PushedEvent.fromLog(log)
114113

115114
console.log(event.maker) // Address
@@ -121,7 +120,7 @@ console.log(event.amount) // bigint
121120

122121
### Pulled Event
123122

124-
Emitted when funds are pulled from a strategy.
123+
Emitted when funds are pulled from a strategy/wallet.
125124

126125
```typescript
127126
import { PulledEvent } from '@1inch/aqua-sdk'

typescript/aqua/src/aqua-protocol-contract/events/docked-event.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// SPDX-License-Identifier: LicenseRef-Degensoft-Aqua-Source-1.1
22

3-
import type { Log } from 'viem'
43
import { decodeEventLog } from 'viem'
54
import { Address, HexString } from '@1inch/sdk-core'
5+
import type { LogLike } from '@1inch/sdk-core'
66
import { AQUA_ABI } from '../../abi/Aqua.abi'
77

88
export class DockedEvent {
@@ -20,7 +20,7 @@ export class DockedEvent {
2020
* Creates a DockedEvent from
2121
* @throws Error if the log data is invalid or doesn't match the expected event structure
2222
*/
23-
static fromLog(log: Log): DockedEvent {
23+
static fromLog(log: LogLike): DockedEvent {
2424
const decoded = decodeEventLog({
2525
abi: AQUA_ABI,
2626
data: log.data,

typescript/aqua/src/aqua-protocol-contract/events/pulled-event.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// SPDX-License-Identifier: LicenseRef-Degensoft-Aqua-Source-1.1
22

3-
import type { Log } from 'viem'
43
import { decodeEventLog } from 'viem'
54
import { Address, HexString } from '@1inch/sdk-core'
5+
import type { LogLike } from '@1inch/sdk-core'
66
import { AQUA_ABI } from '../../abi/Aqua.abi'
77

88
export class PulledEvent {
@@ -22,7 +22,7 @@ export class PulledEvent {
2222
* Creates a PulledEvent
2323
* @throws Error if the log data is invalid or doesn't match the expected event structure
2424
*/
25-
static fromLog(log: Log): PulledEvent {
25+
static fromLog(log: LogLike): PulledEvent {
2626
const decoded = decodeEventLog({
2727
abi: AQUA_ABI,
2828
data: log.data,

typescript/aqua/src/aqua-protocol-contract/events/pushed-event.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// SPDX-License-Identifier: LicenseRef-Degensoft-Aqua-Source-1.1
22

3-
import type { Log } from 'viem'
3+
import type { LogLike } from '@1inch/sdk-core'
44
import { decodeEventLog } from 'viem'
55
import { Address, HexString } from '@1inch/sdk-core'
66
import { AQUA_ABI } from '../../abi/Aqua.abi'
@@ -22,7 +22,7 @@ export class PushedEvent {
2222
* Creates a PushedEvent
2323
* @throws Error if the log data is invalid or doesn't match the expected event structure
2424
*/
25-
static fromLog(log: Log): PushedEvent {
25+
static fromLog(log: LogLike): PushedEvent {
2626
const decoded = decodeEventLog({
2727
abi: AQUA_ABI,
2828
data: log.data,

typescript/aqua/src/aqua-protocol-contract/events/shipped-event.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// SPDX-License-Identifier: LicenseRef-Degensoft-Aqua-Source-1.1
22

3-
import type { Log } from 'viem'
3+
import type { LogLike } from '@1inch/sdk-core'
44
import { decodeEventLog } from 'viem'
55
import { Address, HexString } from '@1inch/sdk-core'
66
import { AQUA_ABI } from '../../abi/Aqua.abi'
@@ -21,7 +21,7 @@ export class ShippedEvent {
2121
* Creates a ShippedEvent
2222
* @throws Error if the log data is invalid or doesn't match the expected event structure
2323
*/
24-
static fromLog(log: Log): ShippedEvent {
24+
static fromLog(log: LogLike): ShippedEvent {
2525
const decoded = decodeEventLog({
2626
abi: AQUA_ABI,
2727
data: log.data,

typescript/swap-vm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ Available instruction categories in the full Swap VM instruction set include:
236236
### Trading instructions
237237
- `XYC_SWAP_XD` - XYC swap for multi-dimensional pools
238238
- `CONCENTRATE_GROW_LIQUIDITY_XD` - Concentrate liquidity in multi-dimensional pools
239-
- `CONCENTRATE_GROW_LIQUIDITY_2D` - Concentrate liquidity in 2D pools
239+
- `CONCENTRATE_GROW_LIQUIDITY_2D` - Concentrate liquidity in 2 tokens pools
240240
- `DECAY_XD` - Apply decay calculation
241241
- `LIMIT_SWAP_1D` - Execute limit order swap
242242
- `LIMIT_SWAP_ONLY_FULL_1D` - Execute limit order only if fully fillable

0 commit comments

Comments
 (0)