Portfolios
Handles all Portfolio related functionality on the Identity side

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from void

Protected parent

parent: Identity
Inherited from void

Methods

create

create(args: object, opts?: ProcedureOpts): Promise‹TransactionQueueNumberedPortfolio››
Create a new Portfolio for the Identity
note this method is of type ProcedureMethod, which means you can call create.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
args: object
Name
Type
name
string
Optional opts: ProcedureOpts
Returns: Promise‹TransactionQueueNumberedPortfolio››

delete

delete(args: object, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Delete a Portfolio by ID
note required role:
    Portfolio Custodian
note this method is of type ProcedureMethod, which means you can call delete.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
args: object
Name
Type
portfolio
BigNumber | NumberedPortfolio
Optional opts: ProcedureOpts
Returns: Promise‹TransactionQueue‹void››

getCustodiedPortfolios

getCustodiedPortfolios(paginationOpts?: PaginationOptions): Promise‹ResultSetDefaultPortfolio | NumberedPortfolio››
Retrieve all Portfolios custodied by this Identity. This only includes portfolios owned by a different Identity but custodied by this one. To fetch Portfolios owned by this Identity, use getPortfolios
note supports pagination
Parameters:
Name
Type
paginationOpts?
Returns: Promise‹ResultSetDefaultPortfolio | NumberedPortfolio››

getPortfolio

getPortfolio(): Promise‹DefaultPortfolio
Retrieve a Numbered Portfolio or the Default Portfolio if Portfolio ID is not passed
Returns: Promise‹DefaultPortfolio
getPortfolio(args: object): Promise‹NumberedPortfolio
Parameters:
args: object
Name
Type
portfolioId
BigNumber
Returns: Promise‹NumberedPortfolio

getPortfolios

getPortfolios(): Promise‹[]›
Retrieve all the Portfolios owned by this Identity
Returns: Promise‹[]›
Last modified 26d ago