Feat/add public provider (#722)

* add PublicProvider class and update provider interfaces

* refactor: update Args constructor and enhance SmartContract provider handling

* test: integrate publicProvider into SmartContract tests

* refactor: update MNS and token classes to support PublicProvider

* refactor: replace Provider with PublicProvider in EventPoller and Operation classes

* refactor: enhance provider type handling and add provider type guard

* refactor: migrate Web3Provider to JsonRpcProvider and update related imports

* refactor: optimize balance retrieval by using getMultipleAddressInfo method

* refactor: ensure retro compatibility by exporting JsonRpcProvider and JsonRpcPublicProvider as Web3Provider

src/basicElements/args.ts

@@ -133,7 +133,7 @@ export class Args {
    * @param offset - The optional offset to start deserializing from.
    */
   constructor(
-    public serialized = new Uint8Array(),
+    public serialized: Uint8Array = new Uint8Array(),
     public offset = DEFAULT_OFFSET
   ) {}
 

src/contracts-wrappers/mns.ts

@@ -1,6 +1,6 @@
 import { Args, bytesToStr, strToBytes, U256 } from '../basicElements'
 import { Operation } from '../operation'
-import { Provider } from '../provider'
+import { Provider, PublicProvider } from '../provider'
 import { CallSCOptions, ReadSCOptions, SmartContract } from '../smartContracts'
 import { checkNetwork } from './tokens'
 
@@ -36,12 +36,12 @@ const DOMAIN_KEY_PREFIX = [0x3]
 const OWNED_TOKENS_KEY = strToBytes('ownedTokens')
 
 export class MNS extends SmartContract {
-  static mainnet(provider: Provider): MNS {
+  static mainnet(provider: Provider | PublicProvider): MNS {
     checkNetwork(provider, true)
     return new MNS(provider, MNS_CONTRACTS.mainnet)
   }
 
-  static buildnet(provider: Provider): MNS {
+  static buildnet(provider: Provider | PublicProvider): MNS {
     checkNetwork(provider, false)
     return new MNS(provider, MNS_CONTRACTS.buildnet)
   }

src/contracts-wrappers/tokens.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import { Provider } from '../provider'
+import { Provider, PublicProvider } from '../provider'
 import { CHAIN_ID, Network } from '../utils'
 import { MRC20 } from './token'
 
@@ -22,7 +22,10 @@ export const BUILDNET_TOKENS = {
   WMAS: 'AS12FW5Rs5YN2zdpEnqwj4iHUUPt9R4Eqjq2qtpJFNKW3mn33RuLU',
 }
 
-export function checkNetwork(provider: Provider, isMainnet: boolean): void {
+export function checkNetwork(
+  provider: PublicProvider | Provider,
+  isMainnet: boolean
+): void {
   provider.networkInfos().then((network: Network) => {
     if (isMainnet && network.chainId !== CHAIN_ID.Mainnet) {
       console.warn('This contract is only available on mainnet')
@@ -35,49 +38,49 @@ export function checkNetwork(provider: Provider, isMainnet: boolean): void {
 ///////////////// MAINNET TOKENS //////////////////////
 
 export class USDCe extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, true)
     super(provider, MAINNET_TOKENS.USDCe)
   }
 }
 
 export class USDTb extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, true)
     super(provider, MAINNET_TOKENS.USDTb)
   }
 }
 
 export class DAIe extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, true)
     super(provider, MAINNET_TOKENS.DAIe)
   }
 }
 
 export class WETHe extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, true)
     super(provider, MAINNET_TOKENS.WETHe)
   }
 }
 
 export class WETHb extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, true)
     super(provider, MAINNET_TOKENS.WETHb)
   }
 }
 
 export class PUR extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, true)
     super(provider, MAINNET_TOKENS.PUR)
   }
 }
 
 export class WMAS extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, true)
     super(provider, MAINNET_TOKENS.WMAS)
   }
