Merge pull request #1611 from Phala-Network/sdk-adds-blocknum-in-query-response

SDK: Adds blocknum in query response

Author: h4x3rotab

frontend/packages/sdk/scripts/build_proto.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 downloadProto() {
   echo "Downloading $1.proto…"
-  curl -o "proto/$1.proto" "https://raw.githubusercontent.com/Phala-Network/prpc-protos/master/$1.proto"
+  curl -o "proto/$1.proto" "https://raw.githubusercontent.com/Phala-Network/phala-blockchain/master/crates/phactory/api/proto/$1.proto"
 }
 
 rm -rf proto

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

@@ -21,6 +21,7 @@ export type EstimateContractParameters<T> = SendPinkQueryParameters<T> & {
 
 export type EstimateContractResult = Omit<ContractCallOutcome, 'output'> & {
   request: SendPinkCommandParameters
+  blockNum: number
 }
 
 export async function estimateContract(
@@ -45,7 +46,7 @@ export async function estimateContract(
 
   const cert = await provider.signCertificate()
 
-  const [clusterBalance, onchainBalance, inkResponse] = await Promise.all([
+  const [clusterBalance, onchainBalance, [inkResponse, blockNum]] = await Promise.all([
     client.getClusterBalance(provider.address),
     client.api.query.system.account<FrameSystemAccountInfo>(provider.address),
     pinkQuery(client.phactory, argument, inkMessage.toHex(), cert),
@@ -95,5 +96,6 @@ export async function estimateContract(
       gasLimit,
       deposit: autoDeposit,
     },
+    blockNum,
   }
 }

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

@@ -19,7 +19,7 @@ export type SendPinkQueryParameters<TArgs = any[]> = {
 export async function sendPinkQuery<TResult extends Codec = Codec>(
   client: OnChainRegistry,
   parameters: SendPinkQueryParameters
-): Promise<TResult | null> {
+): Promise<(TResult & { blockNum: number }) | null> {
   const { address, functionName, provider } = parameters
   if (!client.workerInfo?.pubkey) {
     throw new Error('Worker pubkey not found')
@@ -37,7 +37,7 @@ export async function sendPinkQuery<TResult extends Codec = Codec>(
   const argument = new WorkerAgreementKey(client.workerInfo.pubkey)
 
   const cert = await provider.signCertificate()
-  const inkResponse = await pinkQuery(client.phactory, argument, inkMessage.toHex(), cert)
+  const [inkResponse, blockNum] = await pinkQuery(client.phactory, argument, inkMessage.toHex(), cert)
 
   if (inkResponse.result.isErr) {
     // @FIXME: not sure this is enough as not yet tested
@@ -55,11 +55,13 @@ export async function sendPinkQuery<TResult extends Codec = Codec>(
     throw new Error(`ContractExecResult Error: ${result.asErr.toString()}`)
   }
   if (message.returnType) {
-    return abi.registry.createTypeUnsafe<TResult>(
+    const obj = abi.registry.createTypeUnsafe<TResult>(
       message.returnType.lookupName || message.returnType.type,
       [result.asOk.data.toU8a(true)],
       { isPedantic: true }
-    )
+    ) as TResult & { blockNum: number }
+    obj.blockNum = blockNum
+    return obj
   }
   return null
 }

frontend/packages/sdk/src/contracts/PinkBlueprint.ts

@@ -43,6 +43,7 @@ interface MapMessageInkQuery<ApiType extends ApiTypes> {
 
 interface PinkContractInstantiateResult extends ContractInstantiateResult {
   salt: string
+  blockNum: number
 }
 
 export interface PinkInstantiateQueryOptions {
@@ -326,7 +327,7 @@ export class PinkBlueprintPromise {
         options.deposit,
         options.transfer
       )
-      const response = await pinkQuery(this.phatRegistry.phactory, agreement, payload.toHex(), cert)
+      const [response, blockNum] = await pinkQuery(this.phatRegistry.phactory, agreement, payload.toHex(), cert)
       if (response.result.isErr) {
         return phalaTypes.createType<InkQueryError>('InkQueryError', response.result.asErr.toHex())
       }
@@ -345,6 +346,7 @@ export class PinkBlueprintPromise {
         throw new Error('Estimation failed: ' + JSON.stringify(result.result.asErr.toHuman()))
       }
 
+      ;(result as PinkContractInstantiateResult).blockNum = blockNum
       return result
     }
 

frontend/packages/sdk/src/contracts/PinkContract.ts

@@ -29,6 +29,7 @@ import signAndSend from '../utils/signAndSend'
 
 export type PinkContractCallOutcome<ResultType> = {
   output: ResultType
+  blocknum: number
 } & Omit<ContractCallOutcome, 'output'>
 
 export interface ILooseResult<O, E extends Codec = Codec> extends IEnum {
@@ -469,7 +470,9 @@ export class PinkContractPromise<
 
     const agreement = new WorkerAgreementKey(this.phatRegistry.remotePubkey!)
 
-    const inkQueryInternal = async (origin: string | AccountId | Uint8Array): Promise<ContractCallOutcome> => {
+    const inkQueryInternal = async (
+      origin: string | AccountId | Uint8Array
+    ): Promise<ContractCallOutcome & { blocknum: number }> => {
       if (typeof origin === 'string') {
         assert(origin === cert.address, 'origin must be the same as the certificate address')
       } else if (origin.hasOwnProperty('verify') && origin.hasOwnProperty('adddress')) {
@@ -485,7 +488,7 @@ export class PinkContractPromise<
         options.transfer,
         options.estimating !== undefined ? !!options.estimating : isEstimating
       )
-      const inkResponse = await pinkQuery(this.phatRegistry.phactory, agreement, payload.toHex(), cert)
+      const [inkResponse, blocknum] = await pinkQuery(this.phatRegistry.phactory, agreement, payload.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()}`)
@@ -511,6 +514,7 @@ export class PinkContractPromise<
               )
             : null,
         result,
+        blocknum,
         storageDeposit,
       }
     }

frontend/packages/sdk/src/contracts/PinkLoggerContract.ts

@@ -192,7 +192,7 @@ function sidevmQueryWithReader({ phactory, remotePubkey, address, cert }: Sidevm
   return async function unsafeRunSidevmQuery<T>(sidevmMessage: Record<string, any>): Promise<T> {
     const encodedQuery = InkQuerySidevmMessage(address, sidevmMessage)
     const agreement = new WorkerAgreementKey(remotePubkey)
-    const inkResponse = await pinkQuery(phactory, agreement, encodedQuery.toHex(), cert)
+    const [inkResponse, _] = await pinkQuery(phactory, agreement, encodedQuery.toHex(), cert)
     if (inkResponse.result.isErr) {
       let error = `[${inkResponse.result.asErr.index}] ${inkResponse.result.asErr.type}`
       if (inkResponse.result.asErr.type === 'RuntimeError') {

frontend/packages/sdk/src/pruntime/pinkQuery.ts

@@ -28,7 +28,7 @@ export async function pinkQuery(
   agreement: WorkerAgreementKey,
   encodedQuery: string,
   { certificate, pubkey, secret }: CertificateData
-): Promise<InkResponse> {
+): Promise<[InkResponse, number]> {
   // Encrypt the ContractQuery.
   const encryptedData = createEncryptedData(agreement.publicKey, encodedQuery, agreement.agreementKey)
   const encodedEncryptedData = phalaTypes.createType('EncryptedData', encryptedData).toU8a()
@@ -50,5 +50,7 @@ export async function pinkQuery(
 
   const { data: encryptedResult, iv } = phalaTypes.createType<IEncryptedData>('EncryptedData', res.encodedEncryptedData)
   const data = hexAddPrefix(decrypt(encryptedResult.toString(), agreement.agreementKey, iv))
-  return phalaTypes.createType<InkResponse>('InkResponse', data)
+  const resp = phalaTypes.createType<InkResponse>('InkResponse', data)
+  const blocknum = res.blocknum
+  return [resp, blocknum]
 }

frontend/packages/sdk/src/pruntime/proto/index.d.ts

@@ -952,6 +952,9 @@ export namespace pruntime_rpc {
 
         /** PhactoryInfo maxSupportedPinkRuntimeVersion */
         maxSupportedPinkRuntimeVersion?: (string|null);
+
+        /** PhactoryInfo supportedAttestationMethods */
+        supportedAttestationMethods?: (string[]|null);
     }
 
     /** Represents a PhactoryInfo. */
@@ -1029,6 +1032,9 @@ export namespace pruntime_rpc {
         /** PhactoryInfo maxSupportedPinkRuntimeVersion. */
         public maxSupportedPinkRuntimeVersion: string;
 
+        /** PhactoryInfo supportedAttestationMethods. */
+        public supportedAttestationMethods: string[];
+
         /** PhactoryInfo _genesisBlockHash. */
         public _genesisBlockHash?: "genesisBlockHash";
 
@@ -2277,6 +2283,9 @@ export namespace pruntime_rpc {
 
         /** ContractQueryResponse encodedEncryptedData */
         encodedEncryptedData?: (Uint8Array|null);
+
+        /** ContractQueryResponse blocknum */
+        blocknum?: (number|null);
     }
 
     /** Represents a ContractQueryResponse. */
@@ -2291,6 +2300,9 @@ export namespace pruntime_rpc {
         /** ContractQueryResponse encodedEncryptedData. */
         public encodedEncryptedData: Uint8Array;
 
+        /** ContractQueryResponse blocknum. */
+        public blocknum: number;
+
         /**
          * Creates a new ContractQueryResponse instance using the specified properties.
          * @param [properties] Properties to set
@@ -3114,8 +3126,14 @@ export namespace pruntime_rpc {
         /** ClusterInfo stateRoot */
         stateRoot?: (string|null);
 
-        /** ClusterInfo contracts */
-        contracts?: (string[]|null);
+        /** ClusterInfo systemContract */
+        systemContract?: (string|null);
+
+        /** ClusterInfo loggerContract */
+        loggerContract?: (string|null);
+
+        /** ClusterInfo numberOfContracts */
+        numberOfContracts?: (number|Long|null);
     }
 
     /** Represents a ClusterInfo. */
@@ -3136,8 +3154,14 @@ export namespace pruntime_rpc {
         /** ClusterInfo stateRoot. */
         public stateRoot: string;
 
-        /** ClusterInfo contracts. */
-        public contracts: string[];
+        /** ClusterInfo systemContract. */
+        public systemContract: string;
+
+        /** ClusterInfo loggerContract. */
+        public loggerContract: string;
+
+        /** ClusterInfo numberOfContracts. */
+        public numberOfContracts: (number|Long);
 
         /**
          * Creates a new ClusterInfo instance using the specified properties.