Merge pull request #373 from autonomys/feat/improve-user-session

Feat: Improve user session

Author: marc-aurele-besner

packages/utility/user-session/.env.sample

@@ -0,0 +1,5 @@
+RPC_URL="https://auto-evm.taurus.autonomys.xyz/ws"
+PRIVATE_KEY=""
+
+BLOCKSCOUT_API="https://blockscout.taurus.autonomys.xyz/api"
+CONTRACT_ADDRESS=""

packages/utility/user-session/package.json

@@ -31,6 +31,7 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
+    "@autonomys/asynchronous": "^1.4.17",
     "@autonomys/auto-dag-data": "^1.4.17",
     "@autonomys/auto-drive": "^1.4.17",
     "ethers": "6.13.5"

packages/utility/user-session/scripts/UserSession.s.sol

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.28;
+
+import { Script } from "forge-std/Script.sol";
+import { UserSession } from "../src/UserSession.sol";
+import { console } from "forge-std/console.sol";
+
+contract DeployScript is Script {
+    function setUp() public {}
+
+    function run() public returns (UserSession) {
+        // Log deployment info
+        console.log("Deploying UserSession contract");
+        console.log("Deployer address:", msg.sender);
+        console.log("Chain ID:", block.chainid);
+
+        // Begin sending transactions
+        vm.startBroadcast();
+
+        // Deploy UserSession contract
+        UserSession userSession = new UserSession();
+        console.log("UserSession deployed to:", address(userSession));
+
+        // Stop sending transactions
+        vm.stopBroadcast();
+
+        return userSession;
+    }
+}

packages/utility/user-session/scripts/deploy-UserSession.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# Load environment variables from .env file
+if [ -f .env ]; then
+    source .env
+else
+    echo "Error: .env file not found in the contracts directory"
+    exit 1
+fi
+
+# Check if required environment variables are set
+if [ -z "$RPC_URL" ] || [ -z "$PRIVATE_KEY" ]; then
+    echo "Error: RPC_URL and PRIVATE_KEY must be set in .env file"
+    exit 1
+fi
+
+forge script scripts/UserSession.s.sol:DeployScript \
+            --rpc-url $RPC_URL \
+            --private-key $PRIVATE_KEY \
+            --evm-version london \
+            --via-ir \
+            --broadcast

packages/utility/user-session/scripts/verify-UserSession.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# Load environment variables from .env file
+if [ -f .env ]; then
+    source .env
+else
+    echo "Error: .env file not found in the contracts directory"
+    exit 1
+fi
+
+# Check if required environment variables are set
+if [ -z "$CONTRACT_ADDRESS" ] || [ -z "$BLOCKSCOUT_API" ]; then
+    echo "Error: CONTRACT_ADDRESS and BLOCKSCOUT_API must be set in .env file"
+    exit 1
+fi
+
+forge verify-contract \
+            --verifier blockscout \
+            --verifier-url $BLOCKSCOUT_API \
+            --evm-version london --chain 490000 --compiler-version 0.8.28 \
+            --watch \
+            $CONTRACT_ADDRESS \
+            src/UserSession.sol:UserSession

packages/utility/user-session/src/types/index.ts

