Portfolio
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents a base Portfolio for a specific Identity in the Polymesh blockchain
‹UniqueIdentifiers, ›
↳ Portfolio
↳
↳
Protected Optional _id• _id? : BigNumber
internal Portfolio identifier (unused for default Portfolio)
Protected context• context: Context
Identity of the Portfolio's owner
• uuid: string
Abstract exists▸ exists(): Promise‹boolean›
Determine whether this Entity exists on chain
Returns: Promise‹boolean›
Retrieve the balances of all Assets in this Portfolio
Parameters:
args?
undefined | object
Retrieve the custodian Identity of this Portfolio
note if no custodian is set, the owner Identity is returned
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= {}
account?
undefined | string
Account involved in the settlement
size?
BigNumber
page size
start?
BigNumber
page offset
ticker?
undefined | string
ticker involved in the transaction
Retrieve a list of transactions where this portfolio was involved. Can be filtered using parameters
note uses the middlewareV2
Parameters:
â–ªDefault value filters: object= {}
account?
undefined | string
Account involved in the settlement
ticker?
undefined | string
ticker involved in the transaction
▸ isCustodiedBy(args?: undefined | object): Promise‹boolean›
Return whether an Identity is the Portfolio custodian
Parameters:
args?
undefined | object
Returns: Promise‹boolean›
Determine whether this Entity is the same as another one
Parameters:
entity
Returns: boolean
▸ isOwnedBy(args?: undefined | object): Promise‹boolean›
Return whether an Identity is the Portfolio owner
Parameters:
args?
undefined | object
Returns: Promise‹boolean›
Moves funds from this Portfolio to another one owned by the same Identity
note required role:
Portfolio Custodian
Parameters:
args
opts?
Returns the custody of the portfolio to the portfolio owner unilaterally
note required role:
Portfolio Custodian
Parameters:
opts?
Send an invitation to an Identity to assign it as custodian for this Portfolio
note required role:
Portfolio Custodian
Parameters:
args
opts?
Return the Portfolio ID and owner DID
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
â–ª Identifiers
Parameters:
identifiers
Identifiers
Returns: string
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers
Parameters:
serialized
string
UUID to unserialize
Returns: Identifiers
Defined in
Inherited from .
Defined in
• owner:
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
▸ getAssetBalances(args?: undefined | object): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getCustodian(): Promise‹›
Defined in
Returns: Promise‹›
▸ getTransactionHistory(filters: object): Promise‹‹››
Defined in
Returns: Promise‹‹››
▸ getTransactionHistoryV2(filters: object): Promise‹[]›
Defined in
Returns: Promise‹[]›
Defined in
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
Defined in
▸ moveFunds(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Returns: Promise‹‹void››
▸ quitCustody(opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Returns: Promise‹‹void››
▸ setCustodian(args: , opts?: ): Promise‹‹››
Defined in
note this will create an which has to be accepted by the targetIdentity. An or can fetch its pending Authorization Requests by calling . Also, an Account or Identity can directly fetch the details of an Authorization Request by calling
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Returns: Promise‹‹››
â–¸ toHuman():
Overrides .
Defined in
Returns:
Inherited from .
Defined in
Inherited from .
Defined in