DefaultPortfolio

Represents the default Portfolio for an Identity

Hierarchy

Portfolio

DefaultPortfolio

Index

Properties

Methods

Properties

Protected Optional _id

_id? : BigNumber

Inherited from Portfolio._id

Defined in src/api/entities/Portfolio/index.ts:83

internal Portfolio identifier (unused for default Portfolio)


Protected context

context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48


owner

owner: Identity

Inherited from Portfolio.owner

Defined in src/api/entities/Portfolio/index.ts:78

Identity of the Portfolio's owner


uuid

uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

exists

exists(): Promise‹boolean›

Overrides Entity.exists

Defined in src/api/entities/DefaultPortfolio.ts:22

Determine whether this Portfolio exists on chain

Returns: Promise‹boolean›


getAssetBalances

getAssetBalances(args?: undefined | object): Promise‹PortfolioBalance[]›

Inherited from Portfolio.getAssetBalances

Defined in src/api/entities/Portfolio/index.ts:144

Retrieve the balances of all Assets in this Portfolio

Parameters:

Returns: Promise‹PortfolioBalance[]›


getCustodian

getCustodian(): Promise‹Identity

Inherited from Portfolio.getCustodian

Defined in src/api/entities/Portfolio/index.ts:274

Retrieve the custodian Identity of this Portfolio

note if no custodian is set, the owner Identity is returned

Returns: Promise‹Identity


getTransactionHistory

getTransactionHistory(filters: object): Promise‹ResultSetHistoricSettlement››

Inherited from Portfolio.getTransactionHistory

Defined in src/api/entities/Portfolio/index.ts:319

Retrieve a list of transactions where this portfolio was involved. Can be filtered using parameters

note supports pagination

note uses the middleware

Parameters:

Default value filters: object= {}

Returns: Promise‹ResultSetHistoricSettlement››


getTransactionHistoryV2

getTransactionHistoryV2(filters: object): Promise‹HistoricSettlement[]›

Inherited from Portfolio.getTransactionHistoryV2

Defined in src/api/entities/Portfolio/index.ts:421

Retrieve a list of transactions where this portfolio was involved. Can be filtered using parameters

note uses the middlewareV2

Parameters:

Default value filters: object= {}

Returns: Promise‹HistoricSettlement[]›


isCustodiedBy

isCustodiedBy(args?: undefined | object): Promise‹boolean›

Inherited from Portfolio.isCustodiedBy

Defined in src/api/entities/Portfolio/index.ts:128

Return whether an Identity is the Portfolio custodian

Parameters:

Returns: Promise‹boolean›


isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters:

Returns: boolean


isOwnedBy

isOwnedBy(args?: undefined | object): Promise‹boolean›

Inherited from Portfolio.isOwnedBy

Defined in src/api/entities/Portfolio/index.ts:115

Return whether an Identity is the Portfolio owner

Parameters:

Returns: Promise‹boolean›


moveFunds

moveFunds(args: MoveFundsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Inherited from Portfolio.moveFunds

Defined in src/api/entities/Portfolio/index.ts:252

Moves funds from this Portfolio to another one owned by the same Identity

note required role:

  • Portfolio Custodian

note this method is of type ProcedureMethod, which means you can call moveFunds.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Returns: Promise‹TransactionQueue‹void››


quitCustody

quitCustody(opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Inherited from Portfolio.quitCustody

Defined in src/api/entities/Portfolio/index.ts:265

Returns the custody of the portfolio to the portfolio owner unilaterally

note required role:

  • Portfolio Custodian

note this method is of type NoArgsProcedureMethod, which means you can call quitCustody.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Returns: Promise‹TransactionQueue‹void››


setCustodian

setCustodian(args: SetCustodianParams, opts?: ProcedureOpts): Promise‹TransactionQueueAuthorizationRequest››

Inherited from Portfolio.setCustodian

Defined in src/api/entities/Portfolio/index.ts:239

Send an invitation to an Identity to assign it as custodian for this Portfolio

note this will create an Authorization Request which has to be accepted by the targetIdentity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne

note required role:

  • Portfolio Custodian

note this method is of type ProcedureMethod, which means you can call setCustodian.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Returns: Promise‹TransactionQueueAuthorizationRequest››


toHuman

toHuman(): HumanReadable

Inherited from Portfolio.toHuman

Overrides Entity.toHuman

Defined in src/api/entities/Portfolio/index.ts:540

Return the Portfolio ID and owner DID

Returns: HumanReadable


Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

Identifiers

Parameters:

Returns: string


Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

Identifiers

Parameters:

Returns: Identifiers

Last updated