Class: NumberedPortfolio
api/entities/NumberedPortfolio.NumberedPortfolio
Represents a numbered (non-default) Portfolio for an Identity
Hierarchy
-
↳
NumberedPortfolio
Properties
id
• id: BigNumber
Portfolio identifier number
Defined in
api/entities/NumberedPortfolio.ts:39
owner
• owner: Identity
Identity of the Portfolio's owner
Inherited from
Defined in
api/entities/Portfolio/index.ts:79
uuid
• uuid: string
Inherited from
Defined in
Methods
createdAt
▸ createdAt(): Promise<null | EventIdentifier>
Retrieve the identifier data (block number, date and event index) of the event that was emitted when this Portfolio was created
Returns
Promise<null | EventIdentifier>
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
Defined in
api/entities/NumberedPortfolio.ts:101
exists
▸ exists(): Promise<boolean>
Return whether this Portfolio exists
Returns
Promise<boolean>
Overrides
Defined in
api/entities/NumberedPortfolio.ts:127
getAssetBalances
▸ getAssetBalances(args?): Promise<PortfolioBalance[]>
Retrieve the balances of all fungible assets in this Portfolio
Parameters
| Name | Type | Description |
|---|---|---|
args? | Object | - |
args.assets | (string | FungibleAsset)[] | array of FungibleAssets (or tickers) for which to fetch balances (optional, all balances are retrieved if not passed) |
Returns
Promise<PortfolioBalance[]>
Inherited from
Defined in
api/entities/Portfolio/index.ts:145
getCollections
▸ getCollections(args?): Promise<PortfolioCollection[]>
Retrieve the NFTs held in this portfolio
Parameters
| Name | Type |
|---|---|
args? | Object |
args.collections | (string | NftCollection)[] |
Returns
Promise<PortfolioCollection[]>
Inherited from
Defined in
api/entities/Portfolio/index.ts:224
getCustodian
▸ getCustodian(): Promise<Identity>
Retrieve the custodian Identity of this Portfolio
Returns
Promise<Identity>
Note
if no custodian is set, the owner Identity is returned
Inherited from
Defined in
api/entities/Portfolio/index.ts:365
getName
▸ getName(): Promise<string>
Return the Portfolio name
Returns
Promise<string>
Defined in
api/entities/NumberedPortfolio.ts:72
getTransactionHistory
▸ getTransactionHistory(filters?): Promise<HistoricSettlement[]>
Retrieve a list of transactions where this portfolio was involved. Can be filtered using parameters
Parameters
| Name | Type | Description |
|---|---|---|
filters | Object | - |
filters.account? | string | Account involved in the settlement |
filters.ticker? | string | ticker involved in the transaction |
Returns
Promise<HistoricSettlement[]>
Note
uses the middlewareV2
Inherited from
Portfolio.getTransactionHistory
Defined in
api/entities/Portfolio/index.ts:407
isCustodiedBy
▸ isCustodiedBy(args?): Promise<boolean>
Return whether an Identity is the Portfolio custodian
Parameters
| Name | Type | Description |
|---|---|---|
args? | Object | - |
args.identity | string | Identity | optional, defaults to the signing Identity |
Returns
Promise<boolean>
Inherited from
Defined in
api/entities/Portfolio/index.ts:129
isEqual
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
| Name | Type |
|---|---|
entity | Entity<unknown, unknown> |
Returns
boolean
Inherited from
Defined in
isOwnedBy
▸ isOwnedBy(args?): Promise<boolean>
Return whether an Identity is the Portfolio owner
Parameters
| Name | Type | Description |
|---|---|---|
args? | Object | - |
args.identity | string | Identity | defaults to the signing Identity |
Returns
Promise<boolean>
Inherited from
Defined in
api/entities/Portfolio/index.ts:116
modifyName
▸ modifyName(args, opts?): Promise<GenericPolymeshTransaction<NumberedPortfolio, NumberedPortfolio>>
Rename portfolio
Parameters
| Name | Type |
|---|---|
args | RenamePortfolioParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<NumberedPortfolio, NumberedPortfolio>>
Note
Only the owner is allowed to rename the Portfolio.
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
Defined in
api/entities/NumberedPortfolio.ts:65
moveFunds
▸ moveFunds(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Moves funds from this Portfolio to another one owned by the same Identity
Parameters
| Name | Type |
|---|---|
args | MoveFundsParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
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
Inherited from
Defined in
api/entities/Portfolio/index.ts:343
quitCustody
▸ quitCustody(opts?): Promise<GenericPolymeshTransaction<void, void>>
Returns the custody of the portfolio to the portfolio owner unilaterally
Parameters
| Name | Type |
|---|---|
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
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
Inherited from
Defined in
api/entities/Portfolio/index.ts:356
setCustodian
▸ setCustodian(args, opts?): Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>
Send an invitation to an Identity to assign it as custodian for this Portfolio
Parameters
| Name | Type |
|---|---|
args | SetCustodianParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>
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
Inherited from
Defined in
api/entities/Portfolio/index.ts:330
toHuman
▸ toHuman(): HumanReadable
Return the Portfolio ID and owner DID
Returns
Inherited from
Defined in
api/entities/Portfolio/index.ts:524
generateUuid
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
| Name |
|---|
Identifiers |
Parameters
| Name | Type |
|---|---|
identifiers | Identifiers |
Returns
string
Inherited from
Defined in
unserialize
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
| Name |
|---|
Identifiers |
Parameters
| Name | Type | Description |
|---|---|---|
serialized | string | UUID to unserialize |
Returns
Identifiers