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

• getAssetBalances

• getCustodian

• getTransactionHistory

• getTransactionHistoryV2

• isCustodiedBy

• isEqual

• isOwnedBy

• moveFunds

• quitCustody

• setCustodian

• toHuman

• generateUuid

• unserialize

Properties

Protected Optional _id

• _id? : BigNumber

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

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

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›

---

getAssetBalances

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

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

Retrieve the balances of all Assets in this Portfolio

Parameters:

Name	Type
args?	undefined | object

Returns: Promise‹PortfolioBalance[]›

---

getCustodian

▸ getCustodian(): Promise‹Identity›

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

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

Name	Type	Description
account?	undefined | string	Account involved in the settlement
size?	BigNumber	page size
start?	BigNumber	page offset
ticker?	undefined | string	ticker involved in the transaction

Returns: Promise‹ResultSet‹HistoricSettlement››

---

getTransactionHistoryV2

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

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

Name	Type	Description
account?	undefined | string	Account involved in the settlement
ticker?	undefined | string	ticker involved in the transaction

Returns: Promise‹HistoricSettlement[]›

---

isCustodiedBy

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

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

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 CheckpointSchedule.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:115

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

Name	Type
args	MoveFundsParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

---

quitCustody

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

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:

Name	Type
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

---

setCustodian

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

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:

Name	Type
args	SetCustodianParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹AuthorizationRequest››

---

toHuman

▸ toHuman(): HumanReadable

Overrides Entity.toHuman

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

Return the Portfolio ID and owner DID

Returns: HumanReadable

---

Static generateUuid

▸ generateUuid‹Identifiers›(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:

Name	Type	Description
identifiers	Identifiers

Returns: string

---

Static unserialize

▸ unserialize‹Identifiers›(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:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers