NumberedPortfolio
Represents a numbered (non-default) Portfolio for an Identity
Hierarchy
↳ NumberedPortfolio
Index
Properties
Methods
Properties
Protected Optional _id
Protected Optional _id• _id? : BigNumber
Defined in src/api/entities/Portfolio/index.ts:83
internal Portfolio identifier (unused for default Portfolio)
Protected context
Protected context• context: Context
Inherited from CheckpointSchedule.context
Defined in src/api/entities/Entity.ts:48
id
• id: BigNumber
Defined in src/api/entities/NumberedPortfolio.ts:49
Portfolio identifier number
owner
• owner: Identity
Inherited from Portfolio.owner
Defined in src/api/entities/Portfolio/index.ts:78
Identity of the Portfolio's owner
uuid
• uuid: string
Inherited from CheckpointSchedule.uuid
Defined in src/api/entities/Entity.ts:46
Methods
createdAt
▸ createdAt(): Promise‹EventIdentifier | null›
Defined in src/api/entities/NumberedPortfolio.ts:114
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›
createdAtV2
▸ createdAtV2(): Promise‹EventIdentifier | null›
Defined in src/api/entities/NumberedPortfolio.ts:141
Retrieve the identifier data (block number, date and event index) of the event that was emitted when this Portfolio was created
note uses the middlewareV2
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›
exists
▸ exists(): Promise‹boolean›
Defined in src/api/entities/NumberedPortfolio.ts:167
Return whether this Portfolio exists
Returns: Promise‹boolean›
getAssetBalances
▸ getAssetBalances(args?: undefined | object): Promise‹PortfolioBalance[]›
Inherited from Portfolio.getAssetBalances
Defined in src/api/entities/Portfolio/index.ts:144
Retrieve the balances of all Assets in this Portfolio
Parameters:
args?
undefined | object
Returns: Promise‹PortfolioBalance[]›
getCustodian
▸ getCustodian(): Promise‹Identity›
Inherited from Portfolio.getCustodian
Defined in src/api/entities/Portfolio/index.ts:274
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›
Defined in src/api/entities/NumberedPortfolio.ts:83
Return the Portfolio name
Returns: Promise‹string›
getTransactionHistory
▸ getTransactionHistory(filters: object): Promise‹ResultSet‹HistoricSettlement››
Inherited from Portfolio.getTransactionHistory
Defined in src/api/entities/Portfolio/index.ts:319
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
Returns: Promise‹ResultSet‹HistoricSettlement››
getTransactionHistoryV2
▸ getTransactionHistoryV2(filters: object): Promise‹HistoricSettlement[]›
Inherited from Portfolio.getTransactionHistoryV2
Defined in src/api/entities/Portfolio/index.ts:421
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
Returns: Promise‹HistoricSettlement[]›
isCustodiedBy
▸ isCustodiedBy(args?: undefined | object): Promise‹boolean›
Inherited from Portfolio.isCustodiedBy
Defined in src/api/entities/Portfolio/index.ts:128
Return whether an Identity is the Portfolio custodian
Parameters:
args?
undefined | object
Returns: Promise‹boolean›
isEqual
▸ isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from CheckpointSchedule.isEqual
Defined in src/api/entities/Entity.ts:61
Determine whether this Entity is the same as another one
Parameters:
entity
Entity‹unknown, unknown›
Returns: boolean
isOwnedBy
▸ isOwnedBy(args?: undefined | object): Promise‹boolean›
Inherited from Portfolio.isOwnedBy
Defined in src/api/entities/Portfolio/index.ts:115
Return whether an Identity is the Portfolio owner
Parameters:
args?
undefined | object
Returns: Promise‹boolean›
modifyName
▸ modifyName(args: RenamePortfolioParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹NumberedPortfolio››
Defined in src/api/entities/NumberedPortfolio.ts:76
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 signing Account and Identity have the required roles and permissions to run it
Parameters:
opts?
Returns: Promise‹TransactionQueue‹NumberedPortfolio››
moveFunds
▸ moveFunds(args: MoveFundsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Inherited from Portfolio.moveFunds
Defined in src/api/entities/Portfolio/index.ts:252
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 signing Account and Identity have the required roles and permissions to run it
Parameters:
args
opts?
Returns: Promise‹TransactionQueue‹void››
quitCustody
▸ quitCustody(opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Inherited from Portfolio.quitCustody
Defined in src/api/entities/Portfolio/index.ts:265
Returns the custody of the portfolio to the portfolio owner unilaterally
note required role:
Portfolio Custodian
note this method is of type NoArgsProcedureMethod, which means you can call quitCustody.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Parameters:
opts?
Returns: Promise‹TransactionQueue‹void››
setCustodian
▸ setCustodian(args: SetCustodianParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹AuthorizationRequest››
Inherited from Portfolio.setCustodian
Defined in src/api/entities/Portfolio/index.ts:239
Send an invitation to an Identity to assign it as custodian for this Portfolio
note this will create an Authorization Request which has to be accepted by the targetIdentity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne
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 signing Account and Identity have the required roles and permissions to run it
Parameters:
opts?
Returns: Promise‹TransactionQueue‹AuthorizationRequest››
toHuman
▸ toHuman(): HumanReadable
Inherited from Portfolio.toHuman
Defined in src/api/entities/Portfolio/index.ts:540
Return the Portfolio ID and owner DID
Returns: HumanReadable
Static generateUuid
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Inherited from CheckpointSchedule.generateUuid
Defined in src/api/entities/Entity.ts:14
Generate the Entity's UUID from its identifying properties
Type parameters:
▪ Identifiers
Parameters:
identifiers
Identifiers
Returns: string
Static unserialize
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Inherited from CheckpointSchedule.unserialize
Defined in src/api/entities/Entity.ts:23
Unserialize a UUID into its Unique Identifiers
Type parameters:
▪ Identifiers
Parameters:
serialized
string
UUID to unserialize
Returns: Identifiers
Last updated