Module: client
Exposes tools enabling interaction with a Logion network. An instance of LogionClient must be created. Most features of the client require authentication.
Table of contents
Enumerations
Classes
- AcceptedProtection
- AcceptedRequest
- AccountTokens
- ActiveProtection
- AnySourceHttpClient
- ApprovedVote
- AuthenticatedLocClient
- AuthenticationClient
- AxiosFactory
- AxiosFileUploader
- BalanceState
- BaseSigner
- CancellableRequest
- ClaimedRecovery
- ClientToken
- ClosedCollectionLoc
- ClosedLoc
- CollectionItem
- DefaultSignAndSendStrategy
- DirectoryClient
- DraftRequest
- EditableRequest
- File
- HashOrContent
- HashString
- InvitedContributorApi
- InvitedContributorLoc
- KeyringSigner
- LegalOfficeReviewCommandsImpl
- LegalOfficerClass
- LegalOfficerClosedCollectionLocCommands
- LegalOfficerClosedLocCommands
- LegalOfficerCommands
- LegalOfficerLocWithSelectableIssuersCommandsImpl
- LegalOfficerLocsStateCommands
- LegalOfficerNonVoidedCommandsImpl
- LegalOfficerOpenRequestCommands
- LegalOfficerPendingRequestCommands
- LegalOfficerRestrictedDeliveryCommandsImpl
- LoRecoveryClient
- LocClient
- LocMultiClient
- LocRequestState
- LocsState
- LogionClient
- MergedTermsAndConditionsElement
- MimeType
- MultiSourceHttpClient
- NetworkState
- NoProtection
- OpenLoc
- PendingProtection
- PendingRecovery
- PendingRequest
- PendingVote
- PublicApi
- PublicLoc
- PublicLocClient
- ReSubmittableRequest
- ReadOnlyLocState
- RejectedRecovery
- RejectedRequest
- RejectedVote
- ReviewedRequest
- SponsorshipApi
- SponsorshipState
- State
- TokensRecord
- TransactionClient
- UnavailableProtection
- UpdatableReSubmittableRequest
- UpdatableRequest
- VaultClient
- VaultState
- VoidedCollectionLoc
- VoidedLoc
- Vote
- VoterApi
- Votes
Interfaces
- AcceptIdentityLocParams
- AcceptTransactionLocParams
- AckFileParams
- AckLinkParams
- AckMetadataParams
- AddCollectionItemParams
- AddFileParams
- AddLinkParams
- AddMetadataParams
- AddTokensRecordParams
- AutoPublish
- BackendCollectionParams
- BackendConfig
- BackendLocFees
- BackendTransaction
- BackendVerifiedIssuerIdentity
- BackendVote
- BalanceSharedState
- BaseLoc
- BlockchainBatchSubmission
- BlockchainSubmission
- BlockchainSubmissionParams
- CheckCertifiedCopyResult
- CheckCollectionDeliveryRequest
- CheckHashResult
- CheckTokensRecordDeliveryRequest
- ClientItemFile
- ClientTokensRecord
- CloseLocParams
- CollectionDelivery
- CollectionParams
- ComponentFactory
- CoreComponentFactory
- CreateCollectionLocParams
- CreateCollectionLocRequestParams
- CreateIdentityLocParams
- CreateIdentityLocRequestParams
- CreateLocParams
- CreateLocRequest
- CreateLocRequestParams
- CreateOpenLoc
- CreateProtectionRequest
- CreateSofRequest
- CreateSofRequestParams
- CreateVaultTransferRequest
- Delivery
- DirectoryLegalOfficer
- Endpoint
- EstimateFeesAcceptTransactionLocParams
- EstimateFeesIdentityTransactionLocParams
- EstimateFeesPublishFileParams
- EstimateFeesPublishLinkParams
- EstimateFeesPublishMetadataParams
- Fees
- FetchAllLocsParams
- FetchAllResult
- FetchLocRequestSpecification
- FetchParameters
- FetchVaultTransferRequest
- FileDescription
- FileToUpload
- FileUploadParameters
- FileUploader
- FormDataLike
- GetDeliveriesRequest
- GetTokensRecordDeliveriesRequest
- GetTokensRecordsRequest
- HasDraft
- HasIdentity
- HasJwtToken
- HashAndSize
- ISubmittableResult
- IdenfyVerificationCreation
- IdenfyVerificationSession
- ItemDeliveries
- ItemDelivery
- ItemDeliveryMatch
- ItemLifecycle
- ItemTokenWithRestrictedType
- ItemsParams
- LegalOfficeReviewCommands
- LegalOfficer
- LegalOfficerCommandsConstructorArgs
- LegalOfficerDecision
- LegalOfficerEndpoint
- LegalOfficerLocWithSelectableIssuersCommands
- LegalOfficerNonVoidedCommands
- LegalOfficerPostalAddress
- LegalOfficerProtectionState
- LegalOfficerRestrictedDeliveryCommands
- LocCollectionItem
- LocData
- LocFees
- LocFile
- LocLink
- LocMetadataItem
- LocRequest
- LocRequestVoidInfo
- LocSharedState
- LocVerifiedIssuers
- LogionClientConfig
- MergedFile
- MergedLink
- MergedMetadataItem
- MultiSourceHttpClientState
- NameValue
- OffchainCollectionItem
- OffchainCollectionItemFile
- OffchainCollectionItemToken
- OffchainTermsAndConditionsElement
- OffchainTokensRecord
- OffchainTokensRecordFile
- OpenCollectionLocParams
- OpenLocParams
- OpenPolkadotLocParams
- PollingParameters
- PostalAddress
- ProtectionOrRecoveryParams
- ProtectionParameters
- ProtectionParams
- ProtectionRequest
- PublishFileParams
- PublishLinkParams
- PublishMetadataParams
- RawSigner
- RecoveryParams
- RecoverySharedState
- RefFileParams
- RefLinkParams
- RefMetadataParams
- ReviewFileParams
- ReviewLinkParams
- ReviewMetadataParams
- ReviewParams
- SelectUnselectIssuerParams
- SetInvitedContributorSelectionParams
- SetIssuerSelectionParams
- SharedState
- SignAndSendStrategy
- SignParameters
- SignRawParameters
- Signer
- SuccessfulSubmission
- SupportedAccountId
- Token
- TokenValidationResult
- Transaction
- TransactionError
- TransferAllParam
- TransferParam
- TypedFile
- TypedSignature
- UpdateParameters
- UploadCollectionItemFileParams
- UploadTokensRecordFileParams
- UploadableCollectionItem
- UploadableItemFile
- UserActionParameters
- UserIdentity
- VaultSharedState
- VaultTransferRequest
- VaultTransferRequestDecision
- VerifiedIssuer
- VoidParams
- VoteData
- WaitForParameters
- WithActiveProtection
- WithProtectionParameters
- WithRefresh
Type Aliases
- AnyLocState
- CreativeCommonsCode
- EnvironmentString
- FullSigner
- IdenfySessionStatus
- ItemStatus
- Language
- LocRequestStatus
- MultiResponse
- NetworkType
- OffchainLocState
- OnchainLocState
- ProtectionRequestStatus
- ProtectionState
- Query
- ReviewResult
- ReviewableRequest
- SignAndSendFunction
- SignCallback
- SignatureType
- TokenIdType
- TokenType
- TransactionType
- TransferDirection
- VaultStateCreationParameters
- VaultTransferRequestStatus
- VerifiedIssuerWithSelect
- VoteResult
- VoteStatus
Variables
- CoreComponentFactoryInstance
- DEFAULT_POLLING_PARAMETERS
- EMPTY_LOC_ISSUERS
- ISO_DATETIME_PATTERN
- TERMS_AND_CONDITIONS_TYPES
- values
Functions
- aggregateArrays
- allUp
- authenticatedCurrentAccount
- buildComponentFactory
- checkCertifiedCopy
- createLogionClientConfig
- downloadFile
- fromIsoString
- generateEthereumTokenItemId
- generatePSP34TokenItemId
- getBalanceState
- getCollectionItem
- getDefinedCurrentAccount
- getInitialState
- getLegalOfficer
- getTokensRecord
- getTokensRecords
- hashAttributes
- initMultiSourceHttpClientState
- isErcNft
- isMultiversxESDTId
- isSingularKusamaId
- isTokenCompatibleWith
- isTokenType
- isValidMime
- requestSort
- requireDefined
- toBlockchainSubmission
- toFeesClass
- toIsoString
- toTransaction
- validateErcToken
- validatePsp34TokenId
- validateToken
- waitFor
- withAdditional
- withLocId
TermsAndConditions
- AbstractTermsAndConditionsElement
- CreativeCommons
- LogionClassification
- SpecificLicense
- LogionClassificationParameters
- TermsAndConditionsElement
- LogionTransferredRight
- LogionTransferredRightCode
- LogionTransferredRightDescription
- TermsAndConditionsElementType
- logionLicenseItems
- newTermsAndConditions
Type Aliases
AnyLocState
Ƭ AnyLocState: OffchainLocState | OnchainLocState
Defined in
packages/client/src/Loc.ts:751
CreativeCommonsCode
Ƭ CreativeCommonsCode: typeof values extends Set<infer T> ? T : never
Defined in
packages/client/src/license/CreativeCommons.ts:6
EnvironmentString
Ƭ EnvironmentString: keyof typeof Environment
Defined in
packages/client/src/Environment.ts:33
FullSigner
Ƭ FullSigner: RawSigner & Signer
Defined in
packages/client/src/Signer.ts:53
IdenfySessionStatus
Ƭ IdenfySessionStatus: "APPROVED" | "DENIED" | "SUSPECTED" | "EXPIRED" | "PENDING"
Defined in
packages/client/src/LocClient.ts:163
ItemStatus
Ƭ ItemStatus: "DRAFT" | "REVIEW_PENDING" | "REVIEW_ACCEPTED" | "REVIEW_REJECTED" | "PUBLISHED" | "ACKNOWLEDGED"
Defined in
packages/client/src/LocClient.ts:60
Language
Ƭ Language: "en" | "fr"
Defined in
packages/client/src/Types.ts:35
LocRequestStatus
Ƭ LocRequestStatus: "DRAFT" | "REVIEW_PENDING" | "REVIEW_REJECTED" | "REVIEW_ACCEPTED" | "OPEN" | "CLOSED"
Defined in
packages/client/src/LocClient.ts:165
MultiResponse
Ƭ MultiResponse<R>: Record<string, R>
Type parameters
| Name |
|---|
R |
Defined in
packages/client/src/Http.ts:19
NetworkType
Ƭ NetworkType: "ETHEREUM" | "POLKADOT" | "MULTIVERSX"
Defined in
packages/client/src/Token.ts:33
OffchainLocState
Ƭ OffchainLocState: DraftRequest | PendingRequest | RejectedRequest | AcceptedRequest
Defined in
packages/client/src/Loc.ts:753
OnchainLocState
Ƭ OnchainLocState: OpenLoc | ClosedLoc | ClosedCollectionLoc | VoidedLoc | VoidedCollectionLoc
Defined in
packages/client/src/Loc.ts:755
ProtectionRequestStatus
Ƭ ProtectionRequestStatus: "PENDING" | "REJECTED" | "ACCEPTED" | "ACTIVATED" | "CANCELLED" | "REJECTED_CANCELLED" | "ACCEPTED_CANCELLED"
Defined in
packages/client/src/RecoveryClient.ts:16
ProtectionState
Ƭ ProtectionState: NoProtection | PendingProtection | AcceptedProtection | ActiveProtection | PendingRecovery | ClaimedRecovery | UnavailableProtection | RejectedRecovery
Defined in
packages/client/src/Recovery.ts:24
Query
Ƭ Query<E, R>: (axios: AxiosInstance, endpoint: E) => Promise<R>
Type parameters
| Name |
|---|
E |
R |
Type declaration
▸ (axios, endpoint): Promise<R>
Parameters
| Name | Type |
|---|---|
axios | AxiosInstance |
endpoint | E |
Returns
Promise<R>
Defined in
packages/client/src/Http.ts:33
ReviewResult
Ƭ ReviewResult: "ACCEPT" | "REJECT"
Defined in
packages/client/src/LocClient.ts:2409
ReviewableRequest
Ƭ ReviewableRequest: OpenLoc | PendingRequest
Defined in
packages/client/src/Loc.ts:1263
SignAndSendFunction
Ƭ SignAndSendFunction: (statusCallback: (result: ISubmittableResult) => void) => Promise<() => void>
Type declaration
▸ (statusCallback): Promise<() => void>
Parameters
| Name | Type |
|---|---|
statusCallback | (result: ISubmittableResult) => void |
Returns
Promise<() => void>
Defined in
packages/client/src/Signer.ts:55
SignCallback
Ƭ SignCallback: (result: ISubmittableResult) => void
Type declaration
▸ (result): void
Parameters
| Name | Type |
|---|---|
result | ISubmittableResult |
Returns
void
Defined in
packages/client/src/Signer.ts:33
SignatureType
Ƭ SignatureType: "POLKADOT" | "ETHEREUM" | "CROSSMINT_ETHEREUM" | "MULTIVERSX"
Defined in
packages/client/src/Signer.ts:21
TokenIdType
Ƭ TokenIdType: "U8" | "U16" | "U32" | "U64" | "U128" | "Bytes"
This is a rewrite of the function get_item_id implemented by Logion Smart Contract:
https://github.com/logion-network/logion-ink/blob/41d7aeb1ac746d8a557f0592f82f0bcb206f6e7a/logics/impls/logion.rs#L38-L43
Defined in
packages/client/src/PSP34.ts:8
TokenType
Ƭ TokenType: "ethereum_erc721" | "ethereum_erc1155" | "goerli_erc721" | "goerli_erc1155" | "singular_kusama" | "polygon_erc721" | "polygon_erc1155" | "polygon_mumbai_erc721" | "polygon_mumbai_erc1155" | "ethereum_erc20" | "goerli_erc20" | "polygon_erc20" | "polygon_mumbai_erc20" | "owner" | "multiversx_devnet_esdt" | "multiversx_testnet_esdt" | "multiversx_esdt" | "astar_psp34" | "astar_shiden_psp34" | "astar_shibuya_psp34"
Defined in
packages/client/src/Token.ts:10
TransactionType
Ƭ TransactionType: "EXTRINSIC" | "VAULT_OUT" | "LEGAL_FEE" | "STORAGE_FEE" | "CERTIFICATE_FEE" | "OTHER_FEES" | "VALUE_FEE" | "RESERVE" | "COLLECTION_ITEM_FEE" | "TOKENS_RECORD_FEE"
Defined in
packages/client/src/TransactionClient.ts:32
TransferDirection
Ƭ TransferDirection: "Sent" | "Received" | "None"
Defined in
packages/client/src/Balance.ts:45
VaultStateCreationParameters
Ƭ VaultStateCreationParameters: SharedState & { isRecovery: boolean ; recoveredAccount?: ValidAccountId ; selectedLegalOfficers: LegalOfficer[] }
Defined in
packages/client/src/Vault.ts:31
VaultTransferRequestStatus
Ƭ VaultTransferRequestStatus: "ACCEPTED" | "PENDING" | "REJECTED" | "CANCELLED" | "REJECTED_CANCELLED"
Defined in
packages/client/src/VaultClient.ts:9
VerifiedIssuerWithSelect
Ƭ VerifiedIssuerWithSelect: VerifiedIssuer & { selected: boolean }
Defined in
packages/client/src/Loc.ts:2088
VoteResult
Ƭ VoteResult: "Yes" | "No"
Defined in
packages/client/src/Votes.ts:132
VoteStatus
Ƭ VoteStatus: "PENDING" | "APPROVED" | "REJECTED"
Defined in
packages/client/src/Votes.ts:120
Variables
CoreComponentFactoryInstance
• Const CoreComponentFactoryInstance: CoreComponentFactory
Defined in
packages/client/src/ComponentFactory.ts:92
DEFAULT_POLLING_PARAMETERS
• Const DEFAULT_POLLING_PARAMETERS: PollingParameters
Defined in
packages/client/src/Polling.ts:14
EMPTY_LOC_ISSUERS
• Const EMPTY_LOC_ISSUERS: LocVerifiedIssuers
Defined in
packages/client/src/LocClient.ts:2481
ISO_DATETIME_PATTERN
• Const ISO_DATETIME_PATTERN: RegExp
Defined in
packages/client/src/DateTimeUtil.ts:12
TERMS_AND_CONDITIONS_TYPES
• Const TERMS_AND_CONDITIONS_TYPES: readonly ["logion_classification", "specific_license", "CC4.0"]
Defined in
packages/client/src/license/TermsAndConditions.ts:3
values
• Const values: Set<"BY" | "BY-SA" | "BY-NC" | "BY-NC-SA" | "BY-ND" | "BY-NC-ND">
Defined in
packages/client/src/license/CreativeCommons.ts:5
Functions
aggregateArrays
▸ aggregateArrays<E>(response): E[]
Type parameters
| Name |
|---|
E |
Parameters
| Name | Type |
|---|---|
response | MultiResponse<E[]> |
Returns
E[]
Defined in
packages/client/src/Http.ts:141
allUp
▸ allUp<E>(endpoints): MultiSourceHttpClientState<E>
Type parameters
| Name | Type |
|---|---|
E | extends Endpoint |
Parameters
| Name | Type |
|---|---|
endpoints | E[] |
Returns
Defined in
packages/client/src/Http.ts:26
authenticatedCurrentAccount
▸ authenticatedCurrentAccount(sharedState): Object
Parameters
| Name | Type |
|---|---|
sharedState | SharedState |
Returns
Object
| Name | Type |
|---|---|
currentAccount | ValidAccountId |
token | Token |
Defined in
packages/client/src/SharedClient.ts:42
buildComponentFactory
▸ buildComponentFactory(buildFileUploader): ComponentFactory
Parameters
| Name | Type |
|---|---|
buildFileUploader | () => FileUploader |
Returns
Defined in
packages/client/src/ComponentFactory.ts:104
checkCertifiedCopy
▸ checkCertifiedCopy(deliveries, hash): CheckCertifiedCopyResult
Parameters
| Name | Type |
|---|---|
deliveries | ItemDeliveries |
hash | Hash |
Returns
Defined in
packages/client/src/Deliveries.ts:3
createLogionClientConfig
▸ createLogionClientConfig(env, buildFileUploader): LogionClientConfig
Parameters
| Name | Type |
|---|---|
env | "DEV" | "TEST" | "MVP" | Environment |
buildFileUploader | () => FileUploader |
Returns
Defined in
packages/client/src/Environment.ts:35
downloadFile
▸ downloadFile(axios, url): Promise<TypedFile>
Parameters
| Name | Type |
|---|---|
axios | AxiosInstance |
url | string |
Returns
Promise<TypedFile>
Defined in
packages/client/src/Http.ts:154
fromIsoString
▸ fromIsoString(isoString): DateTime
Parameters
| Name | Type |
|---|---|
isoString | string |
Returns
DateTime
Defined in
packages/client/src/DateTimeUtil.ts:14
generateEthereumTokenItemId
▸ generateEthereumTokenItemId(nonce, tokenId): Hash
This is a rewrite of the function getItemId implemented by Logion Smart Contract:
https://github.com/logion-network/logion-solidity/blob/main/contracts/Logion.sol
Parameters
| Name | Type |
|---|---|
nonce | string |
tokenId | string |
Returns
Hash
Defined in
packages/client/src/Ethereum.ts:7
generatePSP34TokenItemId
▸ generatePSP34TokenItemId(nonce, tokenId): Hash
Parameters
| Name | Type |
|---|---|
nonce | string |
tokenId | Object |
tokenId.type | TokenIdType |
tokenId.value | string |
Returns
Hash
Defined in
packages/client/src/PSP34.ts:10
getBalanceState
▸ getBalanceState(sharedState): Promise<BalanceState>
Parameters
| Name | Type |
|---|---|
sharedState | SharedState & { isRecovery: boolean ; recoveredAccount?: ValidAccountId } |
Returns
Promise<BalanceState>
Defined in
packages/client/src/Balance.ts:65
getCollectionItem
▸ getCollectionItem(parameters): Promise<CollectionItem | undefined>
Parameters
| Name | Type |
|---|---|
parameters | Object |
parameters.itemId | Hash |
parameters.locClient | LocClient |
parameters.locId | UUID |
Returns
Promise<CollectionItem | undefined>
Defined in
packages/client/src/Loc.ts:2169
getDefinedCurrentAccount
▸ getDefinedCurrentAccount(sharedState): ValidAccountId
Parameters
| Name | Type |
|---|---|
sharedState | SharedState |
Returns
ValidAccountId
Defined in
packages/client/src/SharedClient.ts:54
getInitialState
▸ getInitialState(data, pSharedState): ProtectionState
Parameters
| Name | Type |
|---|---|
data | FetchAllResult |
pSharedState | SharedState |
Returns
Defined in
packages/client/src/Recovery.ts:79
getLegalOfficer
▸ getLegalOfficer(sharedState, account): LegalOfficerClass
Parameters
| Name | Type |
|---|---|
sharedState | SharedState |
account | ValidAccountId |
Returns
Defined in
packages/client/src/SharedClient.ts:38
getTokensRecord
▸ getTokensRecord(parameters): Promise<TokensRecord | undefined>
Parameters
| Name | Type |
|---|---|
parameters | Object |
parameters.locClient | LocClient |
parameters.locId | UUID |
parameters.recordId | Hash |
Returns
Promise<TokensRecord | undefined>
Defined in
packages/client/src/Loc.ts:2186
getTokensRecords
▸ getTokensRecords(parameters): Promise<TokensRecord[]>
Parameters
| Name | Type |
|---|---|
parameters | { locClient: LocClient } & GetTokensRecordsRequest |
Returns
Promise<TokensRecord[]>
Defined in
packages/client/src/Loc.ts:2203
hashAttributes
▸ hashAttributes(attributes): string
Parameters
| Name | Type |
|---|---|
attributes | string[] |
Returns
string
Defined in
packages/client/src/Signer.ts:212
initMultiSourceHttpClientState
▸ initMultiSourceHttpClientState(networkState, legalOfficers?): MultiSourceHttpClientState<LegalOfficerEndpoint>
Parameters
| Name | Type |
|---|---|
networkState | NetworkState<LegalOfficerEndpoint> |
legalOfficers? | LegalOfficer[] |
Returns
MultiSourceHttpClientState<LegalOfficerEndpoint>
Defined in
packages/client/src/Http.ts:79
isErcNft
▸ isErcNft(type): boolean
Parameters
| Name | Type |
|---|---|
type | TokenType |
Returns
boolean
Defined in
packages/client/src/Token.ts:142
isMultiversxESDTId
▸ isMultiversxESDTId(tokenId): boolean
Parameters
| Name | Type |
|---|---|
tokenId | string |
Returns
boolean
Defined in
packages/client/src/Token.ts:187
isSingularKusamaId
▸ isSingularKusamaId(tokenId): boolean
Parameters
| Name | Type |
|---|---|
tokenId | string |
Returns
boolean
Defined in
packages/client/src/Token.ts:183
isTokenCompatibleWith
▸ isTokenCompatibleWith(type, networkType): boolean
Parameters
| Name | Type |
|---|---|
type | TokenType |
networkType | NetworkType |
Returns
boolean
Defined in
packages/client/src/Token.ts:60
isTokenType
▸ isTokenType(type): type is TokenType
Parameters
| Name | Type |
|---|---|
type | string |
Returns
type is TokenType
Defined in
packages/client/src/Token.ts:35
isValidMime
▸ isValidMime(mimeType): boolean
Parameters
| Name | Type |
|---|---|
mimeType | string |
Returns
boolean
Defined in
packages/client/src/Mime.ts:31
requestSort
▸ requestSort(a, b): number
Parameters
| Name | Type |
|---|---|
a | VaultTransferRequest |
b | VaultTransferRequest |
Returns
number
Defined in
packages/client/src/VaultClient.ts:223
requireDefined
▸ requireDefined<T>(value, errorSupplier?): T
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
value | undefined | T |
errorSupplier? | () => Error |
Returns
T
Defined in
packages/client/src/assertions.ts:1
toBlockchainSubmission
▸ toBlockchainSubmission<T>(params): BlockchainSubmission<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
params | T & BlockchainSubmissionParams |
Returns
Defined in
packages/client/src/LocClient.ts:209
toFeesClass
▸ toFeesClass(fees): FeesClass | undefined
Parameters
| Name | Type |
|---|---|
fees | undefined | Fees |
Returns
FeesClass | undefined
Defined in
packages/client/src/Fees.ts:25
toIsoString
▸ toIsoString(moment): string
Parameters
| Name | Type |
|---|---|
moment | DateTime |
Returns
string
Defined in
packages/client/src/DateTimeUtil.ts:3
toTransaction
▸ toTransaction(transaction, account): Transaction
Parameters
| Name | Type |
|---|---|
transaction | BackendTransaction |
account | ValidAccountId |
Returns
Defined in
packages/client/src/Balance.ts:47
validateErcToken
▸ validateErcToken(itemToken): Object
Parameters
| Name | Type |
|---|---|
itemToken | ItemTokenWithRestrictedType |
Returns
Object
| Name | Type |
|---|---|
idObject? | any |
result | TokenValidationResult |
Defined in
packages/client/src/Token.ts:146
validatePsp34TokenId
▸ validatePsp34TokenId(tokenId): TokenValidationResult
Parameters
| Name | Type |
|---|---|
tokenId | string |
Returns
Defined in
packages/client/src/Token.ts:191
validateToken
▸ validateToken(api, itemToken): TokenValidationResult
Parameters
| Name | Type |
|---|---|
api | LogionNodeApiClass |
itemToken | ItemTokenWithRestrictedType |
Returns
Defined in
packages/client/src/Token.ts:81
waitFor
▸ waitFor<T>(params): Promise<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
params | WaitForParameters<T> |
Returns
Promise<T>
Defined in
packages/client/src/Polling.ts:19
withAdditional
▸ withAdditional<T, P>(additionalPayload, params): BlockchainSubmission<T & P>
Type parameters
| Name |
|---|
T |
P |
Parameters
| Name | Type |
|---|---|
additionalPayload | P |
params | BlockchainSubmission<T> |
Returns
BlockchainSubmission<T & P>
Defined in
packages/client/src/LocClient.ts:197
withLocId
▸ withLocId<T>(locId, params): BlockchainSubmission<T & FetchParameters>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
locId | UUID |
params | BlockchainSubmission<T> |
Returns
BlockchainSubmission<T & FetchParameters>
Defined in
packages/client/src/LocClient.ts:193
TermsAndConditions
• Abstract AbstractTermsAndConditionsElement<P>: Object
Provides a re-usable base implementation of TermsAndConditionsElement.
Type parameters
| Name | Description |
|---|---|
P | Type of Terms&Conditions parameters. |
Defined in
packages/client/src/license/TermsAndConditions.ts:36
• CreativeCommons: Object
Provides Terms and Conditions under the Creative Commons Attribution License 4.0
Defined in
packages/client/src/license/CreativeCommons.ts:13
• LogionClassification: Object
Provides a Logion Classification.
Defined in
packages/client/src/license/LogionClassification.ts:267
• SpecificLicense: Object
A Terms and Conditions element defining a specific license, where details are stored "as is".
Defined in
packages/client/src/license/SpecificLicense.ts:9
• LogionClassificationParameters: Object
Defines the parameters of a Logion Classification.
Defined in
packages/client/src/license/LogionClassification.ts:246
• TermsAndConditionsElement: Object
Common contract to all Terms and Conditions elements.
Defined in
packages/client/src/license/TermsAndConditions.ts:15
LogionTransferredRight
Ƭ LogionTransferredRight: { code: LogionTransferredRightCode } & LogionTransferredRightDescription
A transferred right code associated with description in one language.
Defined in
packages/client/src/license/LogionClassification.ts:43
LogionTransferredRightCode
Ƭ LogionTransferredRightCode: "PER-PRIV" | "PER-PUB" | "COM-NOMOD" | "COM-MOD" | "EX" | "NOEX" | "WW" | "REG" | "NOTIME" | "TIME"
List of available code to describe transferred rights.
Defined in
packages/client/src/license/LogionClassification.ts:12
LogionTransferredRightDescription
Ƭ LogionTransferredRightDescription: Object
Describes a transferred right.
Type declaration
| Name | Type | Description |
|---|---|---|
description | string | Long description |
shortDescription | string | Short description |
Defined in
packages/client/src/license/LogionClassification.ts:28
TermsAndConditionsElementType
Ƭ TermsAndConditionsElementType: typeof TERMS_AND_CONDITIONS_TYPES[number]
Defines available Terms&Conditions types.
Defined in
packages/client/src/license/TermsAndConditions.ts:9
logionLicenseItems
• Const logionLicenseItems: Record<LogionTransferredRightCode, Record<Language, LogionTransferredRightDescription>>
The dictionary of available transferred rights, with description in both fr and en.
Defined in
packages/client/src/license/LogionClassification.ts:49
newTermsAndConditions
▸ newTermsAndConditions(onchainTCs, offchainTCs): MergedTermsAndConditionsElement[]
Creates a new Terms and Conditions, based on given type.
Parameters
| Name | Type | Description |
|---|---|---|
onchainTCs | TermsAndConditionsElement[] | the Terms and Conditions elements, as stored on the chain. |
offchainTCs | OffchainTermsAndConditionsElement[] | the Terms and Conditions elements, as stored on the off-chain backend. |
Returns
MergedTermsAndConditionsElement[]
an array of terms and conditions element