@mimicprotocol/lib-ts 0.0.1-rc.35 → 0.0.1-rc.36

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @mimicprotocol/lib-ts
 
+## 0.0.1-rc.36
+
+### Patch Changes
+
+- 6a4fb70: rename to use functions
+
 ## 0.0.1-rc.35
 
 ### Patch Changes

package/README.md

@@ -25,11 +25,11 @@
 
 ## Content 
 
-This package provides a lightweight standard library for writing Mimic Protocol tasks in AssemblyScript. It includes:
+This package provides a lightweight standard library for writing Mimic Protocol functions in AssemblyScript. It includes:
 
 - Typed primitives to interact with oracles and contracts
 - Safe and minimal bindings for blockchain-specific operations
-- Utility helpers for developing deterministic, deployable task logic
+- Utility helpers for developing deterministic, deployable function logic
 
 ## Setup
 
@@ -50,7 +50,7 @@ $ yarn
 
 ## Usage
 
-Here’s an example of how to use the library in a Mimic task:
+Here’s an example of how to use the library in a Mimic function:
 
 ```ts
 import { environment, ERC20Token } from '@mimicprotocol/lib-ts'
@@ -60,7 +60,7 @@ const USDC = ERC20Token.fromString('0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
 environment.tokenPriceQuery(USDC, new Date(1744818017000))
 ```
 
-For full task development guide and examples please visit [docs.mimic.fi](https://docs.mimic.fi/)
+For full function development guide and examples please visit [docs.mimic.fi](https://docs.mimic.fi/)
 
 ## Security
 

package/package.json

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

package/src/context/Context.ts

@@ -22,14 +22,14 @@ export class Settler {
 }
 
 @json
-export class SerializableTrigger {
+export class SerializableTriggerPayload {
   constructor(
     public type: u8,
     public data: string
   ) {}
 }
 
-export class EventTriggerData {
+export class EventTriggerPayloadData {
   constructor(
     public chainId: BigInt,
     public blockHash: string,
@@ -41,35 +41,35 @@ export class EventTriggerData {
 }
 
 @json
-export class Trigger {
+export class TriggerPayload {
   constructor(
     public type: TriggerType,
     public data: string
   ) {}
 
-  static fromSerializable(serializable: SerializableTrigger): Trigger {
-    return new Trigger(serializable.type, serializable.data)
+  static fromSerializable(serializable: SerializableTriggerPayload): TriggerPayload {
+    return new TriggerPayload(serializable.type, serializable.data)
   }
 
   getCronData(): BigInt {
-    if (this.type !== TriggerType.CRON) throw new Error("Can't get cron data, trigger type is not cron")
-    return Trigger.deserializeCronTriggerData(this.data)
+    if (this.type !== TriggerType.CRON) throw new Error("Can't get cron data, config type is not cron")
+    return TriggerPayload.deserializeCronTriggerPayloadData(this.data)
   }
 
-  getEventData(): EventTriggerData {
-    if (this.type !== TriggerType.EVENT) throw new Error("Can't get event data, trigger type is not event")
-    return Trigger.deserializeEventTriggerData(this.data)
+  getEventData(): EventTriggerPayloadData {
+    if (this.type !== TriggerType.EVENT) throw new Error("Can't get event data, config type is not event")
+    return TriggerPayload.deserializeEventTriggerPayloadData(this.data)
   }
 
-  static deserializeCronTriggerData(data: string): BigInt {
+  static deserializeCronTriggerPayloadData(data: string): BigInt {
     return BigInt.fromString(evm.decode(new EvmDecodeParam('uint256', data)))
   }
 
-  static deserializeEventTriggerData(data: string): EventTriggerData {
+  static deserializeEventTriggerPayloadData(data: string): EventTriggerPayloadData {
     const fields = JSON.parse<string[]>(
       evm.decode(new EvmDecodeParam('(uint256,bytes32,uint256,address,bytes32[],bytes)', data))
     )
-    return new EventTriggerData(
+    return new EventTriggerPayloadData(
       BigInt.fromString(fields[0]),
       fields[1],
       BigInt.fromString(fields[2]),
@@ -87,8 +87,8 @@ export class SerializableContext {
     public readonly consensusThreshold: u8,
     public user: string,
     public settlers: SerializableSettler[],
-    public configSig: string,
-    public trigger: SerializableTrigger
+    public triggerSig: string,
+    public triggerPayload: SerializableTriggerPayload
   ) {}
 }
 
@@ -98,8 +98,8 @@ export class Context {
     public readonly consensusThreshold: u8,
     public user: Address,
     public settlers: Settler[],
-    public configSig: string,
-    public trigger: Trigger
+    public triggerSig: string,
+    public triggerPayload: TriggerPayload
   ) {}
 
   static fromSerializable(serializable: SerializableContext): Context {
@@ -108,8 +108,8 @@ export class Context {
       serializable.consensusThreshold,
       Address.fromString(serializable.user),
       serializable.settlers.map<Settler>((s) => Settler.fromSerializable(s)),
-      serializable.configSig,
-      Trigger.fromSerializable(serializable.trigger)
+      serializable.triggerSig,
+      TriggerPayload.fromSerializable(serializable.triggerPayload)
     )
   }
 

package/src/environment.ts

@@ -197,7 +197,7 @@ export namespace environment {
 
   /**
    * Returns the current execution context containing environment information.
-   * @returns The Context object containing: user, settler, timestamp, and config ID
+   * @returns The Context object containing: user, settler, timestamp, consensusThreshold and triggerPayload
    */
   export function getContext(): Context {
     const context = JSON.parse<SerializableContext>(_getContext())

package/src/intents/Intent.ts

@@ -239,7 +239,7 @@ export abstract class Intent {
     this.events = events || []
     this.nonce = nonce
       ? nonce
-      : evm.keccak(`${context.configSig}${context.timestamp}${context.trigger.data}${++INTENT_INDEX}`)
+      : evm.keccak(`${context.triggerSig}${context.timestamp}${context.triggerPayload.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')