@mimicprotocol/lib-ts 0.0.1-rc.17 → 0.0.1-rc.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimicprotocol/lib-ts",
-  "version": "0.0.1-rc.17",
+  "version": "0.0.1-rc.18",
   "license": "GPL-3.0",
   "private": false,
   "type": "module",

package/src/context/Context.ts

@@ -1,4 +1,5 @@
 import { Address, ChainId } from '../types'
+import { TriggerType } from '../types/TriggerType'
 
 @json
 export class SerializableSettler {
@@ -19,6 +20,14 @@ export class Settler {
   }
 }
 
+@json
+export class Trigger {
+  constructor(
+    public type: TriggerType,
+    public data: string
+  ) {}
+}
+
 @json
 export class SerializableContext {
   constructor(
@@ -26,7 +35,8 @@ export class SerializableContext {
     public readonly consensusThreshold: u8,
     public user: string,
     public settlers: SerializableSettler[],
-    public configSig: string
+    public configSig: string,
+    public trigger: Trigger
   ) {}
 }
 
@@ -36,7 +46,8 @@ export class Context {
     public readonly consensusThreshold: u8,
     public user: Address,
     public settlers: Settler[],
-    public configSig: string
+    public configSig: string,
+    public trigger: Trigger
   ) {}
 
   static fromSerializable(serializable: SerializableContext): Context {
@@ -45,7 +56,8 @@ export class Context {
       serializable.consensusThreshold,
       Address.fromString(serializable.user),
       serializable.settlers.map<Settler>((s) => Settler.fromSerializable(s)),
-      serializable.configSig
+      serializable.configSig,
+      serializable.trigger
     )
   }
 

package/src/helpers/serialize.ts

@@ -1,3 +1,6 @@
+import { evm } from '../evm'
+import { BigInt, EvmDecodeParam } from '../types'
+
 export interface Stringable {
   toString(): string
 }
@@ -12,3 +15,7 @@ export function serialize<T extends Stringable>(elem: T): string {
   if (elem instanceof Serializable) return elem.serialize()
   return elem.toString()
 }
+
+export function deserializeCronTriggerData(data: string): BigInt {
+  return BigInt.fromString(evm.decode(new EvmDecodeParam('uint256', data)))
+}

package/src/intents/Call.ts

@@ -3,7 +3,7 @@ import { TokenAmount } from '../tokens'
 import { ChainId } from '../types'
 import { Address, BigInt, Bytes } from '../types'
 
-import { Intent, IntentBuilder, MaxFee, OperationType } from './Intent'
+import { Intent, IntentBuilder, IntentEvent, MaxFee, OperationType } from './Intent'
 
 /**
  * Builder for creating Call intents with contract call operations.
@@ -108,12 +108,40 @@ export class CallBuilder extends IntentBuilder {
     return this
   }
 
+  /**
+   * Sets an event for the intent.
+   * @param topic - The topic to be indexed in the event
+   * @param data - The event data
+   * @returns This CallBuilder instance for method chaining
+   */
+  addEvent(topic: Bytes, data: Bytes): CallBuilder {
+    return changetype<CallBuilder>(super.addEvent(topic, data))
+  }
+
+  /**
+   * Sets multiple events for the intent.
+   * @param events - The list of events to be added
+   * @returns This CallBuilder instance for method chaining
+   */
+  addEvents(events: IntentEvent[]): CallBuilder {
+    return changetype<CallBuilder>(super.addEvents(events))
+  }
+
   /**
    * Builds and returns the final Call intent.
    * @returns A new Call instance with all configured parameters
    */
   build(): Call {
-    return new Call(this.chainId, this.calls, this.maxFees, this.settler, this.user, this.deadline, this.nonce)
+    return new Call(
+      this.chainId,
+      this.calls,
+      this.maxFees,
+      this.settler,
+      this.user,
+      this.deadline,
+      this.nonce,
+      this.events
+    )
   }
 }
 
