feat: add timestamp to the base entity (DAP-4763) (#24)

Author: alsakhaev

libs/engine/src/app/services/base/base.entity.ts

@@ -6,6 +6,8 @@ export type EntityId = string
 
 export class Base {
   id: EntityId = ''
+  blockNumber: number = 0
+  timestamp: number = 0
 
   get authorId(): string {
     return this.id.split(KeyDelimiter)[0]

libs/engine/src/app/services/base/base.repository.ts

@@ -15,6 +15,7 @@ const RecursiveWildcardKey = '**'
 const KeyDelimiter = '/'
 const EmptyValue = ''
 const SelfKey = ''
+const BlockNumberKey = ':block'
 
 // ToDo:
 type EntityId = string
@@ -37,15 +38,16 @@ export class BaseRepository<T extends Base> {
     }
 
     const keys = [authorId, SettingsKey, ProjectIdKey, this._entityKey, localId]
-    const queryResult = await this.socialDb.get([
-      [...keys, RecursiveWildcardKey].join(KeyDelimiter),
-    ])
+    const queryResult = await this.socialDb.get(
+      [[...keys, RecursiveWildcardKey].join(KeyDelimiter)],
+      { withBlockHeight: true }
+    )
 
-    const item = SocialDbService.getValueByKey(keys, queryResult)
+    const itemWithMeta = SocialDbService.getValueByKey(keys, queryResult)
 
-    if (!item) return null
+    if (!itemWithMeta) return null
 
-    return this._makeItemFromSocialDb(id, item)
+    return this._makeItemFromSocialDb(id, itemWithMeta)
   }
 
   async getItems(options?: { authorId?: EntityId; localId?: EntityId }): Promise<T[]> {
@@ -55,16 +57,17 @@ export class BaseRepository<T extends Base> {
     const keys = [authorId, SettingsKey, ProjectIdKey, this._entityKey, localId]
 
     // ToDo: out of gas
-    const queryResult = await this.socialDb.get([
-      [...keys, RecursiveWildcardKey].join(KeyDelimiter),
-    ])
+    const queryResult = await this.socialDb.get(
+      [[...keys, RecursiveWildcardKey].join(KeyDelimiter)],
+      { withBlockHeight: true }
+    )
 
     const mutationsByKey = SocialDbService.splitObjectByDepth(queryResult, keys.length)
 
-    const items = Object.entries(mutationsByKey).map(([key, item]: [string, any]) => {
+    const items = Object.entries(mutationsByKey).map(([key, itemWithMeta]: [string, any]) => {
       const [accountId, , , , localMutationId] = key.split(KeyDelimiter)
       const itemId = [accountId, this._entityKey, localMutationId].join(KeyDelimiter)
-      return this._makeItemFromSocialDb(itemId, item)
+      return this._makeItemFromSocialDb(itemId, itemWithMeta)
     })
 
     return items
@@ -188,10 +191,14 @@ export class BaseRepository<T extends Base> {
     }
   }
 
-  private _makeItemFromSocialDb(id: EntityId, raw: Value): T {
+  private _makeItemFromSocialDb(id: EntityId, rawWithMeta: Value): T {
+    const raw = BaseRepository._clearObjectFromMeta(rawWithMeta)
     const entity = new this.EntityType()
 
     entity.id = id
+    entity.blockNumber = rawWithMeta[BlockNumberKey]
+    // ToDo: calculate it like localId and authorId?
+    entity.timestamp = this.socialDb.getTimestampByBlockHeight(entity.blockNumber)
 
     // for each property in the entity type get column metadata
 
@@ -282,4 +289,26 @@ export class BaseRepository<T extends Base> {
       ? 1 + Math.max(-1, ...Object.values(o).map((v) => BaseRepository._objectDepth(v)))
       : 0
   }
+
+  private static _removeBlockKeys(obj: Value): Value {
+    return typeof obj === 'object'
+      ? Object.fromEntries(
+          Object.entries(obj)
+            .filter(([key]) => key !== BlockNumberKey)
+            .map(([key, value]) => [key, this._removeBlockKeys(value)])
+        )
+      : obj
+  }
+
+  private static _replaceEmptyKeyWithValue(obj: Value): Value {
+    if (!obj || typeof obj !== 'object') return obj
+    if (Object.keys(obj).length === 1 && SelfKey in obj) return obj[SelfKey]
+    return Object.fromEntries(
+      Object.entries(obj).map(([key, value]) => [key, this._replaceEmptyKeyWithValue(value)])
+    )
+  }
+
+  private static _clearObjectFromMeta(obj: Value): Value {
+    return this._replaceEmptyKeyWithValue(this._removeBlockKeys(obj))
+  }
 }

libs/engine/src/app/services/near-signer/near-signer.service.ts

@@ -25,10 +25,10 @@ export class NearSigner {
   constructor(
     private _selector: WalletSelector,
     private _localDb: LocalDbService,
-    private _nearConfig: NearConfig
+    public nearConfig: NearConfig
   ) {
     this.provider = new nearAPI.providers.JsonRpcProvider({
-      url: _nearConfig.nodeUrl,
+      url: nearConfig.nodeUrl,
     })
   }
 
@@ -58,7 +58,7 @@ export class NearSigner {
   }
 
   async call(contractName: string, methodName: string, args: any, gas?: string, deposit?: string) {
-    if (contractName === this._nearConfig.contractName) {
+    if (contractName === this.nearConfig.contractName) {
       const account = await this._createConnectionForContract(contractName)
 
       // No session key for this contract
@@ -127,13 +127,13 @@ export class NearSigner {
 
     if (!loggedInAccountId) throw new Error('Not logged in')
 
-    const keyForContract = await keyStore.getKey(this._nearConfig.networkId, loggedInAccountId)
+    const keyForContract = await keyStore.getKey(this.nearConfig.networkId, loggedInAccountId)
 
     if (!keyForContract) return null
 
     const near = await nearAPI.connect({
       keyStore,
-      networkId: this._nearConfig.networkId,
+      networkId: this.nearConfig.networkId,
       nodeUrl: this.provider.connection.url,
       headers: {},
     })
@@ -206,7 +206,7 @@ export class NearSigner {
     })
 
     const keyStore = this._getKeyStoreForContract(contractName)
-    await keyStore.setKey(this._nearConfig.networkId, accountId, keyPair)
+    await keyStore.setKey(this.nearConfig.networkId, accountId, keyPair)
 
     localStorage.setItem(
       `${contractName}_wallet_auth_key`,

libs/engine/src/app/services/social-db/social-db.service.ts

@@ -12,6 +12,7 @@ export type StorageView = {
 export type Value = any
 
 const KeyDelimiter = '/'
+const BlockNumberKey = ':block'
 
 const EstimatedKeyValueSize = 40 * 3 + 8 + 12
 const EstimatedNodeSize = 40 * 2 + 8 + 10
@@ -109,8 +110,13 @@ export class SocialDbService {
     private _contractName: string
   ) {}
 
-  async get(keys: string[]): Promise<Value> {
-    return await this._signer.view(this._contractName, 'get', { keys })
+  async get(keys: string[], options: { withBlockHeight?: boolean } = {}): Promise<Value> {
+    return await this._signer.view(this._contractName, 'get', {
+      keys,
+      options: {
+        with_block_height: options.withBlockHeight,
+      },
+    })
   }
 
   async keys(keys: string[]): Promise<string[]> {
@@ -178,16 +184,20 @@ export class SocialDbService {
     )
   }
 
-  async setMultiple(data: Value[]): Promise<void> {
-    return this.set(mergeDeep({}, ...data))
-  }
-
   async delete(keys: string[]): Promise<void> {
     const data = await this.get(keys)
     const nullData = SocialDbService._nullifyData(data)
     await this.set(nullData)
   }
 
+  // ToDo: move to repository?
+  // ToDo: approximate timestamp
+  getTimestampByBlockHeight(blockHeight: number): number {
+    // ToDo: time reference was private, fix it
+    const { avgBlockTime, height, timestamp } = this._signer.nearConfig.timeReference
+    return (blockHeight - height) * avgBlockTime + timestamp
+  }
+
   private async _getAccountStorage(accountId: string): Promise<StorageView | null> {
     const resp = await this._signer.view(this._contractName, 'get_account_storage', {
       account_id: accountId,
@@ -239,6 +249,9 @@ export class SocialDbService {
 
     const result: any = {}
     for (const key in obj) {
+      // ToDo: should be it here?
+      if (key === BlockNumberKey) continue
+
       const newPath = [...path, key]
       const nestedResult = this.splitObjectByDepth(obj[key], depth - 1, newPath)
       for (const nestedKey in nestedResult) {

libs/engine/src/constants.ts

@@ -4,13 +4,20 @@ export type BuiltInLayoutManagers = {
   ear: string
 }
 
+export type TimeReference = {
+  timestamp: number
+  height: number
+  avgBlockTime: number
+}
+
 export type NearConfig = {
   networkId: string
   nodeUrl: string
   contractName: string
   walletUrl: string
   defaultMutationId: string
   layoutManagers: BuiltInLayoutManagers
+  timeReference: TimeReference
 }
 
 export const NearConfigs: { [networkId: string]: NearConfig } = {
@@ -25,6 +32,11 @@ export const NearConfigs: { [networkId: string]: NearConfig } = {
       horizontal: 'bos.dapplets.near/widget/DefaultLayoutManager',
       ear: 'bos.dapplets.near/widget/ContextActionsGroup',
     },
+    timeReference: {
+      timestamp: 1727135249210,
+      height: 128753799,
+      avgBlockTime: 1250, // https://nearblocks.io/
+    },
   },
   testnet: {
     networkId: 'testnet',
@@ -37,6 +49,11 @@ export const NearConfigs: { [networkId: string]: NearConfig } = {
       horizontal: 'bos.dapplets.testnet/widget/DefaultLayoutManager',
       ear: 'bos.dapplets.testnet/widget/ContextActionsGroup',
     },
+    timeReference: {
+      timestamp: 1727135126349,
+      height: 175046986,
+      avgBlockTime: 1000, // https://testnet.nearblocks.io/
+    },
   },
 }