1
0
mirror of https://github.com/oceanprotocol-archive/squid-js.git synced 2024-02-02 15:31:51 +01:00

added function docs

This commit is contained in:
alexcos20 2020-03-31 11:58:12 +03:00
parent b76577bda5
commit 091df0f9d4

View File

@ -384,6 +384,13 @@ export class OceanAssets extends Instantiable {
return txReceipt return txReceipt
} }
/**
* Edit Metadata for a DDO.
* @param {did} string DID.
* @param {newMetadata} EditableMetaData Metadata fields & new values.
* @param {Account} account Ethereum account of owner to sign and prove the ownership.
* @return {Promise<string>}
*/
public async editMetadata( public async editMetadata(
did: string, did: string,
newMetadata: EditableMetaData, newMetadata: EditableMetaData,
@ -407,6 +414,12 @@ export class OceanAssets extends Instantiable {
return result return result
} }
/**
* Retire a DDO (Delete)
* @param {did} string DID.
* @param {Account} account Ethereum account of owner to sign and prove the ownership.
* @return {Promise<string>}
*/
public async retire(did: string, account: Account): Promise<string> { public async retire(did: string, account: Account): Promise<string> {
const oldDdo = await this.ocean.aquarius.retrieveDDO(did) const oldDdo = await this.ocean.aquarius.retrieveDDO(did)
// get a signature // get a signature