@@ -5,6 +5,7 @@ export type ContractOptions = {
   address: string
   privateKey: string
   rpcUrl: string
+  waitReceipt?: boolean
 }
 
 export type DataOptions = {
@@ -36,6 +37,7 @@ export type SaveDataParams<T> = {
   fileName?: string
   password?: string
   showLogs?: boolean
+  waitReceipt?: boolean
 }
 
 export type SaveDataResult = {

packages/utility/user-session/src/utils/data.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
+import { asyncIterableToBuffer } from '@autonomys/asynchronous'
 import { GetDataParams, GetDataResult, SaveDataParams, SaveDataResult } from '../types'
 import { userIdHash, userSessionCIDFromHash, userSessionCIDHash } from './hash'
 
@@ -13,7 +14,10 @@ const logger = (
 export const get = async <T>(params: GetDataParams): Promise<GetDataResult<T>> => {
   const { autoDriveApi, contract, userId } = params
   try {
-    const userSession = await contract.getUserSession(userIdHash(userId))
+    logger(params, 'userId:', userId)
+    const hash = userIdHash(userId)
+    logger(params, 'hash:', hash)
+    const userSession = await contract.getUserSession(hash)
     logger(params, 'userSession:', userSession)
 
     if (!userSession || userSession === '0x') {
@@ -26,20 +30,8 @@ export const get = async <T>(params: GetDataParams): Promise<GetDataResult<T>> =
 
     logger(params, `Downloading file: ${cid}`)
     const stream = await autoDriveApi.downloadFile(cid, params.password)
-
-    const chunks: Uint8Array[] = []
-    for await (const chunk of stream) {
-      chunks.push(chunk)
-    }
-
-    const allChunks = new Uint8Array(chunks.reduce((acc, chunk) => acc + chunk.length, 0))
-    let position = 0
-    for (const chunk of chunks) {
-      allChunks.set(chunk, position)
-      position += chunk.length
-    }
-
-    const jsonString = new TextDecoder().decode(allChunks)
+    const buffer = await asyncIterableToBuffer(stream)
+    const jsonString = new TextDecoder().decode(buffer)
     const data = JSON.parse(jsonString)
     logger(params, 'data-decoded:', data)
 
@@ -54,17 +46,28 @@ export const get = async <T>(params: GetDataParams): Promise<GetDataResult<T>> =
 }
 
 export const save = async <T>(params: SaveDataParams<T>): Promise<SaveDataResult> => {
-  const { autoDriveApi, contract, userId, data } = params
+  const { autoDriveApi, contract, userId, data, waitReceipt } = params
 
   const options = params.password ? { password: params.password } : undefined
   const cid = await autoDriveApi.uploadObjectAsJSON(data, params.fileName, options)
   logger(params, 'CID:', cid)
 
-  const tx = await contract.setUserSession(userIdHash(userId), userSessionCIDHash(cid))
+  logger(params, 'userId:', userId)
+  const hash = userIdHash(userId)
+  logger(params, 'hash:', hash)
+
+  const cidHash = userSessionCIDHash(cid)
+  logger(params, 'cidHash:', cidHash)
+
+  const tx = await contract.setUserSession(hash, cidHash)
   logger(params, 'userSession:', tx)
 
-  const txHash = await tx.wait()
-  logger(params, 'txHash:', txHash)
+  let txHash = tx.hash
+  if (waitReceipt) {
+    const txReceipt = await tx.wait()
+    logger(params, 'txReceipt:', txReceipt)
+    txHash = txReceipt.transactionHash
+  }
 
   return {
     cid,

packages/utility/user-session/src/utils/hash.ts

@@ -8,7 +8,12 @@ import { hexlify, keccak256, toUtf8Bytes, zeroPadValue } from 'ethers'
 
 export const userIdHash = (userId: string) => keccak256(toUtf8Bytes(userId))
 
-export const userSessionCIDHash = (CID: string) =>
-  zeroPadValue(hexlify(blake3HashFromCid(stringToCid(CID))), 32)
+export const userSessionCIDHash = (CID: string) => {
+  const blake3Hash = blake3HashFromCid(stringToCid(CID))
+  return zeroPadValue(hexlify(blake3Hash), 32)
+}
 
-export const userSessionCIDFromHash = (hash: Buffer) => cidToString(cidFromBlakeHash(hash))
+export const userSessionCIDFromHash = (hash: string) => {
+  const hashBuffer = Buffer.from(hash.slice(2), 'hex')
+  return cidToString(cidFromBlakeHash(hashBuffer))
+}

packages/utility/user-session/src/utils/index.ts

@@ -25,6 +25,7 @@ export const UserSession = <T>(options: UsersSessionOptions) => {
       fileName: options.fileName,
       password: options.password,
       showLogs: options.showLogs,
+      waitReceipt: options.waitReceipt,
     })
 
   return {

yarn.lock

@@ -215,6 +215,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@autonomys/user-session@workspace:packages/utility/user-session"
   dependencies:
+    "@autonomys/asynchronous": "npm:^1.4.17"
     "@autonomys/auto-dag-data": "npm:^1.4.17"
     "@autonomys/auto-drive": "npm:^1.4.17"
     eslint: "npm:^9.23.0"