Interfaces

Interface Database

Interface for performing CRUD operations on a database.

Properties

• database.create( collectionName: string, data: any ) ⇒ Promise<any>

  Creates a new record in the specified collection with the provided data.

• database.read( collectionName: string, query: string ) ⇒ Promise<any>

  Reads records from the specified collection based on the given query.

• database.update( collectionName: string, updateData: any, key: string ) ⇒ Promise<any>

  Updates a record in the specified collection with the provided data and key.

• database.delete( collectionName: string, query: string ) ⇒ Promise<any>

  Deletes records from the specified collection based on the given query.

Interface SkcCmsConnectOptions

Represents options for connecting to the CMS.

Properties

• skcCmsConnectOptions.email?: string

  Email used for authentication.

• skcCmsConnectOptions.password?: string

  Password used for authentication.

• skcCmsConnectOptions.apiKey?: string

  API key for connecting to the CMS without email and password.

Interface PrivacyServiceGateway

Properties

• privacyServiceGateway.register( assetId: string, dId: string, offset: string, assetType?: string, metadata?: object, refId?: string, signature?: string, accessUrl?: string ) ⇒ *Promise*<*any*>

  Registers an address with the Privacy Service gateway

• privacyServiceGateway.resolve( assetId: string, requestedAddress: string[], requesterPublicKey?: string, signature?: string ) ⇒ *Promise*<*any*>

  Resolves multiple addresses for a specific asset.

• privacyServiceGateway.decrypt( cipherText: string ) ⇒ *Promise*<*any*>

  Decrypts the provided cipherText using an external privacy service.

Interface SkcPrivacyServiceConnectOptions

Properties

• skcPrivacyServiceConnectOptions.email?: string

  Email used for authentication.

• skcPrivacyServiceConnectOptions.password?: string

  Password used for authentication.

• skcPrivacyServiceConnectOptions.apiKey?: string

  API key for connecting to the CMS without email and password.

Interface SCT IdPredictionOptions

Properties

• idPredictionOptions.admin: string

  Admin address/account address being used for prediction

• idPredictionOptions.tokenName: string

  The name of the token for ID prediction.

• idPredictionOptions.tokenSymbol: string

  The symbol of the token for ID prediction.

• idPredictionOptions.initialSupply: string

  The initial supply of tokens for ID prediction.

• idPredictionOptions.offset: string

  Offset value for the ID prediction.

• idPredictionOptions.skucodeType: string

  The type of the SKU code, can be a custom string value.

• idPredictionOptions.factoryAddress: string

  The address of the factory contract that will be used to generate the ID.

Interface Token Ledger IdPredictionOptions

Properties

• idPredictionOptions.uri: string

  The URI associated with the prediction or resource.

• idPredictionOptions.offset: string

  Offset value for the ID prediction.

• idPredictionOptions.factoryAddress: string

  The address of the factory contract that will be used to generate the ID

• idPredictionOptions.tokenLedgerType: string

  The type of the SKU set, can be a 0(Regular) or 1(Locked).

Interface SkucodeOptions

Properties

• skucodeOptions.denom: string

  The denomination associated with the SKU code.

• skucodeOptions.category: string

  The category of the item for which the SKU code is generated.

• skucodeOptions.itemId: string

  The ID of the item for which the SKU code is being generated.

• skucodeOptions.description?: string

  A description of the SKU code (optional).

• skucodeOptions.tokenName: string

  The name of the token associated with the SKU code.

• skucodeOptions.tokenSymbol: string

  The symbol for the token associated with the SKU code.

• skucodeOptions.initialSupply: string

  The initial supply of tokens associated with the SKU code.

• skucodeOptions.offset: string

  Offset value for SKU code (optional).

• skucodeOptions.skucodeType: 'Mintable' | 'Wrappable'

  The type of the SKU code, either "Mintable" or "Wrappable".

Interface KeyPairDetails

Represents the details of a cryptographic key pair.

Properties

• keyPairDetails.privKey?: string;

  The private key in hexadecimal format with 0x prefix.

• keyPairDetails.pubKey: string;

  The public key in hexadecimal format with 0x prefix.

• keyPairDetails.address: string;

  The associated address, typically derived from the private key.

• keyPairDetails.xPrivKey?: string;

  The extended private key in base58 encoding.

• keyPairDetails.xPubKey?: string;

  The extended public key in base58 encoding.

Interface KeyGenerationResult

Represents the result of generating Ethereum and Cosmos key pairs.

Properties

• keyGenerationResult.mnemonic: string | undefined

  The mnemonic phrase used for key generation.

• keyGenerationResult.ethKeyPair: KeyPairDetails

  The generated Ethereum key pair details.

• keyGenerationResult.cosmosKeyPair: KeyPairDetails

  The generated Cosmos key pair details.

Interface VaultClientOptions

Configuration options for initializing the Vault class.

Properties

• VaultClientOptions.pluginPath: string

  The path to the vault plugin used for transactions.

• VaultClientOptions.vaultAddress: string

  The address of the vault service.

• VaultClientOptions.vaultToken: string

  The authentication token used to interact with the vault service.

Interface ApiGatewayConfig

Properties

• skcAws.apiId: string

• skcAws.stage: string

• skcAws.region: string

• skcAws.secretId: string

• skcAws.credentials: credentials

Properties for credentials

• credentials.accessKeyId: string

• credentials.secretAccessKey: string

Interface SctDetails

• address: string

  The address of the smart contract.

• owner: string

  The address of the contract owner.

• name: string

  The name of the smart contract or token.

• symbol: string

  The symbol representing the token, usually a short string.

• decimals: number

  The number of decimal places the token supports.

• totalSupply: string

  The total supply of the token in string format to handle large numbers.

• balances: Record<string, string>[]

  A list of balances, with each balance represented by a key-value pair. Each key is an address, and the value is the balance associated with that address.

• attachments: any[]

  An array of additional attachments or metadata associated with the smart contract. The data type is any[] to allow various forms of attachments.