Portfolio

Represents a base Portfolio for a specific Identity in the Polymesh blockchain

Hierarchy

• Entity‹UniqueIdentifiers›

  ↳ Portfolio

  ↳ DefaultPortfolio

  ↳ NumberedPortfolio

Index

Properties

• _id

• context

• moveFunds

• owner

• setCustodian

• uuid

Methods

• getCustodian
• getTokenBalances
• getTransactionHistory
• isCustodiedBy
• isOwnedBy
• generateUuid
• unserialize

Properties

Protected Optional _id

• _id? : BigNumber

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

internal Portfolio identifier (unused for default Portfolio)

Protected context

• context: Context

Inherited from Entity.context

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

moveFunds

• moveFunds: ProcedureMethod‹MoveFundsParams, void›

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

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

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

identity of the Portfolio's owner

setCustodian

• setCustodian: ProcedureMethod‹SetCustodianParams, void›

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

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 Entity.uuid

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

Methods

getCustodian

▸ getCustodian(): Promise‹Identity›

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

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[]›

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

Retrieve the balances of all assets in this Portfolio

Parameters:

Name	Type
args?	undefined | object

Returns: Promise‹PortfolioBalance[]›

getTransactionHistory

▸ getTransactionHistory(filters: object): Promise‹ResultSet‹HistoricSettlement››

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

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‹ResultSet‹HistoricSettlement››

isCustodiedBy

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

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

Return whether an Identity is the Portfolio custodian

Parameters:

Name	Type
args?	undefined | object

Returns: Promise‹boolean›

isOwnedBy

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

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

Return whether an Identity is the Portfolio owner

Parameters:

Name	Type
args?	undefined | object

Returns: Promise‹boolean›

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Inherited from Entity.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

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Inherited from Entity.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