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:59

internal Portfolio identifier (unused for default Portfolio)

Protected context

context: Context

Inherited from CheckpointSchedule.context

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

moveFunds

moveFunds: ProcedureMethod‹MoveFundsParams, void›

Inherited from Portfolio.moveFunds

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

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

param portfolio (or portfolio ID) that will receive the funds. Optional, if no value is passed, the funds will be moved to the default Portfolio of this Portfolio's owner

param list of tokens (and their corresponding amounts) that will be moved

note required role:

  • Portfolio Custodian

owner

owner: Identity

Inherited from Portfolio.owner

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

identity of the Portfolio's owner

setCustodian

setCustodian: ProcedureMethod‹SetCustodianParams, void›

Inherited from Portfolio.setCustodian

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

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

note this may create an AuthorizationRequest which has to be accepted by the corresponding Identity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

note required role:

  • Portfolio Custodian

uuid

uuid: string

Inherited from CheckpointSchedule.uuid

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

Methods

getCustodian

getCustodian(): Promise‹Identity

Inherited from Portfolio.getCustodian

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

Retrieve the custodian Identity of this Portfolio

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

Returns: Promise‹Identity

getTokenBalances

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

Inherited from Portfolio.getTokenBalances

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

Retrieve the balances of all assets in this Portfolio

Parameters:

Name

Type

args?

undefined | object

Returns: Promise‹PortfolioBalance[]›

getTransactionHistory

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

Inherited from Portfolio.getTransactionHistory

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

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= {}

Name

Type

Description

account?

undefined | string

account involved in the settlement

size?

undefined | number

page size

start?

undefined | number

page offset

ticker?

undefined | string

ticker involved in the transaction

Returns: Promise‹ResultSetHistoricSettlement››

isCustodiedBy

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

Inherited from Portfolio.isCustodiedBy

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

Return whether an Identity is the Portfolio custodian

Parameters:

Name

Type

args?

undefined | object

Returns: Promise‹boolean›

isEqual

isEqual(entity: Entity‹object›): boolean

Inherited from CheckpointSchedule.isEqual

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

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Entity‹object›

Returns: boolean

isOwnedBy

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

Inherited from Portfolio.isOwnedBy

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

Return whether an Identity is the Portfolio owner

Parameters:

Name

Type

args?

undefined | object

Returns: Promise‹boolean›

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: object

Parameters:

Name

Type

Description

identifiers

Identifiers

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: object

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

Last updated