Portfolio

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

Hierarchy

• Entity‹UniqueIdentifiers, HumanReadable›

  ↳ Portfolio

  ↳ DefaultPortfolio

  ↳ NumberedPortfolio

Index

Properties

• _id

• context

• owner

• uuid

Methods

• exists

• getCustodian

• getTokenBalances

• getTransactionHistory

• isCustodiedBy

• isEqual

• isOwnedBy

• moveFunds

• quitCustody

• setCustodian

• toJson

• generateUuid

• unserialize

Properties

Protected Optional _id

• _id? : BigNumber

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

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

identity of the Portfolio's owner

uuid

• uuid: string

Inherited from Entity.uuid

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

Methods

Abstract exists

▸ exists(): Promise‹boolean›

Inherited from Entity.exists

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

Determine whether this Entity exists on chain

Returns: Promise‹boolean›

getCustodian

▸ getCustodian(): Promise‹Identity›

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

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

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

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

Return whether an Identity is the Portfolio custodian

Parameters:

Name	Type
args?	undefined | object

Returns: Promise‹boolean›

isEqual

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

Inherited from Entity.isEqual

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

Determine whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹unknown, unknown›

Returns: boolean

isOwnedBy

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

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

Return whether an Identity is the Portfolio owner

Parameters:

Name	Type
args?	undefined | object

Returns: Promise‹boolean›

moveFunds

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

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

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 Current Account has the required permissions to run it

Parameters:

Name	Type
args	MoveFundsParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

quitCustody

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

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

Returns the custody of the portfolio to the portfolio owner unilaterally

note required role:

• Portfolio Custodian

note this method is of type ProcedureMethod, which means you can call quitCustody.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	void
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

setCustodian

▸ setCustodian(args: SetCustodianParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

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

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

note this method is of type ProcedureMethod, which means you can call setCustodian.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	SetCustodianParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

toJson

▸ toJson(): HumanReadable

Overrides Entity.toJson

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

Return the Portfolio ID and owner DID

Returns: HumanReadable

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

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

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers