@mimicprotocol/lib-ts 0.0.1-rc.9 → 0.0.1

package/src/helpers/strings.ts

@@ -1,5 +1,9 @@
-export function bytesToString(bytes: Uint8Array): string {
-  return String.UTF8.decodeUnsafe(bytes.dataStart, bytes.length)
+import { decode, encode } from 'as-base58/assembly/index'
+
+import { ByteArray } from '../types'
+
+export function bytesToString(bytes: Uint8Array, nullTerminated: bool = false): string {
+  return String.UTF8.decodeUnsafe(bytes.dataStart, bytes.length, nullTerminated)
 }
 
 export function bytesToHexString(bytes: Uint8Array): string {
@@ -8,6 +12,59 @@ export function bytesToHexString(bytes: Uint8Array): string {
   return hex
 }
 
+export function bytesToBase58String(bytes: Uint8Array): string {
+  return encode(bytes)
+}
+
+export function bytesFromBase58String(base58: string): ByteArray {
+  assert(isBase58(base58), `input ${base58} is not valid base58`)
+  return changetype<ByteArray>(decode(base58))
+}
+
+export function stringToBool(str: string): bool {
+  if (str !== 'true' && str !== 'false') throw new Error(`Invalid boolean: ${str}`)
+  return str === 'true'
+}
+
+/**
+ * Workaround for json-as boolean bug:
+ * Converts JSON boolean values (true/false) into their string equivalents ("true"/"false")
+ * without touching occurrences inside JSON strings or keys.
+ *
+ * This function assumes compact JSON (no newlines between the boolean and the delimiter).
+ */
+export function replaceJsonBooleans(json: string): string {
+  return (
+    json
+      // true after ':' (object property values)
+      .replaceAll(':true', ':"true"')
+      .replaceAll(':true,', ':"true",')
+      .replaceAll(':true}', ':"true"}')
+      .replaceAll(':true]', ':"true"]')
+      .replaceAll(': true,', ': "true",')
+      .replaceAll(': true}', ': "true"}')
+      .replaceAll(': true]', ': "true"]')
+      // true in arrays
+      .replaceAll('[true,', '["true",')
+      .replaceAll('[true]', '["true"]')
+      .replaceAll(',true,', ',"true",')
+      .replaceAll(',true]', ',"true"]')
+      // false after ':' (object property values)
+      .replaceAll(':false', ':"false"')
+      .replaceAll(':false,', ':"false",')
+      .replaceAll(':false}', ':"false"}')
+      .replaceAll(':false]', ':"false"]')
+      .replaceAll(': false,', ': "false",')
+      .replaceAll(': false}', ': "false"}')
+      .replaceAll(': false]', ': "false"]')
+      // false in arrays
+      .replaceAll('[false,', '["false",')
+      .replaceAll('[false]', '["false"]')
+      .replaceAll(',false,', ',"false",')
+      .replaceAll(',false]', ',"false"]')
+  )
+}
+
 export function areAllZeros(str: string): boolean {
   for (let i = 0; i < str.length; i++) if (str.charCodeAt(i) !== 48) return false
   return true
@@ -76,12 +133,14 @@ export function normalizeScientificNotation(input: string): string {
   if (newDecimalPos <= 0) {
     const zeros = '0'.repeat(-newDecimalPos)
     return sign + '0.' + zeros + fullDigits
-  } else if (newDecimalPos >= fullDigits.length) {
+  }
+
+  if (newDecimalPos >= fullDigits.length) {
     const zeros = '0'.repeat(newDecimalPos - fullDigits.length)
     return sign + fullDigits + zeros
-  } else {
-    return sign + fullDigits.substring(0, newDecimalPos) + '.' + fullDigits.substring(newDecimalPos)
   }
+
+  return sign + fullDigits.substring(0, newDecimalPos) + '.' + fullDigits.substring(newDecimalPos)
 }
 
 export function isHex(str: string, strict: boolean = false): boolean {
@@ -101,3 +160,21 @@ export function isHex(str: string, strict: boolean = false): boolean {
 
   return true
 }
+
+export function isBase58(str: string): boolean {
+  for (let i = 0; i < str.length; i++) {
+    const c = str.charCodeAt(i)
+
+    // Base58 alphabet: digits, letters (not 0IOl)
+    if (
+      (c >= '1'.charCodeAt(0) && c <= '9'.charCodeAt(0)) ||
+      (c >= 'A'.charCodeAt(0) && c <= 'Z'.charCodeAt(0) && c !== 'I'.charCodeAt(0) && c !== 'O'.charCodeAt(0)) ||
+      (c >= 'a'.charCodeAt(0) && c <= 'z'.charCodeAt(0) && c !== 'l'.charCodeAt(0))
+    ) {
+      continue
+    }
+    return false
+  }
+
+  return true
+}

package/src/intents/Call/EvmCall.ts

@@ -0,0 +1,283 @@
+import { environment } from '../../environment'
+import { TokenAmount } from '../../tokens'
+import { Address, BigInt, Bytes, ChainId } from '../../types'
+import { Intent, IntentBuilder, IntentEvent, MaxFee, OperationType } from '../Intent'
+
+/**
+ * Builder for creating EVM Call intents with contract call operations.
+ * Allows chaining multiple contract calls and configuring fees and settlement parameters.
+ */
+export class EvmCallBuilder extends IntentBuilder {
+  protected chainId: ChainId
+  protected calls: EvmCallData[] = []
+
+  /**
+   * Creates a EvmCallBuilder for the specified EVM blockchain network.
+   * @param chainId - The blockchain network identifier
+   * @returns A new EvmCallBuilder instance
+   */
+  static forChain(chainId: ChainId): EvmCallBuilder {
+    return new EvmCallBuilder(chainId)
+  }
+
+  /**
+   * Creates a new EvmCallBuilder instance.
+   * @param chainId - The EVM blockchain network identifier
+   */
+  private constructor(chainId: ChainId) {
+    super()
+    this.chainId = chainId
+  }
+
+  /**
+   * Adds a contract call to the intent.
+   * @param target - The contract address to call
+   * @param data - The call data (optional, defaults to empty bytes)
+   * @param value - The native token value to send (optional, defaults to zero)
+   * @returns This EvmCallBuilder instance for method chaining
+   */
+  addCall(target: Address, data: Bytes = Bytes.empty(), value: BigInt = BigInt.zero()): EvmCallBuilder {
+    this.calls.push(new EvmCallData(target, data, value))
+    return this
+  }
+
+  /**
+   * Adds multiple contract calls to the intent.
+   * @param calls - The contract calls to add
+   * @returns This EvmCallBuilder instance for method chaining
+   */
+  addCalls(calls: EvmCallData[]): EvmCallBuilder {
+    for (let i = 0; i < calls.length; i++)
+      this.addCall(
+        Address.fromString(calls[i].target),
+        Bytes.fromHexString(calls[i].data),
+        BigInt.fromString(calls[i].value)
+      )
+    return this
+  }
+
+  /**
+   * Adds the calls from another EvmCallBuilder to this EvmCallBuilder.
+   * @param builder - The EvmCallBuilder to add the calls from
+   * @returns This EvmCallBuilder instance for method chaining
+   */
+  addCallsFromBuilder(builder: EvmCallBuilder): EvmCallBuilder {
+    return this.addCalls(builder.getCalls())
+  }
+
+  /**
+   * Adds the calls from multiple EvmCallBuilders to this EvmCallBuilder.
+   * @param builders - The EvmCallBuilders to add the calls from
+   * @returns This EvmCallBuilder instance for method chaining
+   */
+  addCallsFromBuilders(builders: EvmCallBuilder[]): EvmCallBuilder {
+    for (let i = 0; i < builders.length; i++) this.addCallsFromBuilder(builders[i])
+    return this
+  }
+
+  /**
+   * Returns a copy of the calls array.
+   * @returns A copy of the calls array
+   */
+  getCalls(): EvmCallData[] {
+    return this.calls.slice(0)
+  }
+
+  /**
+   * Sets the settler address for this intent.
+   * @param settler - The settler address as an Address instance
+   * @returns This EvmCallBuilder instance for method chaining
+   */
+  addSettler(settler: Address): EvmCallBuilder {
+    return changetype<EvmCallBuilder>(super.addSettler(settler))
+  }
+
+  /**
+   * Sets the settler address from a string.
+   * @param settler - The settler address as a hex string
+   * @returns This EvmCallBuilder instance for method chaining
+   */
+  addSettlerAsString(settler: string): EvmCallBuilder {
+    return changetype<EvmCallBuilder>(super.addSettlerAsString(settler))
+  }
+
+  /**
+   * Sets the deadline for this intent.
+   * @param deadline - The deadline as a timestamp
+   * @returns This EvmCallBuilder instance for method chaining
+   */
+  addDeadline(deadline: BigInt): EvmCallBuilder {
+    return changetype<EvmCallBuilder>(super.addDeadline(deadline))
+  }
+
+  /**
+   * Sets the user address for this intent.
+   * @param user - The user address
+   * @returns This EvmCallBuilder instance for method chaining
+   */
+  addUser(user: Address): EvmCallBuilder {
+    return changetype<EvmCallBuilder>(super.addUser(user))
+  }
+
+  /**
+   * Sets the user address from a string.
+   * @param user - The user address as a hex string
+   * @returns This EvmCallBuilder instance for method chaining
+   */
+  addUserAsString(user: string): EvmCallBuilder {
+    return changetype<EvmCallBuilder>(super.addUserAsString(user))
+  }
+
+  /**
+   * Sets the nonce for this intent.
+   * @param nonce - A unique identifier to prevent replay attacks
+   * @returns This EvmCallBuilder instance for method chaining
+   */
+  addNonce(nonce: string): EvmCallBuilder {
+    return changetype<EvmCallBuilder>(super.addNonce(nonce))
+  }
+
+  /**
+   * Adds a max fee for this intent.
+   * @param fee - The max fee token amount (must be on same chain)
+   * @returns This EvmCallBuilder instance for method chaining
+   */
+  addMaxFee(fee: TokenAmount): EvmCallBuilder {
+    if (!fee.token.hasChain(this.chainId)) throw new Error('Fee token must be on the same chain')
+    this.maxFees.push(fee)
+    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 EvmCallBuilder instance for method chaining
+   */
+  addEvent(topic: Bytes, data: Bytes): EvmCallBuilder {
+    return changetype<EvmCallBuilder>(super.addEvent(topic, data))
+  }
+
+  /**
+   * Sets multiple events for the intent.
+   * @param events - The list of events to be added
+   * @returns This EvmCallBuilder instance for method chaining
+   */
+  addEvents(events: IntentEvent[]): EvmCallBuilder {
+    return changetype<EvmCallBuilder>(super.addEvents(events))
+  }
+
+  /**
+   * Builds and returns the final EvmCall intent.
+   * @returns A new EvmCall instance with all configured parameters
+   */
+  build(): EvmCall {
+    return new EvmCall(
+      this.chainId,
+      this.calls,
+      this.maxFees,
+      this.settler,
+      this.user,
+      this.deadline,
+      this.nonce,
+      this.events
+    )
+  }
+}
+
+/**
+ * Represents data for a single contract call within a Call intent.
+ * Contains the target address, call data, and value to send.
+ */
+@json
+export class EvmCallData {
+  public target: string
+  public data: string
+  public value: string
+
+  /**
+   * Creates a new EvmCallData instance.
+   * @param target - The contract address to call
+   * @param data - The call data (optional, defaults to empty bytes)
+   * @param value - The native token value to send (optional, defaults to zero)
+   */
+  constructor(target: Address, data: Bytes = Bytes.empty(), value: BigInt = BigInt.zero()) {
+    this.target = target.toString()
+    this.data = data.toHexString()
+    this.value = value.toString()
+  }
+}
+
+/**
+ * Represents a Call intent containing one or more contract calls to be executed.
+ */
+@json
+export class EvmCall extends Intent {
+  public chainId: ChainId
+  public calls: EvmCallData[]
+
+  /**
+   * Creates a EvmCall intent with a single contract call.
+   * @param chainId - The blockchain network identifier
+   * @param target - The contract address to call
+   * @param data - The call data
+   * @param maxFee - The max fee to pay for the call intent
+   * @param value - The native token value to send (optional, defaults to zero)
+   * @param settler - The settler address (optional)
+   * @param user - The user address (optional)
+   * @param deadline - The deadline timestamp (optional)
+   * @param nonce - The nonce for replay protection (optional)
+   * @returns A new Call instance
+   */
+  static create(
+    chainId: ChainId,
+    target: Address,
+    data: Bytes,
+    maxFee: TokenAmount,
+    value: BigInt = BigInt.zero(),
+    settler: Address | null = null,
+    user: Address | null = null,
+    deadline: BigInt | null = null,
+    nonce: string | null = null,
+    events: IntentEvent[] | null = null
+  ): EvmCall {
+    const callData = new EvmCallData(target, data, value)
+    return new EvmCall(chainId, [callData], [maxFee], settler, user, deadline, nonce, events)
+  }
+
+  /**
+   * Creates a new EvmCall intent.
+   * @param chainId - The blockchain network identifier
+   * @param calls - Array of contract calls to execute
+   * @param maxFees - The list of max fees to pay for the call intent
+   * @param settler - The settler address (optional)
+   * @param user - The user address (optional)
+   * @param deadline - The deadline timestamp (optional)
+   * @param nonce - The nonce for replay protection (optional)
+   */
+  constructor(
+    chainId: ChainId,
+    calls: EvmCallData[],
+    maxFees: TokenAmount[],
+    settler: Address | null = null,
+    user: Address | null = null,
+    deadline: BigInt | null = null,
+    nonce: string | null = null,
+    events: IntentEvent[] | null = null
+  ) {
+    const fees: MaxFee[] = maxFees.map((fee: TokenAmount) => MaxFee.fromTokenAmount(fee))
+    super(OperationType.EvmCall, 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')
+
+    this.calls = calls
+    this.chainId = chainId
+  }
+
+  /**
+   * Sends this EvmCall intent to the execution environment.
+   */
+  public send(): void {
+    environment.evmCall(this)
+  }
+}

package/src/intents/Call/SvmCall.ts

@@ -0,0 +1,278 @@
+import { environment } from '../../environment'
+import { TokenAmount } from '../../tokens'
+import { Address, BigInt, Bytes, ChainId } from '../../types'
+import { SvmAccountMeta } from '../../types/svm/SvmAccountMeta'
+import { Intent, IntentBuilder, IntentEvent, MaxFee, OperationType } from '../Intent'
+
+/**
+ * Builder for creating SVM Call intents with program call operations.
+ * Allows chaining multiple calls and configuring fees and settlement parameters.
+ */
+export class SvmCallBuilder extends IntentBuilder {
+  protected chainId: ChainId
+  protected instructions: SvmInstruction[] = []
+
+  /**
+   * Creates a SvmCallBuilder for Solana mainnet.
+   * @returns A new SvmCallBuilder instance
+   */
+  static forChain(): SvmCallBuilder {
+    return new SvmCallBuilder()
+  }
+
+  /**
+   * Creates a new SvmCallBuilder instance.
+   */
+  private constructor() {
+    super()
+    this.chainId = ChainId.SOLANA_MAINNET
+  }
+
+  /**
+   * Adds an instruction to the intent.
+   * @param instruction - The instruction to add
+   * @returns This SvmCallBuilder instance for method chaining
+   */
+  addInstruction(instruction: SvmInstruction): SvmCallBuilder {
+    this.instructions.push(instruction)
+    return this
+  }
+
+  /**
+   * Adds multiple instructions to the intent.
+   * @param instructions - The instructions to add
+   * @returns This SvmCallBuilder instance for method chaining
+   */
+  addInstructions(instructions: SvmInstruction[]): SvmCallBuilder {
+    for (let i = 0; i < instructions.length; i++) this.addInstruction(instructions[i])
+    return this
+  }
+
+  /**
+   * Adds the instructions from another SvmCallBuilder to this SvmCallBuilder.
+   * @param builder - The SvmCallBuilder to add the instructions from
+   * @returns This SvmCallBuilder instance for method chaining
+   */
+  addInstructionsFromBuilder(builder: SvmCallBuilder): SvmCallBuilder {
+    return this.addInstructions(builder.getInstructions())
+  }
+
+  /**
+   * Adds the instructions from multiple SvmCallBuilders to this SvmCallBuilder.
+   * @param builders - The SvmCallBuilders to add the instructions from
+   * @returns This SvmCallBuilder instance for method chaining
+   */
+  addInstructionsFromBuilders(builders: SvmCallBuilder[]): SvmCallBuilder {
+    for (let i = 0; i < builders.length; i++) this.addInstructionsFromBuilder(builders[i])
+    return this
+  }
+
+  /**
+   * Returns a copy of the instructions array.
+   * @returns A copy of the instructions array
+   */
+  getInstructions(): SvmInstruction[] {
+    return this.instructions.slice(0)
+  }
+
+  /**
+   * Sets the settler address for this intent.
+   * @param settler - The settler address as an Address instance
+   * @returns This SvmCallBuilder instance for method chaining
+   */
+  addSettler(settler: Address): SvmCallBuilder {
+    return changetype<SvmCallBuilder>(super.addSettler(settler))
+  }
+
+  /**
+   * Sets the settler address from a string.
+   * @param settler - The settler address as a hex string
+   * @returns This SvmCallBuilder instance for method chaining
+   */
+  addSettlerAsString(settler: string): SvmCallBuilder {
+    return changetype<SvmCallBuilder>(super.addSettlerAsString(settler))
+  }
+
+  /**
+   * Sets the deadline for this intent.
+   * @param deadline - The deadline as a timestamp
+   * @returns This SvmCallBuilder instance for method chaining
+   */
+  addDeadline(deadline: BigInt): SvmCallBuilder {
+    return changetype<SvmCallBuilder>(super.addDeadline(deadline))
+  }
+
+  /**
+   * Sets the user address for this intent.
+   * @param user - The user address
+   * @returns This SvmCallBuilder instance for method chaining
+   */
+  addUser(user: Address): SvmCallBuilder {
+    return changetype<SvmCallBuilder>(super.addUser(user))
+  }
+
+  /**
+   * Sets the user address from a string.
+   * @param user - The user address as a hex string
+   * @returns This SvmCallBuilder instance for method chaining
+   */
+  addUserAsString(user: string): SvmCallBuilder {
+    return changetype<SvmCallBuilder>(super.addUserAsString(user))
+  }
+
+  /**
+   * Sets the nonce for this intent.
+   * @param nonce - A unique identifier to prevent replay attacks
+   * @returns This SvmCallBuilder instance for method chaining
+   */
+  addNonce(nonce: string): SvmCallBuilder {
+    return changetype<SvmCallBuilder>(super.addNonce(nonce))
+  }
+
+  /**
+   * Adds a max fee for this intent.
+   * @param fee - The max fee token amount (must be on same chain)
+   * @returns This SvmCallBuilder instance for method chaining
+   */
+  addMaxFee(fee: TokenAmount): SvmCallBuilder {
+    if (!fee.token.hasChain(this.chainId)) throw new Error('Fee token must be on the same chain')
+    this.maxFees.push(fee)
+    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 SvmCallBuilder instance for method chaining
+   */
+  addEvent(topic: Bytes, data: Bytes): SvmCallBuilder {
+    return changetype<SvmCallBuilder>(super.addEvent(topic, data))
+  }
+
+  /**
+   * Sets multiple events for the intent.
+   * @param events - The list of events to be added
+   * @returns This SvmCallBuilder instance for method chaining
+   */
+  addEvents(events: IntentEvent[]): SvmCallBuilder {
+    return changetype<SvmCallBuilder>(super.addEvents(events))
+  }
+
+  /**
+   * Builds and returns the final SvmCall intent.
+   * @returns A new SvmCall instance with all configured parameters
+   */
+  build(): SvmCall {
+    return new SvmCall(this.instructions, this.maxFees, this.settler, this.user, this.deadline, this.nonce, this.events)
+  }
+}
+
+export class SvmInstructionBuilder {
+  protected programId: Address = Address.zero(32)
+  protected accountsMeta: SvmAccountMeta[] = []
+  protected data: Bytes = Bytes.empty()
+
+  setProgram(programId: Address): SvmInstructionBuilder {
+    this.programId = programId
+    return this
+  }
+
+  setAccounts(accountsMeta: SvmAccountMeta[]): SvmInstructionBuilder {
+    this.accountsMeta = accountsMeta
+    return this
+  }
+
+  setDataFromBytes(data: Bytes): SvmInstructionBuilder {
+    this.data = data
+    return this
+  }
+
+  setDataFromHex(data: string): SvmInstructionBuilder {
+    return this.setDataFromBytes(Bytes.fromHexString(data))
+  }
+
+  instruction(): SvmInstruction {
+    return SvmInstruction.create(this.programId, this.accountsMeta, this.data)
+  }
+}
+
+@json
+export class SvmInstruction {
+  constructor(
+    public programId: string,
+    public accountsMeta: SvmAccountMeta[],
+    public data: string
+  ) {}
+
+  static create(programId: Address, accountsMeta: SvmAccountMeta[], data: Bytes): SvmInstruction {
+    return new SvmInstruction(programId.toBase58String(), accountsMeta, data.toHexString())
+  }
+}
+
+/**
+ * Represents a SVM Call intent containing one or more program calls to be executed.
+ */
+@json
+export class SvmCall extends Intent {
+  public chainId: ChainId
+  public instructions: SvmInstruction[]
+
+  /**
+   * Creates a SvmCall intent with a single program call.
+   * @param maxFee - The max fee to pay for the call intent
+   * @param settler - The settler address (optional)
+   * @param user - The user address (optional)
+   * @param deadline - The deadline timestamp (optional)
+   * @param nonce - The nonce for replay protection (optional)
+   * @returns A new Call instance
+   */
+  static create(
+    programId: Address,
+    accountsMeta: SvmAccountMeta[],
+    data: Bytes,
+    maxFee: TokenAmount,
+    settler: Address | null = null,
+    user: Address | null = null,
+    deadline: BigInt | null = null,
+    nonce: string | null = null,
+    events: IntentEvent[] | null = null
+  ): SvmCall {
+    const instruction = SvmInstruction.create(programId, accountsMeta, data)
+    return new SvmCall([instruction], [maxFee], settler, user, deadline, nonce, events)
+  }
+
+  /**
+   * Creates a new SvmCall intent.
+   * @param instructions - Array of instructions to execute
+   * @param maxFees - The list of max fees to pay for the call intent
+   * @param settler - The settler address (optional)
+   * @param user - The user address (optional)
+   * @param deadline - The deadline timestamp (optional)
+   * @param nonce - The nonce for replay protection (optional)
+   */
+  constructor(
+    instructions: SvmInstruction[],
+    maxFees: TokenAmount[],
+    settler: Address | null = null,
+    user: Address | null = null,
+    deadline: BigInt | null = null,
+    nonce: string | null = null,
+    events: IntentEvent[] | null = null
+  ) {
+    const fees: MaxFee[] = maxFees.map((fee: TokenAmount) => MaxFee.fromTokenAmount(fee))
+    super(OperationType.SvmCall, ChainId.SOLANA_MAINNET, fees, settler, user, deadline, nonce, events)
+    if (instructions.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')
+
+    this.instructions = instructions
+    this.chainId = ChainId.SOLANA_MAINNET
+  }
+
+  /**
+   * Sends this SvmCall intent to the execution environment.
+   */
+  public send(): void {
+    environment.svmCall(this)
+  }
+}

package/src/intents/Call/index.ts

@@ -0,0 +1,2 @@
+export * from './EvmCall'
+export * from './SvmCall'