@@ -170,10 +198,11 @@ export class Call extends Intent {
     settler: Address | null = null,
     user: Address | null = null,
     deadline: BigInt | null = null,
-    nonce: string | null = null
+    nonce: string | null = null,
+    events: IntentEvent[] | null = null
   ): Call {
     const callData = new CallData(target, data, value)
-    return new Call(chainId, [callData], [maxFee], settler, user, deadline, nonce)
+    return new Call(chainId, [callData], [maxFee], settler, user, deadline, nonce, events)
   }
 
   /**
@@ -193,10 +222,11 @@ export class Call extends Intent {
     settler: Address | null = null,
     user: Address | null = null,
     deadline: BigInt | null = null,
-    nonce: string | null = null
+    nonce: string | null = null,
+    events: IntentEvent[] | null = null
   ) {
     const fees: MaxFee[] = maxFees.map((fee: TokenAmount) => MaxFee.fromTokenAmount(fee))
-    super(OperationType.Call, chainId, fees, settler, user, deadline, nonce)
+    super(OperationType.Call, chainId, fees, settler, user, deadline, nonce, events)
     if (calls.length === 0) throw new Error('Call list cannot be empty')
     if (maxFees.length == 0) throw new Error('At least a max fee must be specified')
 

package/src/intents/Intent.ts

@@ -2,7 +2,7 @@ import { environment } from '../environment'
 import { evm } from '../evm'
 import { NULL_ADDRESS } from '../helpers'
 import { Token, TokenAmount } from '../tokens'
-import { Address, BigInt, ChainId } from '../types'
+import { Address, BigInt, Bytes, ChainId } from '../types'
 
 export enum OperationType {
   Swap,
@@ -21,6 +21,7 @@ export abstract class IntentBuilder {
   protected deadline: BigInt | null = null
   protected nonce: string | null = null
   protected maxFees: TokenAmount[] = []
+  protected events: IntentEvent[] = []
 
   /**
    * Sets the settler address for this intent.
@@ -80,6 +81,30 @@ export abstract class IntentBuilder {
     return this
   }
 
+  /**
+   * Sets an event for the intent.
+   * @param topic - The topic to be indexed in the event
+   * @param data - The event data
+   * @returns This IntentBuilder instance for method chaining
+   */
+  addEvent(topic: Bytes, data: Bytes): IntentBuilder {
+    const event = new IntentEvent(topic, data)
+    this.events.push(event)
+    return this
+  }
+
+  /**
+   * Sets multiple events for the intent.
+   * @param events - The list of events to be added
+   * @returns This IntentBuilder instance for method chaining
+   */
+  addEvents(events: IntentEvent[]): IntentBuilder {
+    for (let i = 0; i < events.length; i++) {
+      this.events.push(events[i])
+    }
+    return this
+  }
+
   /**
    * Adds a max fee for this intent.
    * @param fee - The max fee token amount (must be on same chain)
@@ -153,6 +178,26 @@ export class MaxFee {
   }
 }
 
+/**
+ * Represents an intent event.
+ * Specifies the topic and data for the event. The topic is an indexed parameter for the EVM events.
+ */
+@json
+export class IntentEvent {
+  topic: string
+  data: string
+
+  /**
+   * Creates a new Intent Event instance.
+   * @param topic - the topic that is going to be index in the event
+   * @param data - The event data
+   */
+  constructor(topic: Bytes, data: Bytes) {
+    this.topic = topic.toHexString()
+    this.data = data.toHexString()
+  }
+}
+
 let INTENT_INDEX: u32 = 0
 @json
 export abstract class Intent {
@@ -162,6 +207,7 @@ export abstract class Intent {
   public deadline: string
   public nonce: string
   public maxFees: MaxFee[]
+  public events: IntentEvent[]
 
   /**
    * Creates a new intent.
@@ -180,7 +226,8 @@ export abstract class Intent {
     settler: Address | null,
     user: Address | null,
     deadline: BigInt | null,
-    nonce: string | null
+    nonce: string | null,
+    events: IntentEvent[] | null
   ) {
     const context = environment.getContext()
     this.op = op
@@ -188,7 +235,10 @@ export abstract class Intent {
     this.settler = settler ? settler.toString() : context.findSettler(chainId).toString()
     this.deadline = deadline ? deadline.toString() : (context.timestamp / 1000 + DEFAULT_DEADLINE).toString()
     this.user = user ? user.toString() : context.user.toString()
-    this.nonce = nonce ? nonce : evm.keccak(`${context.configSig}${context.timestamp}${++INTENT_INDEX}`)
+    this.events = events || []
+    this.nonce = nonce
+      ? nonce
+      : evm.keccak(`${context.configSig}${context.timestamp}${context.trigger.data}${++INTENT_INDEX}`)
 
     if (!this.user || this.user == NULL_ADDRESS) throw new Error('A user must be specified')
     if (!this.settler || this.settler == NULL_ADDRESS) throw new Error('A settler contract must be specified')

package/src/intents/Swap.ts

@@ -1,8 +1,8 @@
 import { environment } from '../environment'
 import { Token, TokenAmount } from '../tokens'
-import { Address, BigInt, ChainId } from '../types'
+import { Address, BigInt, Bytes, ChainId } from '../types'
 
-import { Intent, IntentBuilder, MaxFee, OperationType } from './Intent'
+import { Intent, IntentBuilder, IntentEvent, MaxFee, OperationType } from './Intent'
 
 /**
  * Builder for creating Swap intents with token exchange operations.
@@ -215,6 +215,25 @@ export class SwapBuilder extends IntentBuilder {
     return this
   }
 
+  /**
+   * Sets an event for the intent.
+   * @param topic - The topic to be indexed in the event
+   * @param data - The event data
+   * @returns This SwapBuilder instance for method chaining
+   */
+  addEvent(topic: Bytes, data: Bytes): SwapBuilder {
+    return changetype<SwapBuilder>(super.addEvent(topic, data))
+  }
+
+  /**
+   * Sets multiple events for the intent.
+   * @param events - The list of events to be added
+   * @returns This SwapBuilder instance for method chaining
+   */
+  addEvents(events: IntentEvent[]): SwapBuilder {
+    return changetype<SwapBuilder>(super.addEvents(events))
+  }
+
   /**
    * Builds and returns the final Swap intent.
    * @returns A new Swap instance with all configured parameters
@@ -231,7 +250,8 @@ export class SwapBuilder extends IntentBuilder {
       this.user,
       this.deadline,
       this.nonce,
-      this.maxFees
+      this.maxFees,
+      this.events
     )
   }
 }
@@ -388,13 +408,14 @@ export class Swap extends Intent {
     settler: Address | null = null,
     user: Address | null = null,
     deadline: BigInt | null = null,
-    nonce: string | null = null
+    nonce: string | null = null,
+    events: IntentEvent[] | null = null
   ): Swap {
     const context = environment.getContext()
     const recipient = user || context.user
     const swapIn = TokenIn.fromBigInt(tokenIn, amountIn)
     const swapOut = TokenOut.fromBigInt(tokenOut, minAmountOut, recipient)
-    return new Swap(chainId, [swapIn], [swapOut], chainId, settler, user, deadline, nonce)
+    return new Swap(chainId, [swapIn], [swapOut], chainId, settler, user, deadline, nonce, [], events)
   }
 
   /**
@@ -418,10 +439,11 @@ export class Swap extends Intent {
     user: Address | null = null,
     deadline: BigInt | null = null,
     nonce: string | null = null,
-    maxFees: TokenAmount[] | null = null
+    maxFees: TokenAmount[] | null = null,
+    events: IntentEvent[] | null = null
   ) {
     const fees: MaxFee[] = maxFees ? maxFees.map((fee: TokenAmount) => MaxFee.fromTokenAmount(fee)) : []
-    super(OperationType.Swap, sourceChain, fees, settler, user, deadline, nonce)
+    super(OperationType.Swap, sourceChain, fees, settler, user, deadline, nonce, events)
     if (tokensIn.length === 0) throw new Error('TokenIn list cannot be empty')
     if (tokensOut.length === 0) throw new Error('TokenOut list cannot be empty')
   }

package/src/intents/Transfer.ts

@@ -1,8 +1,8 @@
 import { environment } from '../environment'
 import { ERC20Token, Token, TokenAmount } from '../tokens'
-import { Address, BigInt, ChainId } from '../types'
+import { Address, BigInt, Bytes, ChainId } from '../types'
 
-import { Intent, IntentBuilder, MaxFee, OperationType } from './Intent'
+import { Intent, IntentBuilder, IntentEvent, MaxFee, OperationType } from './Intent'
 
 /**
  * Builder for creating Transfer intents with token transfer operations.
@@ -173,12 +173,40 @@ export class TransferBuilder extends IntentBuilder {
     return this
   }
 
+  /**
+   * Sets an event for the intent.
+   * @param topic - The topic to be indexed in the event
+   * @param data - The event data
+   * @returns This TransferBuilder instance for method chaining
+   */
+  addEvent(topic: Bytes, data: Bytes): TransferBuilder {
+    return changetype<TransferBuilder>(super.addEvent(topic, data))
+  }
+
+  /**
+   * Sets multiple events for the intent.
+   * @param events - The list of events to be added
+   * @returns This TransferBuilder instance for method chaining
+   */
+  addEvents(events: IntentEvent[]): TransferBuilder {
+    return changetype<TransferBuilder>(super.addEvents(events))
+  }
+
   /**
    * Builds and returns the final Transfer intent.
    * @returns A new Transfer instance with all configured parameters
    */
   build(): Transfer {
-    return new Transfer(this.chainId, this.transfers, this.maxFees, this.settler, this.user, this.deadline, this.nonce)
+    return new Transfer(
+      this.chainId,
+      this.transfers,
+      this.maxFees,
+      this.settler,
+      this.user,
+      this.deadline,
+      this.nonce,
+      this.events
+    )
   }
 }
 
@@ -276,7 +304,8 @@ export class Transfer extends Intent {
     settler: Address | null = null,
     user: Address | null = null,
     deadline: BigInt | null = null,
-    nonce: string | null = null
+    nonce: string | null = null,
+    events: IntentEvent[] | null = null
   ): Transfer {
     const transferAmount = TokenAmount.fromBigInt(token, amount)
     const transferData = TransferData.fromTokenAmount(transferAmount, recipient)
@@ -288,7 +317,8 @@ export class Transfer extends Intent {
       settler,
       user,
       deadline,
-      nonce
+      nonce,
+      events
     )
   }
 
@@ -309,10 +339,11 @@ export class Transfer extends Intent {
     settler: Address | null = null,
     user: Address | null = null,
     deadline: BigInt | null = null,
-    nonce: string | null = null
+    nonce: string | null = null,
+    events: IntentEvent[] | null = null
   ) {
     const fees: MaxFee[] = maxFees.map((fee: TokenAmount) => MaxFee.fromTokenAmount(fee))
-    super(OperationType.Transfer, chainId, fees, settler, user, deadline, nonce)
+    super(OperationType.Transfer, chainId, fees, settler, user, deadline, nonce, events)
     if (transfers.length === 0) throw new Error('Transfer list cannot be empty')
     if (maxFees.length == 0) throw new Error('At least a max fee must be specified')
 

package/src/log.ts

@@ -4,6 +4,8 @@
 // Copyright (c) 2018 Graph Protocol, Inc. and contributors.
 // Modified by Mimic Protocol, 2025.
 
+import { Stringable } from "./helpers"
+
 export namespace log {
   @external('log', '_log')
   declare function _log(level: Level, msg: string): void
@@ -22,7 +24,7 @@ export namespace log {
    * @param msg Format string like "Value = {}, other = {}".
    * @param args Format string arguments.
    */
-  export function critical(msg: string, args: Array<string> = []): void {
+  export function critical<T extends Stringable>(msg: string, args: Array<T> = []): void {
     _log(Level.CRITICAL, format(msg, args))
   }
 
@@ -32,7 +34,7 @@ export namespace log {
    * @param msg Format string like "Value = {}, other = {}".
    * @param args Format string arguments.
    */
-  export function error(msg: string, args: Array<string> = []): void {
+  export function error<T extends Stringable>(msg: string, args: Array<T> = []): void {
     _log(Level.ERROR, format(msg, args))
   }
 
@@ -41,7 +43,7 @@ export namespace log {
    * @param msg Format string like "Value = {}, other = {}".
    * @param args Format string arguments.
    */
-  export function warning(msg: string, args: Array<string> = []): void {
+  export function warning<T extends Stringable>(msg: string, args: Array<T> = []): void {
     _log(Level.WARNING, format(msg, args))
   }
 
@@ -50,7 +52,7 @@ export namespace log {
    * @param msg Format string like "Value = {}, other = {}".
    * @param args Format string arguments.
    */
-  export function info(msg: string, args: Array<string> = []): void {
+  export function info<T extends Stringable>(msg: string, args: Array<T> = []): void {
     _log(Level.INFO, format(msg, args))
   }
 
@@ -59,20 +61,21 @@ export namespace log {
    * @param msg Format string like "Value = {}, other = {}".
    * @param args Format string arguments.
    */
-  export function debug(msg: string, args: Array<string> = []): void {
+  export function debug<T extends Stringable>(msg: string, args: Array<T> = []): void {
     _log(Level.DEBUG, format(msg, args))
   }
 }
 
-function format(fmt: string, args: string[]): string {
+function format<T extends Stringable>(fmt: string, args: Array<T>): string {
   let out = ''
   let argIndex = 0
+  const argsStr = args.map<string>(a => a.toString())
   for (let i: i32 = 0, len: i32 = fmt.length; i < len; i++) {
     if (i < len - 1 && fmt.charCodeAt(i) == 0x7b /* '{' */ && fmt.charCodeAt(i + 1) == 0x7d /* '}' */) {
-      if (argIndex >= args.length) {
+      if (argIndex >= argsStr.length) {
         throw new Error('Too few arguments for format string: ' + fmt)
       } else {
-        out += args[argIndex++]
+        out += argsStr[argIndex++]
         i++
       }
     } else {

package/src/tokens/BlockchainToken.ts

@@ -86,4 +86,13 @@ export abstract class BlockchainToken extends Token {
   hasChain(chain: ChainId): boolean {
     return this._chainId === chain
   }
+
+  /**
+   * Tells the string representation of this token.
+   * @returns The token address and chain ID along with symbol if present
+   */
+  toString(): string {
+    const description = 'Token ' + this.address.toString() + ' on chain ' + this.chainId.toString()
+    return description + (this._symbol ? ' (' + this._symbol + ')' : '')
+  }
 }

package/src/tokens/DenominationToken.ts

@@ -59,4 +59,12 @@ export class DenominationToken extends Token {
   hasChain(chain: ChainId): boolean {
     return true
   }
+
+  /**
+   * Tells the string representation of this token.
+   * @returns The token symbol
+   */
+  toString(): string {
+    return this.symbol
+  }
 }

package/src/tokens/Token.ts

@@ -77,9 +77,7 @@ export abstract class Token {
 
   /**
    * Tells the string representation of this token.
-   * @returns The token symbol
+   * @returns The string representation of the token
    */
-  toString(): string {
-    return this.symbol
-  }
+  abstract toString(): string
 }

package/src/types/TriggerType.ts

@@ -0,0 +1,4 @@
+export enum TriggerType {
+  CRON,
+  EVENT,
+}