Portfolio

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

Hierarchy

• Entity‹UniqueIdentifiers›

  ↳ Portfolio

  ↳ DefaultPortfolio

  ↳ NumberedPortfolio

Index

Properties

• _id

• context

• owner

• uuid

Methods

• getCustodian

• getTokenBalances

• isCustodiedBy

• isOwnedBy

• moveFunds

• setCustodian

• generateUuid

• unserialize

Properties

Protected Optional _id

• _id? : BigNumber

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

internal Portfolio identifier (unused for default Portfolio)

Protected context

• context: Context

Inherited from Entity.context

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

owner

• owner: Identity

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

identity of the Portfolio's owner

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

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

Retrieve the balances of all assets in this Portfolio

Parameters:

Name	Type
args?	undefined | object

Returns: Promise‹PortfolioBalance[]›

isCustodiedBy

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

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

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

Return whether an Identity is the Portfolio owner

Parameters:

Name	Type
args?	undefined | object

Returns: Promise‹boolean›

moveFunds

▸ moveFunds(args: MoveFundsParams): Promise‹TransactionQueue‹void››

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

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

Parameters:

Name	Type
args	MoveFundsParams

Returns: Promise‹TransactionQueue‹void››

setCustodian

▸ setCustodian(args: SetCustodianParams): Promise‹TransactionQueue‹void››

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

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

Parameters:

Name	Type
args	SetCustodianParams

Returns: Promise‹TransactionQueue‹void››

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