Computing JSDoc and SDK version update

Author: dimitrov-d

package.json

@@ -1,6 +1,6 @@
 {
   "name": "apillon-web3-tools",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Monorepo for Apillon tools",
   "author": "Apillon",
   "license": "MIT",

packages/sdk/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@apillon/sdk",
   "description": "▶◀ Apillon SDK for NodeJS ▶◀",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "author": "Apillon",
   "license": "MIT",
   "main": "./dist/index.js",

packages/sdk/src/docs-index.ts

@@ -3,6 +3,7 @@ export * from './types/nfts';
 export * from './types/hosting';
 export * from './types/storage';
 export * from './types/identity';
+export * from './types/computing';
 export * from './lib/apillon';
 export * from './modules/storage/storage';
 export * from './modules/storage/storage-bucket';
@@ -15,3 +16,5 @@ export * from './modules/hosting/hosting-website';
 export * from './modules/nft/nft';
 export * from './modules/nft/nft-collection';
 export * from './modules/identity/identity';
+export * from './modules/computing/computing';
+export * from './modules/computing/computing-contract';

packages/sdk/src/modules/computing/computing-contract.ts

@@ -97,7 +97,7 @@ export class ComputingContract extends ApillonModel {
   /**
    * Gets list of transactions for this computing contract.
    * @param {IApillonPagination} params Pagination filters.
-   * @returns List of transactions.
+   * @returns {IComputingTransaction[]} List of transactions.
    */
   public async listTransactions(
     params?: IApillonPagination,
@@ -132,7 +132,7 @@ export class ComputingContract extends ApillonModel {
    * - Uploads the encrypted file to the bucket
    * - Assigns the encrypted file's CID to the NFT used for decryption authentication
    * @param {IEncryptData} data The data to use for encryption.
-   * @returns The encrypted data in the form of a string.
+   * @returns The uploaded encrypted file metadata
    */
   async encryptFile(data: IEncryptData): Promise<FileMetadata[]> {
     ApillonLogger.log(`Encrypting file...`);

packages/sdk/src/modules/nft/nft-collection.ts

@@ -200,7 +200,7 @@ export class NftCollection extends ApillonModel {
    * Burns a nft.
    * @warn Can only burn NFTs if the collection is revokable.
    * @param tokenId Token ID of the NFT we want to burn.
-   * @returns Status.
+   * @returns Success status and transaction hash.
    */
   public async burn(tokenId: string): Promise<INftActionResponse> {
     if (this.isRevokable != null && !this.isRevokable) {
@@ -237,7 +237,7 @@ export class NftCollection extends ApillonModel {
   /**
    * Gets list of transactions that occurred on this collection through Apillon.
    * @param params Filters.
-   * @returns List of transactions.
+   * @returns {ITransaction[]} List of transactions.
    */
   public async listTransactions(
     params?: ITransactionFilters,

packages/sdk/src/types/computing.ts

@@ -22,10 +22,25 @@ export enum ComputingTransactionType {
 }
 
 export type ComputingContractData = {
+  /**
+   * Contract address of NFT which will be used to authenticate decryption
+   */
   nftContractAddress: string;
+  /**
+   * RPC URL of the chain the NFT collection exists on
+   */
   nftChainRpcUrl: string;
-  restrictToOwner: string;
+  /**
+   * If true, only the owner is able to use the contract for data encryption/decryption
+   */
+  restrictToOwner: boolean;
+  /**
+   * The IPFS gateway where the encrypted files are stored on
+   */
   ipfsGatewayUrl: string;
+  /**
+   * Identifier of the Phala computing cluster the contract runs on
+   */
   clusterId: string;
 };