Portfolio
Represents a base Portfolio for a specific Identity in the Polymesh blockchain
Hierarchy
Index
Properties
Methods
Properties
Protected
Optional
_id
Protected
Optional
_id• _id? : BigNumber
Defined in src/api/entities/Portfolio/index.ts:45
internal Portfolio identifier (unused for default Portfolio)
Protected
context
Protected
context• context: Context
Defined in src/api/entities/Entity.ts:48
owner
• owner: Identity
Defined in src/api/entities/Portfolio/index.ts:40
identity of the Portfolio's owner
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
getCustodian
▸ getCustodian(): Promise‹Identity›
Defined in src/api/entities/Portfolio/index.ts:191
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:96
Retrieve the balances of all assets in this Portfolio
Parameters:
Returns: Promise‹PortfolioBalance[]›
isCustodiedBy
▸ isCustodiedBy(args?
: undefined | object): Promise‹boolean›
Defined in src/api/entities/Portfolio/index.ts:80
Return whether an Identity is the Portfolio custodian
Parameters:
Returns: Promise‹boolean›
isOwnedBy
▸ isOwnedBy(args?
: undefined | object): Promise‹boolean›
Defined in src/api/entities/Portfolio/index.ts:64
Return whether an Identity is the Portfolio owner
Parameters:
Returns: Promise‹boolean›
moveFunds
▸ moveFunds(args
: MoveFundsParams): Promise‹TransactionQueue‹void››
Defined in src/api/entities/Portfolio/index.ts:182
Moves funds from this Portfolio to another one owned by the same Identity
Parameters:
Returns: Promise‹TransactionQueue‹void››
setCustodian
▸ setCustodian(args
: SetCustodianParams): Promise‹TransactionQueue‹void››
Defined in src/api/entities/Portfolio/index.ts:166
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:
Returns: Promise‹TransactionQueue‹void››
Static
generateUuid
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:
Returns: string
Static
unserialize
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:
Returns: Identifiers
Last updated