Class ComputingContract

Hierarchy (view full)

ApillonModel
- ComputingContract

Constructors

constructor

new ComputingContract(uuid, data?, config?): ComputingContract
Constructor which should only be called via Computing class.
Parameters
- uuid: string
  Unique identifier of the contract.
- Optional data: Partial<ComputingContract>
  Data to populate computing contract with.
- Optional config: ApillonConfig
Returns ComputingContract
Overrides ApillonModel.constructor
- Defined in modules/computing/computing-contract.ts:75

Properties

name

name: string = null

Name of the contract.

description

description: string = null

Contract description.

bucketUuid

bucketUuid: string = null

The bucket where files encrypted by this contract are stored

contractType

contractType: SCHRODINGER = null

The computing contract's type

contractStatus

contractStatus: ComputingContractStatus = null

The computing contract's status

contractAddress

contractAddress: string = null

The computing contract's on-chain address

deployerAddress

deployerAddress: string = null

The computing contract's on-chain deployer address

transactionHash

transactionHash: string = null

The computing contract's deployment transaction hash

data

data: ComputingContractData = null

The computing contract's additional data

`Private` config

config: ApillonConfig

Apillon config used to initialize a storage module for saving encrypted files

`Protected` API_PREFIX

API_PREFIX: string = null

API url prefix for this class.

uuid

uuid: string

Unique identifier of the model.

createTime

createTime: string = null

The object's creation date

updateTime

updateTime: string = null

The date when the object was last updated

Methods

listTransactions

listTransactions(params?): Promise<IApillonList<IComputingTransaction>>
Gets list of transactions for this computing contract.
Parameters
- Optional params: ITransactionListFilters
  Query filters.
Returns Promise<IApillonList<IComputingTransaction>>
List of transactions.
- Defined in modules/computing/computing-contract.ts:91

transferOwnership

transferOwnership(accountAddress): Promise<boolean>
Transfers ownership of the computing contract.
Parameters
- accountAddress: string
  The address of the new owner.
Returns Promise<boolean>
Success status
- Defined in modules/computing/computing-contract.ts:106

encryptFile

encryptFile(data): Promise<FileUploadResult[]>
- Calls the encrypt method on the computing contract
- Uploads the encrypted file to the bucket
- Assigns the encrypted file's CID to the NFT used for decryption authentication
Parameters
- data: IEncryptData
  The data to use for encryption.
Returns Promise<FileUploadResult[]>
The uploaded encrypted file metadata
- Defined in modules/computing/computing-contract.ts:126

`Private` assignCidToNft

assignCidToNft(data): Promise<boolean>
Assigns a CID to an NFT on the contract.
Parameters
- data: {
  cid: string;
  nftId: number;
  }
  The payload for assigning a CID to an NFT
  - cid: string
  - nftId: number
Returns Promise<boolean>
Success status
- Defined in modules/computing/computing-contract.ts:166

`Protected` serializeFilter

serializeFilter(key, value): any
Define and exclude custom keys from serialized object
Parameters
- key: string
- value: any
Returns any
Overrides ApillonModel.serializeFilter
- Defined in modules/computing/computing-contract.ts:182

get

get(): Promise<ComputingContract>
Gets and populates the object details of this entity

Returns Promise<ComputingContract>
A new instance of this object
Inherited from ApillonModel.get
- Defined in lib/apillon.ts:73

`Protected` populate

populate(data): ComputingContract
Populates class properties via data object.
Parameters
- data: object
  Data object.
Returns ComputingContract
Inherited from ApillonModel.populate
- Defined in lib/apillon.ts:82

serialize

serialize(): any
Convert object to JSON output, with unnecessary properties excluded

Returns any
Inherited from ApillonModel.serialize
- Defined in lib/apillon.ts:96

Class ComputingContract

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ComputingContract

Properties

name

description

bucketUuid

contractType

contractStatus

contractAddress

deployerAddress

transactionHash

data

Private config

Protected API_PREFIX

uuid

createTime

updateTime

Methods

listTransactions

Parameters

Returns Promise<IApillonList<IComputingTransaction>>

transferOwnership

Parameters

Returns Promise<boolean>

encryptFile

Parameters

Returns Promise<FileUploadResult[]>

Private assignCidToNft

Parameters

cid: string

nftId: number

Returns Promise<boolean>

Protected serializeFilter

Parameters

Returns any

get

Returns Promise<ComputingContract>

Protected populate

Parameters

Returns ComputingContract

serialize

Returns any

Settings

Member Visibility

Theme

On This Page

`Private` config

`Protected` API_PREFIX

`Private` assignCidToNft

`Protected` serializeFilter

`Protected` populate