-
Notifications
You must be signed in to change notification settings - Fork 11
api.procedures.types
- AcceptPrimaryKeyRotationParams
- AddAssetRequirementParams
- AddClaimsParams
- AddInstructionsParams
- AddInvestorUniquenessClaimParams
- AssetBase
- AttestPrimaryKeyRotationParams
- ClaimCountTransferRestrictionInput
- ClaimPercentageTransferRestrictionInput
- ConfigureDividendDistributionParams
- ControllerTransferParams
- CountTransferRestrictionInput
- CreateAssetParams
- CreateAssetWithTickerParams
- CreateCheckpointScheduleParams
- CreateChildIdentitiesParams
- CreateChildIdentityParams
- CreateGroupParams
- CreateMultiSigParams
- CreateNftCollectionParams
- CreateTransactionBatchParams
- CreateVenueParams
- DecreaseAllowanceParams
- EditClaimsParams
- ExecuteManualInstructionParams
- GlobalCollectionKeyInput
- IncreaseAllowanceParams
- InstructionFungibleLeg
- InstructionIdParams
- InstructionNftLeg
- InvestInOfferingParams
- InviteAccountParams
- InviteExternalAgentParams
- IssueTokensParams
- LaunchOfferingParams
- LinkCaDocsParams
- LocalCollectionKeyInput
- ModifyAssetTrustedClaimIssuersAddSetParams
- ModifyAssetTrustedClaimIssuersRemoveParams
- ModifyCaCheckpointParams
- ModifyCorporateActionsAgentParams
- ModifyMultiSigParams
- ModifyPrimaryIssuanceAgentParams
- ModifySignerPermissionsParams
- MoveFundsParams
- PayDividendsParams
- PercentageTransferRestrictionInput
- RedeemNftParams
- RedeemTokensParams
- RegisterCustomClaimTypeParams
- RegisterIdentityParams
- RemoveAssetRequirementParams
- RemoveCheckpointScheduleParams
- RemoveCorporateActionParams
- RemoveExternalAgentParams
- RemoveSecondaryAccountsParams
- RenamePortfolioParams
- ReserveTickerParams
- RevokeClaimsParams
- RotatePrimaryKeyParams
- ScopeClaimProof
- SetAllowanceParams
- SetAssetDocumentsParams
- SetAssetRequirementsParams
- SetClaimCountTransferRestrictionsParams
- SetClaimPercentageTransferRestrictionsParams
- SetCountTransferRestrictionsParams
- SetCustodianParams
- SetGroupPermissionsParams
- SetPercentageTransferRestrictionsParams
- SetPermissionGroupParams
- SubsidizeAccountParams
- TransactionsParams
- TransferAssetOwnershipParams
- TransferPolyxParams
- TransferRestriction
- TransferTickerOwnershipParams
- TxGroupParams
- UnlinkChildParams
- WaivePermissionsParams
- AddAssetStatParams
- AddClaimCountStatParams
- AddClaimCountTransferRestrictionParams
- AddClaimPercentageStatParams
- AddClaimPercentageTransferRestrictionParams
- AddCountStatParams
- AddCountTransferRestrictionParams
- AddInstructionParams
- AddInstructionWithVenueIdParams
- AddPercentageStatParams
- AddPercentageTransferRestrictionParams
- AddRestrictionParams
- AffirmOrWithdrawInstructionParams
- CollectionKeyInput
- GetTransferRestrictionReturnType
- InstructionLeg
- IssueNftParams
- ModifyAssetParams
- ModifyCaDefaultConfigParams
- ModifyClaimsParams
- ModifyComplianceRequirementParams
- ModifyInstructionAffirmationParams
- ModifyOfferingTimesParams
- ModifyVenueParams
- NftMetadataInput
- RegisterMetadataParams
- RejectInstructionParams
- RemoveAssetStatParams
- RemoveBalanceStatParams
- RemoveCountStatParams
- RemoveScopedBalanceParams
- RemoveScopedCountParams
- SetAssetStatParams
- SetMetadataParams
- SetRestrictionsParams
- SetVenueFilteringParams
Ƭ AddAssetStatParams: { ticker: string } & AddCountStatParams | AddPercentageStatParams | AddClaimCountStatParams | AddClaimPercentageStatParams
Ƭ AddClaimCountStatParams: ClaimCountStatInput & { type: ScopedCount }
Ƭ AddClaimCountTransferRestrictionParams: ClaimCountTransferRestrictionInput & { type: ClaimCount }
Ƭ AddClaimPercentageStatParams: StatClaimIssuer & { type: ScopedBalance }
Ƭ AddClaimPercentageTransferRestrictionParams: ClaimPercentageTransferRestrictionInput & { type: ClaimPercentage }
Ƭ AddCountStatParams: AddCountStatInput & { type: Count }
Ƭ AddCountTransferRestrictionParams: CountTransferRestrictionInput & { type: Count }
Ƭ AddInstructionParams: { legs: InstructionLeg[] ; memo?: string ; tradeDate?: Date ; valueDate?: Date } & { endBlock?: BigNumber } | { endAfterBlock?: BigNumber }
Ƭ AddInstructionWithVenueIdParams: AddInstructionParams & { venueId: BigNumber }
Ƭ AddPercentageStatParams: Object
| Name | Type |
|---|---|
type |
Balance |
Ƭ AddPercentageTransferRestrictionParams: PercentageTransferRestrictionInput & { type: Percentage }
Ƭ AddRestrictionParams<T>: Omit<T extends Count ? AddCountTransferRestrictionParams : T extends Percentage ? AddPercentageTransferRestrictionParams : T extends ClaimCount ? AddClaimCountTransferRestrictionParams : AddClaimPercentageTransferRestrictionParams, "type">
| Name |
|---|
T |
Ƭ AffirmOrWithdrawInstructionParams: Object
| Name | Type | Description |
|---|---|---|
portfolios? |
PortfolioLike[] |
(optional) Portfolios that the signer controls and wants to affirm the instruction or withdraw affirmation Note if empty, all the legs containing any custodied Portfolios of the signer will be affirmed/affirmation will be withdrawn, based on the operation. |
Ƭ CollectionKeyInput: GlobalCollectionKeyInput | LocalCollectionKeyInput
Global key must be registered. local keys must provide a specification as they are created with the NftCollection
Ƭ GetTransferRestrictionReturnType<T>: ActiveTransferRestrictions<T extends Count ? CountTransferRestriction : T extends Percentage ? PercentageTransferRestriction : T extends ClaimCount ? ClaimCountTransferRestriction : ClaimPercentageTransferRestriction>
| Name |
|---|
T |
Ƭ InstructionLeg: InstructionFungibleLeg | InstructionNftLeg
Ƭ IssueNftParams: Object
| Name | Type | Description |
|---|---|---|
metadata |
NftMetadataInput[] |
- |
portfolioId? |
BigNumber |
portfolio to which the NFTCollection will be issued (optional, default is the default portfolio) |
Ƭ ModifyAssetParams: { fundingRound?: string ; identifiers?: SecurityIdentifier[] ; makeDivisible?: true ; name: string } | { fundingRound?: string ; identifiers?: SecurityIdentifier[] ; makeDivisible: true ; name?: string } | { fundingRound: string ; identifiers?: SecurityIdentifier[] ; makeDivisible?: true ; name?: string } | { fundingRound?: string ; identifiers: SecurityIdentifier[] ; makeDivisible?: true ; name?: string }
Ƭ ModifyCaDefaultConfigParams: { defaultTaxWithholding: BigNumber ; targets?: InputTargets ; taxWithholdings?: InputTaxWithholding[] } | { defaultTaxWithholding?: BigNumber ; targets: InputTargets ; taxWithholdings?: InputTaxWithholding[] } | { defaultTaxWithholding?: BigNumber ; targets?: InputTargets ; taxWithholdings: InputTaxWithholding[] }
Ƭ ModifyClaimsParams: AddClaimsParams | EditClaimsParams | RevokeClaimsParams
Ƭ ModifyComplianceRequirementParams: Object
| Name | Type | Description |
|---|---|---|
conditions |
InputCondition[] |
array of conditions to replace the existing array of conditions for the requirement (identified by id). Conditions within a requirement are AND between them. This means that in order for a transfer to comply with this requirement, it must fulfill ALL conditions |
id |
BigNumber |
ID of the Compliance Requirement |
Ƭ ModifyInstructionAffirmationParams: InstructionIdParams & { operation: Affirm | Withdraw } & AffirmOrWithdrawInstructionParams | { operation: Reject } & RejectInstructionParams
Ƭ ModifyOfferingTimesParams: { end: Date | null ; start?: Date } | { end?: Date | null ; start: Date } | { end: Date | null ; start: Date }
Ƭ ModifyVenueParams: { description?: string ; type: VenueType } | { description: string ; type?: VenueType } | { description: string ; type: VenueType }
Ƭ NftMetadataInput: Object
| Name | Type |
|---|---|
id |
BigNumber |
type |
MetadataType |
value |
string |
Ƭ RegisterMetadataParams: { name: string ; specs: MetadataSpec } | { details?: MetadataValueDetails ; name: string ; specs: MetadataSpec ; value: string }
Ƭ RejectInstructionParams: Object
| Name | Type | Description |
|---|---|---|
portfolio? |
PortfolioLike |
(optional) Portfolio that the signer controls and wants to reject the instruction |
Ƭ RemoveAssetStatParams: { ticker: string } & RemoveCountStatParams | RemoveBalanceStatParams | RemoveScopedCountParams | RemoveScopedBalanceParams
Ƭ RemoveBalanceStatParams: Object
| Name | Type |
|---|---|
type |
Balance |
Ƭ RemoveCountStatParams: Object
| Name | Type |
|---|---|
type |
Count |
Ƭ RemoveScopedBalanceParams: StatClaimIssuer & { type: ScopedBalance }
Ƭ RemoveScopedCountParams: StatClaimIssuer & { type: ScopedCount }
Ƭ SetAssetStatParams<T>: Omit<T extends Count ? AddCountStatParams : T extends Percentage ? AddPercentageStatParams : T extends ClaimCount ? AddClaimCountStatParams : AddClaimPercentageStatParams, "type">
| Name |
|---|
T |
Ƭ SetMetadataParams: { details?: MetadataValueDetails ; value: string } | { details: MetadataValueDetails }
Ƭ SetRestrictionsParams<T>: Omit<T extends Count ? SetCountTransferRestrictionsParams : T extends Percentage ? SetPercentageTransferRestrictionsParams : T extends ClaimCount ? SetClaimCountTransferRestrictionsParams : SetClaimPercentageTransferRestrictionsParams, "type">
| Name |
|---|
T |
Ƭ SetVenueFilteringParams: Object
| Name | Type |
|---|---|
allowedVenues? |
BigNumber[] |
disallowedVenues? |
BigNumber[] |
enabled? |
boolean |
Entities
- Account
- Asset
- Authorization Request
- Checkpoint
- Checkpoint Schedule
- Corporate Action
- Corporate Action Base
- Custom Permission Group
- Default Portfolio
- Default Trusted Claim Issuer
- Dividend Distribution
- Entity
- Identity
- Instruction
- Known Permission Group
- Metadata Entry
- Multi Sig Proposal
- Numbered Portfolio
- Offering
- Permission Group
- Portfolio
- Subsidies
- Subsidy
- Ticker Reservation
- Venue
- Authorizations
- Types