@mimicprotocol/lib-ts 0.0.1-rc.13 → 0.0.1-rc.15

package/package.json

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

package/src/chains/Sonic.ts

@@ -0,0 +1,13 @@
+import { ERC20Token } from '../tokens'
+import { ChainId } from '../types'
+
+/* eslint-disable no-secrets/no-secrets */
+
+export namespace Sonic {
+  export const CHAIN_ID = ChainId.SONIC
+  export const SONIC = ERC20Token.native(CHAIN_ID)
+  export const USDC = ERC20Token.fromString('0x29219dd400f2Bf60E5a23d13Be72B486D4038894', CHAIN_ID, 6, 'USDC')
+  export const USDT = ERC20Token.fromString('0x6047828dc181963ba44974801ff68e538da5eaf9', CHAIN_ID, 6, 'USDT')
+  export const WETH = ERC20Token.fromString('0x50c42dEAcD8Fc9773493ED674b675bE577f2634b', CHAIN_ID, 18, 'WETH')
+  export const WSONIC = ERC20Token.fromString('0x039e2fB66102314Ce7b64Ce5Ce3E5183bc94aD38', CHAIN_ID, 18, 'WSONIC')
+}

package/src/chains/index.ts

@@ -3,3 +3,4 @@ export * from './Base'
 export * from './Ethereum'
 export * from './Gnosis'
 export * from './Optimism'
+export * from './Sonic'

package/src/helpers/constants.ts

@@ -1,5 +1,6 @@
 export const NULL_ADDRESS = '0x0000000000000000000000000000000000000000'
-export const NATIVE_ADDRESS = '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'
+export const EVM_NATIVE_ADDRESS = '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'
+export const SVM_NATIVE_ADDRESS = 'Nativeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'
 export const USD_ADDRESS = '0x0000000000000000000000000000000000000348'
 
 export const STANDARD_DECIMALS: u8 = 18

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, OperationType } from './Intent'
+import { Intent, IntentBuilder, MaxFee, OperationType } from './Intent'
 
 /**
  * Builder for creating Call intents with contract call operations.
@@ -195,7 +195,8 @@ export class Call extends Intent {
     deadline: BigInt | null = null,
     nonce: string | null = null
   ) {
-    super(OperationType.Call, chainId, maxFees, settler, user, deadline, nonce)
+    const fees: MaxFee[] = maxFees.map((fee: TokenAmount) => MaxFee.fromTokenAmount(fee))
+    super(OperationType.Call, chainId, fees, settler, user, deadline, nonce)
     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

@@ -1,7 +1,7 @@
 import { environment } from '../environment'
 import { evm } from '../evm'
 import { NULL_ADDRESS } from '../helpers'
-import { TokenAmount } from '../tokens'
+import { Token, TokenAmount } from '../tokens'
 import { Address, BigInt, ChainId } from '../types'
 
 export enum OperationType {
@@ -94,6 +94,65 @@ export abstract class IntentBuilder {
   abstract build(): Intent
 }
 
+/**
+ * Represents an intent max fee.
+ * Specifies the token address and the max amount to be paid for the intent.
+ */
+@json
+export class MaxFee {
+  token: string
+  amount: string
+
+  /**
+   * Creates a MaxFee from a TokenAmount.
+   * @param tokenAmount - The token amount to be used as max fee
+   * @returns A new MaxFee instance
+   */
+  static fromTokenAmount(tokenAmount: TokenAmount): MaxFee {
+    return new MaxFee(tokenAmount.token.address, tokenAmount.amount)
+  }
+
+  /**
+   * Creates a MaxFee from a 32-bit integer amount.
+   * @param token - The max fee token
+   * @param amount - The max fee amount
+   * @returns A new MaxFee instance
+   */
+  static fromI32(token: Token, amount: i32): MaxFee {
+    return this.fromTokenAmount(TokenAmount.fromI32(token, amount))
+  }
+
+  /**
+   * Creates a MaxFee from a BigInt amount.
+   * @param token - The max fee token
+   * @param amount - The max fee amount in the token's smallest unit
+   * @returns A new MaxFee instance
+   */
+  static fromBigInt(token: Token, amount: BigInt): MaxFee {
+    return this.fromTokenAmount(TokenAmount.fromBigInt(token, amount))
+  }
+
+  /**
+   * Creates a MaxFee from a decimal string amount.
+   * @param token - The max fee token
+   * @param amount - The max fee amount as a decimal string
+   * @returns A new MaxFee instance
+   */
+  static fromStringDecimal(token: Token, amount: string): MaxFee {
+    return this.fromTokenAmount(TokenAmount.fromStringDecimal(token, amount))
+  }
+
+  /**
+   * Creates a new MaxFee instance.
+   * @param token - The max fee token address
+   * @param amount - The max fee amount
+   */
+  constructor(token: Address, amount: BigInt) {
+    this.token = token.toString()
+    this.amount = amount.toString()
+  }
+}
+
 let INTENT_INDEX: u32 = 0
 @json
 export abstract class Intent {
@@ -102,14 +161,13 @@ export abstract class Intent {
   public user: string
   public deadline: string
   public nonce: string
-  public maxFeeTokens: string[]
-  public maxFeeAmounts: string[]
+  public maxFees: MaxFee[]
 
   /**
    * Creates a new intent.
    * @param op - The type of intent to be created
    * @param chainId - The chain ID for fetch the settler
-   * @param maxFees - The list of max fees to pay for the intent
+   * @param maxFees - The list of max fees to pay for the intent (optional)
    * @param settler - The settler address (optional)
    * @param user - The user address (optional)
    * @param deadline - The deadline timestamp (optional)
@@ -118,7 +176,7 @@ export abstract class Intent {
   protected constructor(
     op: OperationType,
     chainId: ChainId,
-    maxFees: TokenAmount[],
+    maxFees: MaxFee[] | null,
     settler: Address | null,
     user: Address | null,
     deadline: BigInt | null,
@@ -126,12 +184,11 @@ export abstract class Intent {
   ) {
     const context = environment.getContext()
     this.op = op
+    this.maxFees = maxFees || []
     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.maxFeeTokens = maxFees.map((fee: TokenAmount) => fee.token.address.toString())
-    this.maxFeeAmounts = maxFees.map((fee: TokenAmount) => fee.amount.toString())
 
     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

@@ -2,7 +2,7 @@ import { environment } from '../environment'
 import { ERC20Token, Token, TokenAmount } from '../tokens'
 import { Address, BigInt, ChainId } from '../types'
 
-import { Intent, IntentBuilder, OperationType } from './Intent'
+import { Intent, IntentBuilder, MaxFee, OperationType } from './Intent'
 
 /**
  * Builder for creating Swap intents with token exchange operations.
@@ -420,7 +420,8 @@ export class Swap extends Intent {
     nonce: string | null = null,
     maxFees: TokenAmount[] | null = null
   ) {
-    super(OperationType.Swap, sourceChain, maxFees || [], settler, user, deadline, nonce)
+    const fees: MaxFee[] = maxFees ? maxFees.map((fee: TokenAmount) => MaxFee.fromTokenAmount(fee)) : []
+    super(OperationType.Swap, sourceChain, fees, settler, user, deadline, nonce)
     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

@@ -2,7 +2,7 @@ import { environment } from '../environment'
 import { ERC20Token, Token, TokenAmount } from '../tokens'
 import { Address, BigInt, ChainId } from '../types'
 
-import { Intent, IntentBuilder, OperationType } from './Intent'
+import { Intent, IntentBuilder, MaxFee, OperationType } from './Intent'
 
 /**
  * Builder for creating Transfer intents with token transfer operations.
@@ -306,7 +306,8 @@ export class Transfer extends Intent {
     deadline: BigInt | null = null,
     nonce: string | null = null
   ) {
-    super(OperationType.Transfer, chainId, maxFees, settler, user, deadline, nonce)
+    const fees: MaxFee[] = maxFees.map((fee: TokenAmount) => MaxFee.fromTokenAmount(fee))
+    super(OperationType.Transfer, chainId, fees, settler, user, deadline, nonce)
     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/tokens/DenominationToken.ts

@@ -11,7 +11,7 @@ export class DenominationToken extends Token {
    * @returns A new Denomination Token instance for USD
    */
   static USD(): DenominationToken {
-    return new DenominationToken(Address.USD(), 6, 'USD')
+    return new DenominationToken(Address.USD(), 18, 'USD')
   }
 
   /**

package/src/tokens/ERC20Token.ts

@@ -1,6 +1,6 @@
 import { environment } from '../environment'
 import { evm } from '../evm'
-import { NATIVE_ADDRESS } from '../helpers'
+import { EVM_NATIVE_ADDRESS } from '../helpers'
 import { Address, ChainId, EvmDecodeParam } from '../types'
 
 import { Token } from './Token'
@@ -27,9 +27,11 @@ export class ERC20Token extends Token {
       case ChainId.BASE:
       case ChainId.ARBITRUM:
       case ChainId.OPTIMISM:
-        return ERC20Token.fromString(NATIVE_ADDRESS, chainId, 18, 'ETH')
+        return ERC20Token.fromString(EVM_NATIVE_ADDRESS, chainId, 18, 'ETH')
       case ChainId.GNOSIS:
-        return ERC20Token.fromString(NATIVE_ADDRESS, chainId, 18, 'xDAI')
+        return ERC20Token.fromString(EVM_NATIVE_ADDRESS, chainId, 18, 'xDAI')
+      case ChainId.SONIC:
+        return ERC20Token.fromString(EVM_NATIVE_ADDRESS, chainId, 18, 'SONIC')
       default:
         throw new Error(`Unsupported chainId: ${chainId}`)
     }
@@ -88,6 +90,7 @@ export class ERC20Token extends Token {
     symbol: string = ERC20Token.EMPTY_SYMBOL,
     timestamp: Date | null = null
   ) {
+    if (!address.isEVM()) throw new Error(`Address ${address} must be an EVM address.`)
     super(address, decimals, symbol)
     this._chainId = chainId
     this._timestamp = timestamp

package/src/tokens/SPLToken.ts

@@ -0,0 +1,113 @@
+import { SVM_NATIVE_ADDRESS } from '../helpers'
+import { Address, ChainId } from '../types'
+
+import { Token } from './Token'
+
+/**
+ * Represents a token on a blockchain network including data like symbol, decimals, and address.
+ */
+export class SPLToken extends Token {
+  private _chainId: ChainId
+
+  /**
+   * Creates a Token instance representing the native SOL token.
+   * @returns A new Token instance for the native token
+   */
+  static native(): SPLToken {
+    return SPLToken.fromString(SVM_NATIVE_ADDRESS, 9, 'SOL')
+  }
+
+  /**
+   * Creates a Token instance from an Address object.
+   * @param address - The token mint address
+   * @param decimals - Number of decimal places
+   * @param symbol - Token symbol
+   * @returns A new Token instance
+   */
+  static fromAddress(address: Address, decimals: u8, symbol: string): SPLToken {
+    return new SPLToken(address, decimals, symbol)
+  }
+
+  /**
+   * Creates a Token instance from a string address.
+   * @param address - The token mint address as a base58 string
+   * @param decimals - Number of decimal places
+   * @param symbol - Token symbol
+   * @returns A new Token instance
+   */
+  static fromString(address: string, decimals: u8, symbol: string): SPLToken {
+    return SPLToken.fromAddress(Address.fromString(address), decimals, symbol)
+  }
+
+  /**
+   * Creates a new Token instance.
+   * @param address - The token mint address
+   * @param decimals - Number of decimal places
+   * @param symbol - Token symbol
+   */
+  constructor(address: Address, decimals: u8, symbol: string) {
+    if (!address.isSVM()) throw new Error(`Address ${address} must be an SVM address.`)
+    super(address, decimals, symbol)
+    this._chainId = ChainId.SOLANA_MAINNET
+  }
+
+  /**
+   * Gets the blockchain network identifier where this token is deployed.
+   * This value is assigned during construction and remains constant throughout the token's lifecycle.
+   * @returns The `ChainId` representing the token's network.
+   */
+  get chainId(): ChainId {
+    return this._chainId
+  }
+
+  /**
+   * Gets the token's symbol (e.g., "SOL", "USDC").
+   * @returns A string containing the token symbol.
+   */
+  get symbol(): string {
+    return this._symbol
+  }
+
+  /**
+   * Gets the token's decimals (number of decimal places used).
+   * @returns A `u8` representing the number of decimals of the token.
+   */
+  get decimals(): u8 {
+    return this._decimals
+  }
+
+  /**
+   * Checks if this token is equal to another token.
+   * SPL Tokens are considered equal if they have the same address.
+   * @param other - The token to compare with
+   * @returns True if both tokens represent the same asset
+   */
+  equals(other: Token): boolean {
+    return other instanceof SPLToken && super.equals(other)
+  }
+
+  /**
+   * Checks if this token is the USD denomination.
+   * @returns False always
+   */
+  isUSD(): boolean {
+    return false
+  }
+
+  /**
+   * Checks if this token is the native token.
+   * @returns True if the token is the native token
+   */
+  isNative(): boolean {
+    return this.equals(SPLToken.native())
+  }
+
+  /**
+   * Checks if this token belongs to the requested chain.
+   * @param chain - The chain ID asking for
+   * @returns True if chains are equal
+   */
+  hasChain(chain: ChainId): boolean {
+    return this.chainId === chain
+  }
+}

package/src/tokens/Token.ts

@@ -2,7 +2,7 @@ import { Address, ChainId } from '../types'
 
 /**
  * Represents a token on a blockchain network including data like symbol, decimals, and address.
- * Supports both ERC-20 and denomination tokens.
+ * Supports both ERC-20, SPL, and denomination tokens.
  */
 export abstract class Token {
   protected _symbol: string

package/src/types/Address.ts

@@ -4,7 +4,7 @@
 // Copyright (c) 2018 Graph Protocol, Inc. and contributors.
 // Modified by Mimic Protocol, 2025.
 
-import { isHex, NATIVE_ADDRESS, USD_ADDRESS } from '../helpers'
+import { EVM_NATIVE_ADDRESS, isHex, USD_ADDRESS } from '../helpers'
 
 import { ByteArray } from './ByteArray'
 import { Bytes } from './Bytes'
@@ -32,7 +32,7 @@ export class Address extends Bytes {
    * Returns the native address.
    */
   static native(): Address {
-    return Address.fromString(NATIVE_ADDRESS)
+    return Address.fromString(EVM_NATIVE_ADDRESS)
   }
 
   /**

package/src/types/ChainId.ts

@@ -8,4 +8,6 @@ export enum ChainId {
   ARBITRUM = 42161,
   BASE = 8453,
   GNOSIS = 100,
+  SOLANA_MAINNET = 507424,
+  SONIC = 146,
 }