JS-SDK: 0.6.x release channel

frontend/packages/sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phala/sdk",
-  "version": "0.5.10",
+  "version": "0.6.0-beta.19",
   "description": "Phala Phat Contract JS SDK",
   "license": "Apache-2.0",
   "author": [
@@ -9,7 +9,7 @@
   "homepage": "https://github.com/Phala-Network/phala-blockchain/tree/master/frontend/packages/sdk#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/Phala-Network/phala-blockchain.git",
+    "url": "git+https://github.com/Phala-Network/phala-blockchain.git",
     "directory": "frontend/packages/sdk"
   },
   "bugs": {
@@ -55,16 +55,22 @@
     "test:ci": "vitest --run"
   },
   "dependencies": {
-    "@polkadot/api": "^10.9.1",
-    "@polkadot/api-contract": "^10.9.1",
-    "@polkadot/keyring": "^12.3.2",
-    "@polkadot/types": "^10.9.1",
-    "@polkadot/types-augment": "^10.9.1",
-    "@polkadot/util": "^12.3.2",
-    "@polkadot/util-crypto": "^12.3.2",
+    "@polkadot/api": "~10.11.1",
+    "@polkadot/api-contract": "~10.11.1",
+    "@polkadot/types": "~10.11.1",
+    "@polkadot/types-codec": "~10.11.1",
+    "@polkadot/types-augment": "~10.11.1",
+    "@polkadot/networks": "~12.6.1",
+    "@polkadot/keyring": "~12.6.1",
+    "@polkadot/util": "~12.6.1",
+    "@polkadot/util-crypto": "~12.6.1",
+    "@polkadot/extension-inject": "~0.46.6",
+    "@polkadot/ui-keyring": "~3.6.4",
+    "@polkadot/ui-settings": "~3.6.4",
     "browserify-cipher": "^1.0.1",
     "cross-fetch": "^4.0.0",
     "protobufjs": "^7.2.4",
+    "ramda": "^0.29.1",
     "randombytes": "^2.1.0",
     "rxjs": "^7.8.1",
     "viem": "^1.5.0"
@@ -73,6 +79,7 @@
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
     "@types/node": "^20.4.1",
+    "@types/ramda": "^0.29.9",
     "@typescript-eslint/eslint-plugin": "^6.6.0",
     "@typescript-eslint/parser": "^6.6.0",
     "@vitest/coverage-v8": "^0.34.4",
@@ -96,7 +103,7 @@
     "vitest": "^0.34.6"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18.14"
   },
   "prettier": {
     "semi": false,

frontend/packages/sdk/src/OnChainRegistry.ts

@@ -1,6 +1,5 @@
 import { type ApiPromise, Keyring } from '@polkadot/api'
 import { type KeyringPair } from '@polkadot/keyring/types'
-import type { Result, U64 } from '@polkadot/types'
 import { Enum, Map, Option, Text, U8aFixed, Vec } from '@polkadot/types'
 import { AccountId } from '@polkadot/types/interfaces'
 import { BN } from '@polkadot/util'
@@ -9,9 +8,11 @@ import systemAbi from './abis/system.json'
 import { PinkContractPromise } from './contracts/PinkContract'
 import { PinkLoggerContractPromise } from './contracts/PinkLoggerContract'
 import { type PhalaTypesVersionedWorkerEndpoints, ackFirst } from './ha/ack-first'
+import { KeyringPairProvider } from './providers/KeyringPairProvider'
 import { type CertificateData, signCertificate } from './pruntime/certificate'
 import createPruntimeClient from './pruntime/createPruntimeClient'
 import { pruntime_rpc } from './pruntime/proto'
+import type { SystemContract } from './types'
 
 export class UnexpectedEndpointError extends Error {}
 
@@ -85,7 +86,7 @@ export class OnChainRegistry {
   #alice: KeyringPair | undefined
   #cert: CertificateData | undefined
 
-  #systemContract: PinkContractPromise | undefined
+  #systemContract: SystemContract | undefined
   #loggerContract: PinkLoggerContractPromise | undefined
 
   constructor(api: ApiPromise) {
@@ -113,7 +114,7 @@ export class OnChainRegistry {
   }
 
   get phactory() {
-    if (!this.#ready || !this.#phactory) {
+    if (!this.#phactory) {
       throw new Error('You need initialize OnChainRegistry first.')
     }
     return this.#phactory
@@ -183,11 +184,14 @@ export class OnChainRegistry {
   public async getClusterInfoById(clusterId: string) {
     const result = (await this.api.query.phalaPhatContracts.clusters(clusterId)) as Option<ClusterInfo>
     if (result.isNone) {
-      return null
+      return undefined
     }
     return result.unwrap()
   }
 
+  /**
+   * @deprecated
+   */
   public async getClusters(clusterId?: string) {
     if (clusterId) {
       const result = (await this.api.query.phalaPhatContracts.clusters(clusterId)) as Option<ClusterInfo>
@@ -200,6 +204,9 @@ export class OnChainRegistry {
     }
   }
 
+  /**
+   * @deprecated
+   */
   public async getEndpoints(workerId?: U8aFixed | string) {
     if (workerId) {
       if (typeof workerId !== 'string') {
@@ -214,6 +221,9 @@ export class OnChainRegistry {
     })
   }
 
+  /**
+   * @deprecated
+   */
   public async getClusterWorkers(clusterId?: string): Promise<WorkerInfo[]> {
     let _clusterId = clusterId || this.clusterId
     if (!_clusterId) {
@@ -264,8 +274,16 @@ export class OnChainRegistry {
     if (systemContractId) {
       const systemContractKey = await this.getContractKey(systemContractId)
       if (systemContractKey) {
-        this.#systemContract = new PinkContractPromise(this.api, this, systemAbi, systemContractId, systemContractKey)
-        this.#loggerContract = await PinkLoggerContractPromise.create(this.api, this, this.#systemContract)
+        const provider = await KeyringPairProvider.create(this.api, this.alice)
+        this.#systemContract = new PinkContractPromise(
+          this.api,
+          this,
+          systemAbi,
+          systemContractId,
+          systemContractKey,
+          provider
+        )
+        this.#loggerContract = await PinkLoggerContractPromise.create(this)
       } else {
         throw new Error(`System contract not found: ${systemContractId}`)
       }
@@ -311,8 +329,8 @@ export class OnChainRegistry {
             v1: [endpoint],
           },
         }
-        this.#ready = true
         await this.prepareSystemOrThrows(clusterInfo)
+        this.#ready = true
         return
       }
 
@@ -361,8 +379,8 @@ export class OnChainRegistry {
                 v1: [phactory.endpoint],
               },
             }
-            this.#ready = true
             await this.prepareSystemOrThrows(clusterInfo)
+            this.#ready = true
           } else {
             throw new Error(`Unknown strategy: ${args[0].strategy}`)
           }
@@ -406,8 +424,8 @@ export class OnChainRegistry {
               default: pruntimeURL,
             },
           }
-          this.#ready = true
           await this.prepareSystemOrThrows(clusterInfo)
+          this.#ready = true
         } else {
           const worker = args[0] as WorkerInfo
           const clusterInfo = await this.getClusterInfoById(worker.clusterId)
@@ -418,8 +436,8 @@ export class OnChainRegistry {
           this.clusterId = worker.clusterId
           this.clusterInfo = clusterInfo
           this.workerInfo = worker
-          this.#ready = true
           await this.prepareSystemOrThrows(clusterInfo)
+          this.#ready = true
         }
         return
       }
@@ -509,8 +527,16 @@ export class OnChainRegistry {
     if (systemContractId) {
       const systemContractKey = await this.getContractKey(systemContractId)
       if (systemContractKey) {
-        this.#systemContract = new PinkContractPromise(this.api, this, systemAbi, systemContractId, systemContractKey)
-        this.#loggerContract = await PinkLoggerContractPromise.create(this.api, this, this.#systemContract)
+        const provider = await KeyringPairProvider.create(this.api, this.alice)
+        this.#systemContract = new PinkContractPromise(
+          this.api,
+          this,
+          systemAbi,
+          systemContractId,
+          systemContractKey,
+          provider
+        )
+        this.#loggerContract = await PinkLoggerContractPromise.create(this)
       } else {
         throw new Error(`System contract not found: ${systemContractId}`)
       }
@@ -556,12 +582,12 @@ export class OnChainRegistry {
       system.query['system::freeBalanceOf'](cert.address, { cert }, address),
     ])
     return {
-      total: (totalBalanceOf as Result<U64, any>).asOk.toBn(),
-      free: (freeBalanceOf as Result<U64, any>).asOk.toBn(),
+      total: totalBalanceOf.asOk,
+      free: freeBalanceOf.asOk,
     }
   }
 
-  transferToCluster(address: string | AccountId, amount: number | string | BN) {
+  transferToCluster(address: string | AccountId, amount: number | string | BN | bigint) {
     return this.api.tx.phalaPhatContracts.transferToCluster(amount, this.clusterId, address)
   }
 
@@ -579,4 +605,8 @@ export class OnChainRegistry {
   get pruntimeURL() {
     return this.workerInfo?.endpoints.default
   }
+
+  get isEvmAccountMappingSupported() {
+    return !!this.api.consts?.evmAccountMapping?.eip712Name
+  }
 }

frontend/packages/sdk/src/abis/fetchers.ts

@@ -1,13 +1,13 @@
 import { type Bool } from '@polkadot/types'
 import fetch from 'cross-fetch'
-import { type PinkContractPromise } from '../contracts/PinkContract'
 import { type OnChainRegistry } from '../OnChainRegistry'
 import { type CertificateData } from '../pruntime/certificate'
+import { type SystemContract } from '../types'
 
 const OFFICIAL_ARTIFACTS_URL = 'https://phala-network.github.io/phat-contract-artifacts'
 
 export interface CheckCodeHashExistsEnv {
-  systemContract: PinkContractPromise
+  systemContract: SystemContract
   cert: CertificateData
 }
 

frontend/packages/sdk/src/actions/estimateContract.ts

@@ -0,0 +1,99 @@
+import { convertWeight } from '@polkadot/api-contract/base/util'
+import type { ContractCallOutcome } from '@polkadot/api-contract/types'
+import type { ContractExecResult } from '@polkadot/types/interfaces'
+import { BN_ZERO } from '@polkadot/util'
+import type { OnChainRegistry } from '../OnChainRegistry'
+import { phalaTypes } from '../options'
+import { InkQueryMessage } from '../pruntime/coders'
+import { pinkQuery } from '../pruntime/pinkQuery'
+import { WorkerAgreementKey } from '../pruntime/WorkerAgreementKey'
+import type { FrameSystemAccountInfo, LooseNumber } from '../types'
+import { toAbi } from '../utils/abi/toAbi'
+import { BN_MAX_SUPPLY } from '../utils/constants'
+import { SendPinkCommandParameters } from './sendPinkCommand'
+import { SendPinkQueryParameters } from './sendPinkQuery'
+
+export type EstimateContractParameters<T> = SendPinkQueryParameters<T> & {
+  contractKey: string
+  deposit?: LooseNumber
+  transfer?: LooseNumber
+}
+
+export type EstimateContractResult = Omit<ContractCallOutcome, 'output'> & {
+  request: SendPinkCommandParameters
+}
+
+export async function estimateContract(
+  client: OnChainRegistry,
+  parameters: EstimateContractParameters<any[]>
+): Promise<EstimateContractResult> {
+  const { address, functionName, provider, deposit, transfer } = parameters
+  if (!client.workerInfo?.pubkey) {
+    throw new Error('Worker pubkey not found')
+  }
+
+  const abi = toAbi(parameters.abi)
+  const args = parameters.args || []
+
+  const message = abi.findMessage(functionName)
+  if (!message) {
+    throw new Error(`Message not found: ${functionName}`)
+  }
+  const encodedArgs = message.toU8a(args)
+  const inkMessage = InkQueryMessage(address, encodedArgs, deposit || BN_MAX_SUPPLY, transfer, true)
+  const argument = new WorkerAgreementKey(client.workerInfo.pubkey)
+
+  const cert = await provider.signCertificate()
+
+  const [clusterBalance, onchainBalance, inkResponse] = await Promise.all([
+    client.getClusterBalance(provider.address),
+    client.api.query.system.account<FrameSystemAccountInfo>(provider.address),
+    pinkQuery(client.phactory, argument, inkMessage.toHex(), cert),
+  ])
+
+  if (inkResponse.result.isErr) {
+    // @FIXME: not sure this is enough as not yet tested
+    throw new Error(`InkResponse Error: ${inkResponse.result.asErr.toString()}`)
+  }
+  if (!inkResponse.result.asOk.isInkMessageReturn) {
+    // @FIXME: not sure this is enough as not yet tested
+    throw new Error(`Unexpected InkMessageReturn: ${inkResponse.result.asOk.toJSON()?.toString()}`)
+  }
+  const { debugMessage, gasConsumed, gasRequired, result, storageDeposit } = phalaTypes.createType<ContractExecResult>(
+    'ContractExecResult',
+    inkResponse.result.asOk.asInkMessageReturn.toString()
+  )
+
+  const { gasPrice } = client.clusterInfo ?? {}
+  if (!gasPrice) {
+    throw new Error('No Gas Price or deposit Per Byte from cluster info.')
+  }
+
+  // calculate the total costs
+  const gasLimit = gasRequired.refTime.toBn()
+  const storageDepositFee = storageDeposit.isCharge ? storageDeposit.asCharge.toBn() : BN_ZERO
+  const minRequired = gasLimit.mul(gasPrice).add(storageDepositFee)
+
+  // Auto deposit.
+  let autoDeposit = undefined
+  if (clusterBalance.free.lt(minRequired)) {
+    const deposit = minRequired.sub(clusterBalance.free)
+    if (onchainBalance.data.free.lt(deposit)) {
+      throw new Error(`Not enough balance to pay for gas and storage deposit: ${minRequired.toNumber()}`)
+    }
+    autoDeposit = deposit
+  }
+
+  return {
+    debugMessage: debugMessage,
+    gasConsumed: gasConsumed,
+    gasRequired: gasRequired && !convertWeight(gasRequired).v1Weight.isZero() ? gasRequired : gasConsumed,
+    result,
+    storageDeposit,
+    request: {
+      ...parameters,
+      gasLimit,
+      deposit: autoDeposit,
+    },
+  }
+}