Skip to main content

​
Splice.Api.Token.HoldingV2

Types and interfaces for retrieving an investor’s holdings.

​
Interfaces

​
Interface Holding

Holding interface. View Type: HoldingView Choices:

​
Choice Archive

Controllers: Signatories of implementing template Returns: ()

​
Data Types

​
data Account

A data type to represent an on-chain managed account, For example a traditional accounting structure, or simply a delegation to a provider to perform some services. Constructors:
  • Account
​
Optional Party
The party that owns the account, which MUST be set for regular accounts.None is reserved for special accounts managed by the instrumentadmin. Special accounts are for example used to represent the sourceaccount for mints and the target account for burns.
​
Optional Party
The provider of the account.Account providers MUST have visibility on all asset movementsand holdings. Asset implementations are free to determine howauthorization for asset movements is split between providers andowners. For example, providers MAY have to authorize all movementsrequested by the owner.
​
Text
Account number or similar.Use the empty string ("") as the default account identifier.
Instances:

​
data HoldingView

View for Holding. Constructors:
  • HoldingView
​
Account
Account in which the holding is held.
​
InstrumentId
Instrument being held.
​
Decimal
Size of the holding.
​
Optional Lock
Lock on the holding.Registries SHOULD allow holdings with expired locks as inputs totransfers to enable a combined unlocking + use choice.
​
Metadata
Metadata.
Instances:

​
data InstrumentId

A globally unique identifier for instruments. Constructors:
  • InstrumentId
​
Party
The party representing the registry app that administers the instrument.
​
Text
The identifier used for the instrument by the instrument admin.This identifier MUST be unique and unambiguous per instrument admin.
Instances:

​
data Lock

Details of a lock. Constructors:
  • Lock
​
[Party]
Unique list of parties which are locking the contract.(Represented as a list, as that has the better JSON encoding.)
​
Optional Time
Absolute, inclusive deadline as of which the lock expires.
​
Optional RelTime
Duration after which the created lock expires. Measured relativeto the ledger time that the locked holding contract was created.If both expiresAt and expiresAfter are set, the lock expires atthe earlier of the two times.
​
Optional Text
Short, human-readable description of the context of the lock.Used by wallets to enable users to understand the reason for the lock.Note that the visibility of the content in this field might be widerthan the visibility of the contracts in the context. You should thuscarefully decide what information is safe to put in the lock context.
Instances:
  • instance Eq Lock
  • instance Ord Lock
  • instance Show Lock
  • instance GetField context Lock (Optional Text)
  • instance GetField expiresAfter Lock (Optional RelTime)
  • instance GetField expiresAt Lock (Optional Time)
  • instance GetField holders Lock [Party]
  • instance GetField lock HoldingView (Optional Lock)
  • instance SetField context Lock (Optional Text)
  • instance SetField expiresAfter Lock (Optional RelTime)
  • instance SetField expiresAt Lock (Optional Time)
  • instance SetField holders Lock [Party]
  • instance SetField lock HoldingView (Optional Lock)