DefaultPortfolio
Represents the default Portfolio for an Identity
Hierarchy
↳ DefaultPortfolio
Index
Properties
Methods
Properties
Protected Optional _id
Protected Optional _id• _id? : BigNumber
Defined in src/api/entities/Portfolio/index.ts:53
internal Portfolio identifier (unused for default Portfolio)
Protected context
Protected context• context: Context
Defined in src/api/entities/Entity.ts:48
owner
• owner: Identity
Inherited from Portfolio.owner
Defined in src/api/entities/Portfolio/index.ts:48
identity of the Portfolio's owner
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
getCustodian
▸ getCustodian(): Promise‹Identity›
Inherited from Portfolio.getCustodian
Defined in src/api/entities/Portfolio/index.ts:199
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[]›
Inherited from Portfolio.getTokenBalances
Defined in src/api/entities/Portfolio/index.ts:104
Retrieve the balances of all assets in this Portfolio
Parameters:
Returns: Promise‹PortfolioBalance[]›
isCustodiedBy
▸ isCustodiedBy(args?: undefined | object): Promise‹boolean›
Inherited from Portfolio.isCustodiedBy
Defined in src/api/entities/Portfolio/index.ts:88
Return whether an Identity is the Portfolio custodian
Parameters:
Returns: Promise‹boolean›
isOwnedBy
▸ isOwnedBy(args?: undefined | object): Promise‹boolean›
Inherited from Portfolio.isOwnedBy
Defined in src/api/entities/Portfolio/index.ts:72
Return whether an Identity is the Portfolio owner
Parameters:
Returns: Promise‹boolean›
moveFunds
▸ moveFunds(args: MoveFundsParams): Promise‹TransactionQueue‹void››
Inherited from Portfolio.moveFunds
Defined in src/api/entities/Portfolio/index.ts:190
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››
Inherited from Portfolio.setCustodian
Defined in src/api/entities/Portfolio/index.ts:174
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