Portfolio

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

Hierarchy

Index

Properties

Methods

Properties

Protected Optional _id

_id? : BigNumber

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

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

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

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

Retrieve the balances of all assets in this Portfolio

Parameters:

Name

Type

args?

undefined | object

Returns: Promise‹PortfolioBalance[]›

getTransactionHistory

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

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

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›

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

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

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

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

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:

Returns: Promise‹TransactionQueue‹void››

quitCustody

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

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

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?

Returns: Promise‹TransactionQueue‹void››

setCustodian

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

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

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:

Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): HumanReadable

Overrides Entity.toJson

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

Return the Portfolio ID and owner DID

Returns: HumanReadable

Static generateUuid

generateUuidIdentifiers›(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

unserializeIdentifiers›(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

Last updated