NumberedPortfolio
Represents a numbered (non-default) Portfolio for an Identity

Hierarchy

Portfolio
NumberedPortfolio

Index

Properties

Methods

Properties

Protected Optional _id

_id? : BigNumber
Inherited from Portfolio._id
internal Portfolio identifier (unused for default Portfolio)

Protected context

context: Context
Inherited from Entity.context

id

id: BigNumber
portfolio identifier number

owner

owner: Identity
Inherited from Portfolio.owner
identity of the Portfolio's owner

uuid

uuid: string
Inherited from Entity.uuid

Methods

createdAt

createdAt(): Promise‹EventIdentifier | null›
Retrieve the identifier data (block number, date and event index) of the event that was emitted when this portfolio was created
note uses the middleware
note there is a possibility that the data is not ready by the time it is requested. In that case, null is returned
Returns: Promise‹EventIdentifier | null›

delete

delete(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Delete this Portfolio
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:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueue‹void››

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Return whether this Portfolio exists
Returns: Promise‹boolean›

getCustodian

getCustodian(): Promise‹Identity
Inherited from Portfolio.getCustodian
Retrieve the custodian Identity of this Portfolio
note if no custodian is set, the owner Identity is returned
Returns: Promise‹Identity

getName

getName(): Promise‹string›
Return the Portfolio name
Returns: Promise‹string›

getTokenBalances

getTokenBalances(args?: undefined | object): Promise‹PortfolioBalance[]›
Inherited from Portfolio.getTokenBalances
Retrieve the balances of all assets in this Portfolio
Parameters:
Name
Type
args?
undefined | object
Returns: Promise‹PortfolioBalance[]›

getTransactionHistory

getTransactionHistory(filters: object): Promise‹ResultSetHistoricSettlement››
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›
Inherited from Portfolio.isCustodiedBy
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
Determine 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›
Inherited from Portfolio.isOwnedBy
Return whether an Identity is the Portfolio owner
Parameters:
Name
Type
args?
undefined | object
Returns: Promise‹boolean›

modifyName

modifyName(args: RenamePortfolioParams, opts?: ProcedureOpts): Promise‹TransactionQueueNumberedPortfolio››
Rename portfolio
note required role:
    Portfolio Custodian
note this method is of type ProcedureMethod, which means you can call modifyName.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueueNumberedPortfolio››

moveFunds

moveFunds(args: MoveFundsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Inherited from Portfolio.moveFunds
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:
Name
Type
args
opts?
Returns: Promise‹TransactionQueue‹void››

quitCustody

quitCustody(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Inherited from Portfolio.quitCustody
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››
Inherited from Portfolio.setCustodian
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:
Name
Type
opts?
Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): HumanReadable
Inherited from Portfolio.toJson
Overrides Entity.toJson
Return the Portfolio ID and owner DID
Returns: HumanReadable

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
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
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 26d ago