@@ -86,42 +89,42 @@ export class WMAS extends MRC20 {
 ///////////////// BUILDNET TOKENS //////////////////////
 
 export class DAIs extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, false)
     super(provider, BUILDNET_TOKENS.DAIs)
   }
 }
 
 export class WETHs extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, false)
     super(provider, BUILDNET_TOKENS.WETHs)
   }
 }
 
 export class USDCs extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, false)
     super(provider, BUILDNET_TOKENS.USDCs)
   }
 }
 
 export class USDTbt extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, false)
     super(provider, BUILDNET_TOKENS.USDTbt)
   }
 }
 
 export class WETHbt extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, false)
     super(provider, BUILDNET_TOKENS.WETHbt)
   }
 }
 
 export class WMASBuildnet extends MRC20 {
-  constructor(public provider: Provider) {
+  constructor(public provider: Provider | PublicProvider) {
     checkNetwork(provider, false)
     super(provider, BUILDNET_TOKENS.WMAS)
   }

src/events/eventsPoller.ts

@@ -1,4 +1,4 @@
-import { Provider } from '../provider'
+import { PublicProvider } from '../provider'
 import { EventFilter, NB_THREADS } from '../client'
 import EventEmitter from 'eventemitter3'
 import { rpcTypes as t } from '../generated'
@@ -36,7 +36,7 @@ export class EventPoller extends EventEmitter {
    * @param pollIntervalMs - The interval in milliseconds to poll for events.
    */
   public constructor(
-    private readonly provider: Provider,
+    private readonly provider: PublicProvider,
     private readonly eventsFilter: EventFilter,
     private readonly pollIntervalMs: number
   ) {
@@ -90,7 +90,7 @@ export class EventPoller extends EventEmitter {
    */
   // eslint-disable-next-line max-params
   public static start(
-    provider: Provider,
+    provider: PublicProvider,
     eventsFilter: EventFilter,
     onData?: (data: t.OutputEvents) => void,
     onError?: (err: Error) => void,

src/operation/operation.ts

@@ -1,6 +1,6 @@
 import { Args, ArrayTypes } from '../basicElements'
 import { rpcTypes as t } from '../generated'
-import { Provider } from '../provider'
+import { Provider, PublicProvider } from '../provider'
 import { rawEventDecode } from '../utils'
 import { OperationStatus } from './types'
 
@@ -12,7 +12,7 @@ const DEFAULT_WAIT_PERIOD_MS = 500
  */
 export class Operation {
   constructor(
-    public provider: Provider,
+    public provider: Provider | PublicProvider,
     public id: string
   ) {}
 

src/provider/helpers.ts

@@ -0,0 +1,7 @@
+import { Provider } from './interface'
+
+export function isProvider(provider: unknown): provider is Provider {
+  return (
+    typeof provider === 'object' && provider !== null && 'callSC' in provider
+  )
+}

src/provider/index.ts

@@ -1,3 +1,4 @@
 export * from './types'
+export * from './constants'
 export * from './interface'
-export * from './web3Provider'
+export * from './jsonRpcProvider'

src/provider/interface.ts

@@ -1,22 +1,44 @@
 import { Address, EventFilter, Network, SmartContract } from '..'
 import { Mas } from '../basicElements/mas'
 import { Operation, OperationOptions, OperationStatus } from '../operation'
+import { rpcTypes as t } from '../generated'
 import {
   CallSCParams,
   DeploySCParams,
-  ReadSCData,
-  ReadSCParams,
   SignedData,
-  NodeStatusInfo,
   ExecuteScParams,
   SignOptions,
+  NodeStatusInfo,
+  ReadSCData,
+  ReadSCParams,
 } from './'
-import { rpcTypes as t } from '../generated'
+
+export type PublicProvider = {
+  balanceOf(
+    addresses: string[],
+    final?: boolean
+  ): Promise<{ address: string; balance: bigint }[]>
+  networkInfos(): Promise<Network>
+  getOperationStatus(opId: string): Promise<OperationStatus>
+  getEvents(filter: EventFilter): Promise<t.OutputEvents>
+  getNodeStatus(): Promise<NodeStatusInfo>
+  readSC(params: ReadSCParams): Promise<ReadSCData>
+  getStorageKeys(
+    address: string,
+    filter?: Uint8Array | string,
+    final?: boolean
+  ): Promise<Uint8Array[]>
+  readStorage(
+    address: string,
+    keys: Uint8Array[] | string[],
+    final?: boolean
+  ): Promise<Uint8Array[]>
+}
 
 /**
  * Defines the expected structure for a provider.
  */
-export type Provider = {
+export type Provider = PublicProvider & {
   /** Retrieves the account's address. */
   get address(): string
 
@@ -28,7 +50,6 @@ export type Provider = {
 
   /** Initiates a balance retrieval request for the account. */
   balance(final: boolean): Promise<bigint>
-  networkInfos(): Promise<Network>
   sign(
     data: Uint8Array | string,
     signOptions?: SignOptions
@@ -41,22 +62,6 @@ export type Provider = {
     opts?: OperationOptions
   ): Promise<Operation>
   callSC(params: CallSCParams): Promise<Operation>
-  readSC(params: ReadSCParams): Promise<ReadSCData>
   executeSC(params: ExecuteScParams): Promise<Operation>
   deploySC(params: DeploySCParams): Promise<SmartContract>
-  getOperationStatus(opId: string): Promise<OperationStatus>
-  getEvents(filter: EventFilter): Promise<t.OutputEvents>
-  getNodeStatus(): Promise<NodeStatusInfo>
-
-  /** Storage */
-  getStorageKeys(
-    address: string,
-    filter: Uint8Array | string,
-    final?: boolean
-  ): Promise<Uint8Array[]>
-  readStorage(
-    address: string,
-    keys: Uint8Array[] | string[],
-    final?: boolean
-  ): Promise<Uint8Array[]>
 }

src/provider/jsonRpcProvider/index.ts

@@ -0,0 +1,2 @@
+export * from './jsonRpcProvider'
+export * from './jsonRpcPublicProvider'