com.sap.cloud.sdk.services.blockchain.multichain.service

Class MultichainService

java.lang.Object

com.sap.cloud.sdk.services.blockchain.multichain.service.MultichainService

@Beta
public class MultichainService
extends Object

Multichain Service is used to interact with the Multichain Instance on SAP CP.

Method Summary

Modifier and Type	Method and Description
String	addMultiSigAddress(int nRequired, List<String> addresses) Creates a pay-to-scripthash (P2SH) multiSig address and adds it to the wallet.
String	appendRawTransaction(String txHex, List<MultichainUTXO> inputs, Map<String,Integer> outputs, List<String> data, String action) This works like createrawtransaction but adds the given inputs and (regular or metadata) outputs to the raw transaction specified in tx-hex, rather than creating a new transaction.
static MultichainService	create() Create a service instance looking for an instance of service type 'multichain'.
static MultichainService	create(MultichainDestination destination) Create a service instance looking from a MultichainDestination.
static MultichainService	create(String destinationId) Create a service instance looking from a destinationId .
MultichainKeyPair	createKeyPair() Generates one public/private key pairs, which are not stored in the wallet or drawn from the node’s key pool, ready for external key management.
List<MultichainKeyPair>	createKeyPairs(int count) Generates one or more public/private key pairs, which are not stored in the wallet or drawn from the node’s key pool, ready for external key management.
String	createRawSendFrom(String fromAddress, Object assetObject, List<Map<String,String>> data) Creates a transaction spending the specified inputs, sending to the given addresses.
String	createRawTransaction(List<MultichainUTXO> inputs, Map<String,Integer> outputs, List<String> data, String action) Creates a transaction spending the specified inputs, sending to the given addresses.
String	createStream(String streamName, boolean open) Creates a new stream on the blockchain called name.
String	createStreamFromAddress(String fromAddress, String streamName, boolean open) This works like create, but with control over the from-address used to create the stream.
MultichainTransaction	decodeRawTransaction(String txHex) Returns a JSON object describing the serialized transaction in tx-hex.
<T> T	extractMultichainResult(Class<T> contentClass, org.springframework.http.ResponseEntity<String> response) Convenience method to extract service responses
MultichainAssetTransaction	getAssetTransaction(String asset, String txid) Retrieves a specific transaction txid involving asset, passed as an asset name, ref or issuance txid, to which the node must be subscribed.
MultichainBlock	getBlock(String heightOrHash) Returns information about the block with hash (retrievable from getblockhash) or at the given height in the active chain.
MultichainDestination	getDestination()
MultichainInfo	getInfo() Retrieves Meta Info from MC Node
Optional<MultichainResult>	getLatestEntryOnStream(String streamName, String key) Get latest entry for key in the stream
String	getNewAddress() Generates a public/private key pair and adds it to the wallet.
MultichainTransaction	getRawTransaction(String txId) If verbose is 1, returns a JSON object describing transaction txid.
MultichainResult	getStreamItem(String streamName, String txId, boolean verbose) Retrieves a specific item with txid from stream, passed as a stream name, ref or creation txid, to which the node must be subscribed.
String	grant(Iterable<String> toAddresses, Collection<MultichainPermission> permissions) Grants permissions to addresses, a comma-separated list of addresses.
String	grantForAddress(String toAddress, Collection<MultichainPermission> permissions) Grants permissions to an address.
String	grantForAddressFrom(String fromAddress, String toAddress, Collection<MultichainPermission> permissions) This works like grantForAddress, but with control over the from-address used to grant the permissions.
String	grantFrom(String fromAddress, Iterable<String> toAddresses, Collection<MultichainPermission> permissions) This works like grant, but with control over the from-address used to grant the permissions.
void	grantWritePermissionsOnStream(String streamName, Iterable<String> addresses) Grants global receive and send permission and local write permission on stream
void	importAddress(String address, String label, boolean rescan) Adds the address (or a full public key) to the wallet, without an associated private key.
void	importAddresses(List<String> addresses, String label, boolean rescan) Adds the array of addresses (or of full public keys) to the wallet, without an associated private key.
String	issue(String address, String assetName, int qty) Creates a new asset on the blockchain, sending the initial qty units to address.
String	issue(String address, String assetName, int qty, Map<String,Object> args) Creates a new asset on the blockchain, sending the initial qty units to address.
List<MultichainAddressResult>	listAddresses(List<String> addresses, boolean verbose) Returns information about the passed addresses in the wallet.
List<MultichainAddressResult>	listAllAddresses() Returns information about all addresses in the wallet.
List<MultichainAddressResult>	listAllAddresses(boolean verbose) Returns information about all addresses in the wallet.
List<MultichainPermissionResult>	listAllPermissions(Iterable<String> addresses, boolean verbose) Returns a list of all permissions which have been explicitly granted to addresses.
List<MultichainPermissionResult>	listAllPermissionsForAddress(String address, boolean verbose) Returns a list of all permissions which have been explicitly granted to addresses.
List<MultichainResult>	listAllStreamItems(String streamName) Lists all items in stream, passed as a stream name, ref or creation txid.
List<MultichainResult>	listAllStreamKeys(String streamName, boolean verbose, int count, int start, boolean localOrdering) Provides information about all keys in stream, passed as a stream name, ref or creation txid Hex-data entries are decoded to ASCII strings.
List<MultichainStream>	listAllStreams() Returns information about all streams created on the blockchain.
List<MultichainAsset>	listAssets()
List<MultichainAsset>	listAssets(Map<String,Object> args) Pass an asset name, ref or issuance txid in assets to retrieve information about one asset only, an array thereof for multiple assets, or * for all assets.
List<MultichainBlock>	listBlocks(String blocks, boolean verbose) Returns information about the blocks specified, on the active chain only.
List<MultichainUTXO>	listLockUnspent() Returns a list of locked unspent transaction outputs in the wallet.
List<MultichainPermissionResult>	listPermissions(Collection<MultichainPermission> permissions, boolean verbose) Returns a list of all permissions which have been explicitly granted to addresses.
List<MultichainPermissionResult>	listPermissions(Collection<MultichainPermission> permissions, Iterable<String> addresses, boolean verbose) Returns a list of all permissions which have been explicitly granted to addresses.
List<MultichainResult>	listStreamItems(String streamName, boolean verbose, int count, int start, boolean localOrdering) Lists items in stream, passed as a stream name, ref or creation txid.
List<MultichainResult>	listStreamKeyItems(String streamName, String key, boolean verbose, int count, int start, boolean localOrdering) This works like listStreamItems, but listing items with the given key only.
List<MultichainResult>	listStreamKeys(String streamName, List<String> keys, boolean verbose, int count, int start, boolean localOrdering) Provides information about keys in stream, passed as a stream name, ref or creation txid Hex-data entries are decoded to ASCII strings.
List<MultichainResult>	listStreamPublisherItems(String streamName, String address, boolean verbose, int count, int start, boolean localOrdering) This works like liststreamitems, but listing items published by the given address only.
List<MultichainPublisher>	listStreamPublishers(String streamName, List<String> addresses, boolean verbose, int count, int start, boolean localOrdering) Provides information about publishers who have written to stream, passed as a stream name, ref or creation txid
List<MultichainStream>	listStreams(List<String> streams) Returns information about streams created on the blockchain.
List<MultichainUTXO>	listUnspent(int minconf, int maxconf, List<String> addresses) Returns a list of unspent transaction outputs (UTXO) in the wallet, with between minconf and maxconf confirmations.
void	lockUnspent(boolean unlock, List<MultichainUTXO> utxoList) If unlock is false, locks the specified transaction outputs in the wallet, so they will not be used for automatic coin selection.
String	publishJson(String streamName, List<String> keys, Map<String,Object> value, String options) Publishes an item (JSON data structure consisting of Map and Lists objects) in a stream.
String	publishStringAsHex(String streamName, List<String> keys, String value, String options) Publishes an item (key-value pair) in a stream.
String	publishStringAsHexFrom(String fromAddress, String streamName, List<String> keys, String value, String options) This works like publish, but publishes the item from from-address.
String	revoke(Iterable<String> toAddresses, Collection<MultichainPermission> permissions) Revokes permissions from addresses, a comma-separated list of addresses.
String	revokeForAddress(String toAddress, Collection<MultichainPermission> permissions) Revokes permissions from an address.
String	revokeForAddressFrom(String fromAddress, String toAddress, Collection<MultichainPermission> permissions) This works like revoke, but with control over the from-address used to revoke the permissions.
String	revokeFrom(String fromAddress, Iterable<String> toAddresses, Collection<MultichainPermission> permissions) This works like revoke, but with control over the from-address used to revoke the permissions.
void	revokeWritePermissionsOnStream(String streamName, Iterable<String> addresses) Revoke global receive and send permission and local write permission on stream
String	sendAsset(String address, String asset, int qty) Sends qty of asset to address, returning the txid.
String	sendRawTransaction(String signedRawTransaction) Validates the raw transaction in tx-hex and transmits it to the network, returning the txid.
MultichainSignedRawTransaction	signRawTransaction(String rawTransaction, List<Object> parentOutputObjects, Collection<String> privateKeys) Signs the raw transaction in tx-hex, often provided by a previous call to createrawtransaction or createrawsendfrom.
void	subscribe(List<String> assetsOrStreamNames, boolean rescan) Instructs the node to start tracking one or more asset(s) or stream(s).
String	toString()
void	unsubscribe(List<String> assetsOrStreamNames) Instructs the node to stop tracking one or more asset(s) or stream(s).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

@Nonnull
public static MultichainService create()
                                         throws CloudPlatformException

Create a service instance looking for an instance of service type 'multichain'.

Returns:

the new instance

Throws:

CloudPlatformException - if no service service is found or the service is insufficiently specified

create

@Nonnull
public static MultichainService create(@Nonnull
                                                MultichainDestination destination)

Create a service instance looking from a MultichainDestination.

Parameters:

destination - MultichainDestination containing the required endpoint and apiKey information

Returns:

the new instance

create

@Nonnull
public static MultichainService create(@Nonnull
                                                String destinationId)
                                         throws org.springframework.web.client.HttpClientErrorException

Create a service instance looking from a destinationId .

Parameters:

destinationId - Id from the service service in the destination service

Returns:

the new instance

Throws:

org.springframework.web.client.HttpClientErrorException - HttpClientErrorException

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

getInfo

@Nonnull
public MultichainInfo getInfo()
                                throws MultichainException,
                                       MultichainServiceException

Retrieves Meta Info from MC Node

Returns:

Returns general information about this node and blockchain.

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

addMultiSigAddress

@Nonnull
public String addMultiSigAddress(int nRequired,
                                          @Nonnull
                                          List<String> addresses)
                                   throws MultichainException,
                                          MultichainServiceException

Creates a pay-to-scripthash (P2SH) multiSig address and adds it to the wallet. Funds sent to this address can only be spent by transactions signed by nRequired of the specified keys. Each key can be a full public key, or an address if the corresponding key is in the node’s wallet. (Public keys for a wallet’s addresses can be obtained using the getaddresses call with verbose=true.)

Parameters:

nRequired - Number of required signatures for valid transactions

addresses - List of pubKeys or addresses of stake holders in this address

Returns:

The P2SH address

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

getNewAddress

@Nonnull
public String getNewAddress()
                              throws MultichainException,
                                     MultichainServiceException

Generates a public/private key pair and adds it to the wallet.

Returns:

Returns a new address whose private key is added to the wallet.

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

importAddress

public void importAddress(@Nonnull
                          String address,
                          @Nonnull
                          String label,
                          boolean rescan)
                   throws MultichainException,
                          MultichainServiceException

Adds the address (or a full public key) to the wallet, without an associated private key. This creates a watch-only address, whose activity and balance can be retrieved via various APIs (e.g. with the includeWatchOnly parameter), but whose funds cannot be spent by this node.

Parameters:

address - The address to be added to the wallet.

label - label

rescan - rescan

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

importAddresses

public void importAddresses(@Nonnull
                            List<String> addresses,
                            @Nonnull
                            String label,
                            boolean rescan)
                     throws MultichainException,
                            MultichainServiceException

Adds the array of addresses (or of full public keys) to the wallet, without an associated private key. This creates one or more watch-only addresses, whose activity and balance can be retrieved via various APIs (e.g. with the includeWatchOnly parameter), but whose funds cannot be spent by this node.

Parameters:

addresses - A list of addresses to be added to the wallet.

label - Label for the imported address

rescan - Pass true to rescan the entire chain, false to skip rescanning, and from version 1.0.5, a positive integer to rescan from that block number or a negative integer to rescan that many recent blocks.

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listAllAddresses

@Nonnull
public List<MultichainAddressResult> listAllAddresses()
                                                        throws MultichainException,
                                                               MultichainServiceException

Returns information about all addresses in the wallet.

Returns:

List of service addresses

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listAllAddresses

@Nonnull
public List<MultichainAddressResult> listAllAddresses(boolean verbose)
                                                        throws MultichainException,
                                                               MultichainServiceException

Returns information about all addresses in the wallet.

Parameters:

verbose - Set verbose to obtain more information about the addresses

Returns:

List of service addresses

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listAddresses

@Nonnull
public List<MultichainAddressResult> listAddresses(List<String> addresses,
                                                            boolean verbose)
                                                     throws MultichainException,
                                                            MultichainServiceException

Returns information about the passed addresses in the wallet.

Parameters:

addresses - List of service addresses to query

verbose - Verbosity level

Returns:

List of service addresses with information from the wallet

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

createKeyPairs

@Nonnull
public List<MultichainKeyPair> createKeyPairs(int count)
                                                throws MultichainException,
                                                       MultichainServiceException

Generates one or more public/private key pairs, which are not stored in the wallet or drawn from the node’s key pool, ready for external key management.

For each key pair, the address, pubkey (as embedded in transaction inputs) and privkey (used for signatures) is provided.

Parameters:

count - The number of key paris to be generated

Returns:

A list of service key pairs

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

createKeyPair

@Nonnull
public MultichainKeyPair createKeyPair()
                                         throws MultichainException,
                                                MultichainServiceException

Generates one public/private key pairs, which are not stored in the wallet or drawn from the node’s key pool, ready for external key management.

For the key pair, the address, pubkey (as embedded in transaction inputs) and privkey (used for signatures) is provided.

Returns:

one service key pair

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

grant

@Nonnull
public String grant(@Nonnull
                             Iterable<String> toAddresses,
                             @Nonnull
                             Collection<MultichainPermission> permissions)
                      throws MultichainException,
                             MultichainServiceException

Grants permissions to addresses, a comma-separated list of addresses. For global permissions, set permissions to one of: connect, send, receive, create, issue, mine, activate, admin, or a comma-separated list thereof. For per-asset or per-stream permissions, use the form entity.issue or entity.write,admin where entity is an asset or stream name, ref or creation txid.

For more information, @see permissions management

Parameters:

toAddresses - List of addresses to grant permission to

permissions - List of permissions

Returns:

The txid of the transaction granting the permissions

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

grantForAddress

@Nonnull
public String grantForAddress(@Nonnull
                                       String toAddress,
                                       @Nonnull
                                       Collection<MultichainPermission> permissions)
                                throws MultichainException,
                                       MultichainServiceException

Grants permissions to an address. For global permissions, set permissions to one of: connect, send, receive, create, issue, mine, activate, admin, or a comma-separated list thereof. For per-asset or per-stream permissions, use the form entity.issue or entity.write,admin where entity is an asset or stream name, ref or creation txid.

For more information, @see permissions management

Parameters:

toAddress - Address to grant permission to

permissions - List of permissions

Returns:

The txid of the transaction granting the permissions

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

grantFrom

@Nonnull
public String grantFrom(@Nonnull
                                 String fromAddress,
                                 @Nonnull
                                 Iterable<String> toAddresses,
                                 @Nonnull
                                 Collection<MultichainPermission> permissions)
                          throws MultichainException,
                                 MultichainServiceException

This works like grant, but with control over the from-address used to grant the permissions. It is useful if the node has multiple addresses with administrator permissions.

Parameters:

fromAddress - Address to grant permission from

toAddresses - List of addresses to grant permission to

permissions - List of permissions

Returns:

The txid of the transaction granting the permissions

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

grantForAddressFrom

@Nonnull
public String grantForAddressFrom(@Nonnull
                                           String fromAddress,
                                           @Nonnull
                                           String toAddress,
                                           @Nonnull
                                           Collection<MultichainPermission> permissions)
                                    throws MultichainException,
                                           MultichainServiceException

This works like grantForAddress, but with control over the from-address used to grant the permissions. It is useful if the node has multiple addresses with administrator permissions.

Parameters:

fromAddress - Address to grant permission from

toAddress - Addresses to grant permission to

permissions - List of permissions

Returns:

The txid of the transaction granting the permissions

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listPermissions

@Nonnull
public List<MultichainPermissionResult> listPermissions(@Nonnull
                                                                 Collection<MultichainPermission> permissions,
                                                                 @Nonnull
                                                                 Iterable<String> addresses,
                                                                 boolean verbose)
                                                          throws MultichainException,
                                                                 MultichainServiceException

Returns a list of all permissions which have been explicitly granted to addresses. To list information about specific global permissions, set permissions to one of connect, send, receive, issue, mine, activate, admin, or a comma-separated list thereof. For per-asset or per-stream permissions, use the form entity.issue, entity.write,admin or entity.* where entity is an asset or stream name, ref or creation txid. Provide a comma-delimited list in addresses to list the permissions for particular addresses.

Parameters:

permissions - List of permissions

addresses - List of addresses to query permission of

verbose - If verbose is true, the admins output field lists the administrator/s who assigned the corresponding permission, and the pending field lists permission changes which are waiting to reach consensus.

Returns:

List of service permissions

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listPermissions

@Nonnull
public List<MultichainPermissionResult> listPermissions(@Nonnull
                                                                 Collection<MultichainPermission> permissions,
                                                                 boolean verbose)
                                                          throws MultichainException,
                                                                 MultichainServiceException

Returns a list of all permissions which have been explicitly granted to addresses. To list information about specific global permissions, set permissions to one of connect, send, receive, issue, mine, activate, admin, or a comma-separated list thereof. For per-asset or per-stream permissions, use the form entity.issue, entity.write,admin or entity.* where entity is an asset or stream name, ref or creation txid.

Parameters:

permissions - List of permissions

verbose - If verbose is true, the admins output field lists the administrator/s who assigned the corresponding permission, and the pending field lists permission changes which are waiting to reach consensus.

Returns:

List of service permissions

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listAllPermissions

@Nonnull
public List<MultichainPermissionResult> listAllPermissions(@Nonnull
                                                                    Iterable<String> addresses,
                                                                    boolean verbose)
                                                             throws MultichainException,
                                                                    MultichainServiceException

Returns a list of all permissions which have been explicitly granted to addresses. Provide a comma-delimited list in addresses to list the permissions for particular addresses.

Parameters:

addresses - List of addresses to query permission of

verbose - If verbose is true, the admins output field lists the administrator/s who assigned the corresponding permission, and the pending field lists permission changes which are waiting to reach consensus.

Returns:

List of service permissions

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listAllPermissionsForAddress

@Nonnull
public List<MultichainPermissionResult> listAllPermissionsForAddress(@Nonnull
                                                                              String address,
                                                                              boolean verbose)
                                                                       throws MultichainException,
                                                                              MultichainServiceException

Returns a list of all permissions which have been explicitly granted to addresses. Provide a comma-delimited list in addresses to list the permissions for particular addresses.

Parameters:

address - Addresses to query permission of

verbose - If verbose is true, the admins output field lists the administrator/s who assigned the corresponding permission, and the pending field lists permission changes which are waiting to reach consensus.

Returns:

A list of MultichainPermissionResult ...

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

revoke

@Nonnull
public String revoke(@Nonnull
                              Iterable<String> toAddresses,
                              @Nonnull
                              Collection<MultichainPermission> permissions)
                       throws MultichainException,
                              MultichainServiceException

Revokes permissions from addresses, a comma-separated list of addresses. The permissions parameter works the same as for grant. This is equivalent to calling grant with start-block=0 and end-block=0. Returns the txid of transaction revoking the permissions.

For more information, @see permissions management

Parameters:

toAddresses - List of addresses to revoke permission from

permissions - List of permission strings in the above-stated format

Returns:

The txid of the transaction revoking the permissions

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

revokeForAddress

@Nonnull
public String revokeForAddress(@Nonnull
                                        String toAddress,
                                        @Nonnull
                                        Collection<MultichainPermission> permissions)
                                 throws MultichainException,
                                        MultichainServiceException

Revokes permissions from an address. The permissions parameter works the same as for grant. This is equivalent to calling grant with start-block=0 and end-block=0. Returns the txid of transaction revoking the permissions.

For more information, @see permissions management

Parameters:

toAddress - Address to revoke permission from

permissions - List of permission strings in the above-stated format

Returns:

The txid of the transaction revoking the permissions

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

revokeFrom

@Nonnull
public String revokeFrom(@Nonnull
                                  String fromAddress,
                                  @Nonnull
                                  Iterable<String> toAddresses,
                                  @Nonnull
                                  Collection<MultichainPermission> permissions)
                           throws MultichainException,
                                  MultichainServiceException

This works like revoke, but with control over the from-address used to revoke the permissions. It is useful if the node has multiple addresses with administrator permissions.

Parameters:

fromAddress - Address to be used for revoking the permission

toAddresses - List of address to revoke permission from

permissions - List of permission strings in the above-stated format

Returns:

The txid of the transaction revoking the permissions

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

revokeForAddressFrom

@Nonnull
public String revokeForAddressFrom(@Nonnull
                                            String fromAddress,
                                            @Nonnull
                                            String toAddress,
                                            @Nonnull
                                            Collection<MultichainPermission> permissions)
                                     throws MultichainException,
                                            MultichainServiceException

This works like revoke, but with control over the from-address used to revoke the permissions. It is useful if the node has multiple addresses with administrator permissions.

Parameters:

fromAddress - Address to be used for revoking the permission

toAddress - Address to revoke permission from

permissions - List of permission strings in the above-stated format

Returns:

The txid of the transaction revoking the permissions

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

createStream

@Nonnull
public String createStream(@Nonnull
                                    String streamName,
                                    boolean open)
                             throws MultichainException,
                                    MultichainServiceException

Creates a new stream on the blockchain called name. Pass the value "stream" in the type parameter (the create API can also be used to create upgrades).

Parameters:

streamName - Name for the stream to be created

open - If open is true then anyone with global send permissions can publish to the stream, otherwise publishers must be explicitly granted per-stream write permissions.

Returns:

The txid of the transaction creating the stream

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

createStreamFromAddress

@Nonnull
public String createStreamFromAddress(@Nonnull
                                               String fromAddress,
                                               @Nonnull
                                               String streamName,
                                               boolean open)
                                        throws MultichainException,
                                               MultichainServiceException

This works like create, but with control over the from-address used to create the stream. It is useful if the node has multiple addresses with create permissions

Parameters:

fromAddress - Address to be used for creating the stream

streamName - Name for the stream to be created

open - If open is true then anyone with global send permissions can publish to the stream, otherwise publishers must be explicitly granted per-stream write permissions.

Returns:

The txid of the transaction creating the stream

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listAllStreams

@Nonnull
public List<MultichainStream> listAllStreams()
                                               throws MultichainException,
                                                      MultichainServiceException

Returns information about all streams created on the blockchain.

Returns:

List of streams created on the blockchain

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listStreams

@Nonnull
public List<MultichainStream> listStreams(@Nonnull
                                                   List<String> streams)
                                            throws MultichainException,
                                                   MultichainServiceException

Returns information about streams created on the blockchain.

Parameters:

streams - Pass a stream name, ref or creation txid in streams to retrieve information about one stream only, an array thereof for multiple streams.

Returns:

List of streams created on the blockchain

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

publishStringAsHex

@Nonnull
public String publishStringAsHex(@Nonnull
                                          String streamName,
                                          @Nonnull
                                          List<String> keys,
                                          @Nonnull
                                          String value,
                                          @Nullable
                                          String options)
                                   throws MultichainException,
                                          MultichainServiceException,
                                          UnsupportedOperationException

Publishes an item (key-value pair) in a stream.

Parameters:

streamName - Pass a stream name, ref or creation txid of a stream

keys - Key or keys under which the entry should be published. For multichain 1.0, only the first key is used.

value - Data entry as string (non-hexadecimal) to be published on the blockchain

options - Additional opptions as e.g. 'offchain', only supported since service 2.0

Returns:

The txid of the created transaction

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

UnsupportedOperationException - UnsupportedOperationException

publishJson

@Nullable
public String publishJson(@Nonnull
                                    String streamName,
                                    @Nonnull
                                    List<String> keys,
                                    @Nonnull
                                    Map<String,Object> value,
                                    @Nullable
                                    String options)
                             throws MultichainException,
                                    MultichainServiceException,
                                    UnsupportedOperationException

Publishes an item (JSON data structure consisting of Map and Lists objects) in a stream. JSON data only supported since service 2.0

Parameters:

streamName - Pass a stream name, ref or creation txid of a stream

keys - One or multiple keys under which the entry should be published

value - JSON data structure to be published on the blockchain

options - Options

Returns:

The txid of the created transaction

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

UnsupportedOperationException - UnsupportedOperationException

publishStringAsHexFrom

@Nonnull
public String publishStringAsHexFrom(@Nonnull
                                              String fromAddress,
                                              @Nonnull
                                              String streamName,
                                              @Nonnull
                                              List<String> keys,
                                              @Nonnull
                                              String value,
                                              @Nullable
                                              String options)
                                       throws MultichainException,
                                              MultichainServiceException,
                                              UnsupportedOperationException

This works like publish, but publishes the item from from-address. It is useful if a stream is open or the node has multiple addresses with per-stream write permissions.

Parameters:

fromAddress - Address to be used for publishing on the stream

streamName - A stream name, ref or creation txid of a stream

keys - Key or keys under which the entry should be published. For multichain 1.0, only the first key is used.

value - Data entry as string (non-hexadecimal) to be published on the blockchain

options - Additional opptions as e.g. 'offchain', only supported since service 2.0

Returns:

The txid of the created transaction

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

UnsupportedOperationException - UnsupportedOperationException

subscribe

public void subscribe(@Nonnull
                      List<String> assetsOrStreamNames,
                      boolean rescan)

Instructs the node to start tracking one or more asset(s) or stream(s). These are specified using a name, ref or creation/issuance txid, or for multiple items, an array thereof. If rescan is true, the node will reindex all items from when the assets and/or streams were created, as well as those in other subscribed entities. Returns null if successful. See also the autosubscribe runtime parameter.

Parameters:

assetsOrStreamNames - Single string or list of asset names or stream names to start tracking

rescan - Reindex all items from when the assets and/or streams were created

unsubscribe

public void unsubscribe(@Nonnull
                        List<String> assetsOrStreamNames)

Instructs the node to stop tracking one or more asset(s) or stream(s). Assets or streams are specified using a name, ref or creation/issuance txid, or for multiple items, an array thereof.

Parameters:

assetsOrStreamNames - Single string or list of asset names or stream names to stop tracking

getStreamItem

@Nonnull
public MultichainResult getStreamItem(@Nonnull
                                               String streamName,
                                               @Nonnull
                                               String txId,
                                               boolean verbose)
                                        throws MultichainException,
                                               MultichainServiceException

Retrieves a specific item with txid from stream, passed as a stream name, ref or creation txid, to which the node must be subscribed. Set verbose to true for If an item’s data is larger than the maxshowndata runtime parameter, it will be returned as an object whose fields can be used with gettxoutdata. Hex-data entries are decoded to ASCII strings.

Parameters:

streamName - The stream in which the transaction has been made

txId - The transactionId to query

verbose - Get additional information about the item’s transaction.

Returns:

The service result of the transaction record

Throws:

MultichainException - MultichaiqnException

MultichainServiceException - MultichainServiceException

listStreamKeyItems

@Nonnull
public List<MultichainResult> listStreamKeyItems(@Nonnull
                                                          String streamName,
                                                          @Nonnull
                                                          String key,
                                                          boolean verbose,
                                                          int count,
                                                          int start,
                                                          boolean localOrdering)
                                                   throws MultichainException,
                                                          MultichainServiceException

This works like listStreamItems, but listing items with the given key only. Hex-data entries are decoded to ASCII strings.

Parameters:

streamName - A stream name, ref or creation txid of a stream

key - Key under which the entry has been published

verbose - Get additional information about the item’s transaction.

count - Limit the number of results to query.

start - Use negative start values (like the default) indicating the most recent items

localOrdering - Set local-ordering to true to order items by when first seen by this node, rather than their order in the chain

Returns:

A list of service items

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listStreamKeys

@Nonnull
public List<MultichainResult> listStreamKeys(@Nonnull
                                                      String streamName,
                                                      @Nonnull
                                                      List<String> keys,
                                                      boolean verbose,
                                                      int count,
                                                      int start,
                                                      boolean localOrdering)
                                               throws MultichainException,
                                                      MultichainServiceException

Provides information about keys in stream, passed as a stream name, ref or creation txid Hex-data entries are decoded to ASCII strings.

Parameters:

streamName - A stream name, ref or creation txid of a stream

keys - Keys under which the entry has been published

verbose - Get additional information about the item’s transaction.

count - Limit the number of results to query.

start - Use negative start values (like the default) indicating the most recent items

localOrdering - Set local-ordering to true to order items by when first seen by this node, rather than their order in the chain

Returns:

A list of service items

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listAllStreamKeys

@Nonnull
public List<MultichainResult> listAllStreamKeys(@Nonnull
                                                         String streamName,
                                                         boolean verbose,
                                                         int count,
                                                         int start,
                                                         boolean localOrdering)
                                                  throws MultichainException,
                                                         MultichainServiceException

Provides information about all keys in stream, passed as a stream name, ref or creation txid Hex-data entries are decoded to ASCII strings.

Parameters:

streamName - A stream name, ref or creation txid of a stream

verbose - Get additional information about the item’s transaction.

count - Limit the number of results to query.

start - Use negative start values (like the default) indicating the most recent items

localOrdering - Set local-ordering to true to order items by when first seen by this node, rather than their order in the chain

Returns:

A list of service items

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listAllStreamItems

@Nonnull
public List<MultichainResult> listAllStreamItems(@Nonnull
                                                          String streamName)
                                                   throws MultichainException,
                                                          MultichainServiceException

Lists all items in stream, passed as a stream name, ref or creation txid. Hex-data entries are decoded to ASCII strings.

Parameters:

streamName - A stream name, ref or creation txid of a stream

Returns:

A list of service items\

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listStreamItems

@Nonnull
public List<MultichainResult> listStreamItems(@Nonnull
                                                       String streamName,
                                                       boolean verbose,
                                                       int count,
                                                       int start,
                                                       boolean localOrdering)
                                                throws MultichainException,
                                                       MultichainServiceException

Lists items in stream, passed as a stream name, ref or creation txid. Hex-data entries are decoded to ASCII strings.

Parameters:

streamName - A stream name, ref or creation txid of a stream

verbose - Get additional information about the item’s transaction.

count - Limit the number of results to query.

start - Use negative start values (like the default) indicating the most recent items

localOrdering - Set local-ordering to true to order items by when first seen by this node, rather than their order in the chain

Returns:

A list of service items

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listStreamPublisherItems

@Nonnull
public List<MultichainResult> listStreamPublisherItems(@Nonnull
                                                                String streamName,
                                                                @Nonnull
                                                                String address,
                                                                boolean verbose,
                                                                int count,
                                                                int start,
                                                                boolean localOrdering)
                                                         throws MultichainException,
                                                                MultichainServiceException

This works like liststreamitems, but listing items published by the given address only. Hex-data entries are decoded to ASCII strings.

Parameters:

streamName - A stream name, ref or creation txid of a stream

address - Address of the publisher

verbose - Get additional information about the item’s transaction.

count - Limit the number of results to query.

start - Use negative start values (like the default) indicating the most recent items

localOrdering - Set local-ordering to true to order items by when first seen by this node, rather than their order in the chain

Returns:

A list of service items

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listStreamPublishers

@Nonnull
public List<MultichainPublisher> listStreamPublishers(@Nonnull
                                                               String streamName,
                                                               @Nonnull
                                                               List<String> addresses,
                                                               boolean verbose,
                                                               int count,
                                                               int start,
                                                               boolean localOrdering)
                                                        throws MultichainException,
                                                               MultichainServiceException

Provides information about publishers who have written to stream, passed as a stream name, ref or creation txid

Parameters:

streamName - A stream name, ref or creation txid of a stream

addresses - Addresses of the publishers

verbose - Get additional information about the item’s transaction.

count - Limit the number of results to query.

start - Use negative start values (like the default) indicating the most recent items

localOrdering - Set local-ordering to true to order items by when first seen by this node, rather than their order in the chain

Returns:

A list of service items

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listLockUnspent

@Nonnull
public List<MultichainUTXO> listLockUnspent()
                                              throws MultichainException,
                                                     MultichainServiceException

Returns a list of locked unspent transaction outputs in the wallet. These will not be used when automatically selecting the outputs to spend in a new transaction.

Returns:

Returns a list of locked unspent transaction outputs in the wallet

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listUnspent

@Nonnull
public List<MultichainUTXO> listUnspent(int minconf,
                                                 int maxconf,
                                                 @Nonnull
                                                 List<String> addresses)
                                          throws MultichainException,
                                                 MultichainServiceException

Returns a list of unspent transaction outputs (UTXO) in the wallet, with between minconf and maxconf confirmations. For a MultiChain blockchain, each transaction output includes assets and permissions fields listing any assets or permission changes encoded within that output. If the third parameter is provided, only outputs which pay an address in this array will be included.

Parameters:

minconf - Minimum number of confirmations for UTXOs

maxconf - Maximum number of confirmations for UTXOs

addresses - Receiving addresses of the UTXOs

Returns:

Returns a list of unspent transaction outputs in the wallet, with between minconf and maxconf confirmations.

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

lockUnspent

public void lockUnspent(boolean unlock,
                        @Nonnull
                        List<MultichainUTXO> utxoList)

If unlock is false, locks the specified transaction outputs in the wallet, so they will not be used for automatic coin selection. If unlock is true, it unlocks the specified outputs, or unlocks all outputs if no second parameter is provided.

Parameters:

unlock - defines if tx should be locked or unlocked

utxoList - UTXOs to lock/unlock

appendRawTransaction

@Nonnull
public String appendRawTransaction(@Nonnull
                                            String txHex,
                                            @Nonnull
                                            List<MultichainUTXO> inputs,
                                            @Nonnull
                                            Map<String,Integer> outputs,
                                            @Nonnull
                                            List<String> data,
                                            @Nonnull
                                            String action)
                                     throws MultichainException,
                                            MultichainServiceException

This works like createrawtransaction but adds the given inputs and (regular or metadata) outputs to the raw transaction specified in tx-hex, rather than creating a new transaction. It is particularly useful for accepting an offer of exchange using an address whose private key is held outside the node’s wallet. Note that if tx-hex contains more outputs than inputs, the new outputs will be inserted at position n, where n is the number of inputs in tx-hex. (This is important to preserve the viability of certain types of transaction signatures.)

Parameters:

txHex - Raw transaction in hex to append to

inputs - Inputs to append

outputs - Outputs to append

data - Data to append via OP_RETURN UTXOs

action - Action to perform after appending

Returns:

Raw transaction in hex with appended input, outputs and with actions performed

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

createRawTransaction

@Nonnull
public String createRawTransaction(@Nonnull
                                            List<MultichainUTXO> inputs,
                                            @Nonnull
                                            Map<String,Integer> outputs,
                                            @Nonnull
                                            List<String> data,
                                            @Nonnull
                                            String action)
                                     throws MultichainException,
                                            MultichainServiceException

Creates a transaction spending the specified inputs, sending to the given addresses. Each amounts field can specify a quantity of the native blockchain currency, some asset(s) and/or inline metadata, using one of these forms. The optional data array adds one or more metadata outputs to the transaction, where each element is formatted as passed to appendrawdata. The optional action parameter can be lock (locks the given inputs in the wallet), sign (signs the transaction using wallet keys), lock,sign (does both) or send (signs and sends the transaction). If action is send the txid is returned. If action contains sign, an object with hex and complete fields is returned, as for signrawtransaction. Otherwise, the raw transaction hexadecimal is returned. See raw transactions for more details on building raw transactions.

Parameters:

inputs - Inputs to consume

outputs - Outputs to create

data - Data to append via OP_RETURN UTXOs

action - Action to perform after appending

Returns:

Raw transaction in hex with input, outputs and with actions performed

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

createRawSendFrom

@Nonnull
public String createRawSendFrom(@Nonnull
                                         String fromAddress,
                                         @Nonnull
                                         Object assetObject,
                                         @Nonnull
                                         List<Map<String,String>> data)
                                  throws MultichainException,
                                         MultichainServiceException

Creates a transaction spending the specified inputs, sending to the given addresses. In Bitcoin Core, each amount field is a quantity of the bitcoin currency. For MultiChain, an {"asset":qty, ...} object can be used for amount, in which each asset is an asset name, ref or issuance txid, and each qty is the quantity of that asset to send (see native assets). Use "" as the asset inside this object to specify a quantity of the native currency.

This works like createrawtransaction, except it automatically selects the transaction inputs from those belonging to from-address, to cover the appropriate amounts. One or more change outputs going back to from-address will also be added to the end of the transaction.

Parameters:

fromAddress - Address to be used for creating this transaction

assetObject - Transaction details maps, e.g. '{}' or '{"to-address":amount,...}

data - The optional data array adds one or more metadata outputs to the transaction, where each element is a raw hexadecimal string or object, formatted as passed to appendrawdata, e.g. '[{"for":"stream0","key":"key0","data":"4578"}]'.

Returns:

A hexadecimal raw transaction

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

decodeRawTransaction

@Nonnull
public MultichainTransaction decodeRawTransaction(@Nonnull
                                                           String txHex)
                                                    throws MultichainException,
                                                           MultichainServiceException

Returns a JSON object describing the serialized transaction in tx-hex. For a MultiChain blockchain, each transaction output includes assets and permissions fields listing any assets or permission changes encoded within that output. There will also be a data field listing the content of any OP_RETURN outputs in the transaction.

Parameters:

txHex - The raw transaction hex string

Returns:

A JSON object describing the serialized transaction in tx-hex.

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

sendRawTransaction

@Nonnull
public String sendRawTransaction(@Nonnull
                                          String signedRawTransaction)
                                   throws MultichainException,
                                          MultichainServiceException

Validates the raw transaction in tx-hex and transmits it to the network, returning the txid. The raw transaction can be created using createrawtransaction, (optionally) appendrawdata and signrawtransaction, or else createrawexchange and appendrawexchange.

Parameters:

signedRawTransaction - The signedRawTransaction to be sent as hex-string

Returns:

The txid of the created transaction

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

signRawTransaction

@Nonnull
public MultichainSignedRawTransaction signRawTransaction(@Nonnull
                                                                  String rawTransaction,
                                                                  @Nullable
                                                                  List<Object> parentOutputObjects,
                                                                  @Nullable
                                                                  Collection<String> privateKeys)
                                                           throws MultichainException,
                                                                  MultichainServiceException

Signs the raw transaction in tx-hex, often provided by a previous call to createrawtransaction or createrawsendfrom. If complete, the transaction can be broadcast to the network using sendrawtransaction. If not, it can be passed to other parties for additional signing.

Parameters:

rawTransaction - The raw transaction in tx-hex to be signed

parentOutputObjects - To create chains of unbroadcast transactions, pass an optional array of {parent-output} objects, each of which takes the form {"txid":txid,"vout":n,"scriptPubKey":hex}.

privateKeys - To sign using (only) private keys which are not in the node’s wallet, pass an array of "private-key" strings, formatted as per the output of dumpprivkey. Pass null to sign from wallet keys only.

Returns:

Returns a raw hexadecimal transaction in the hex field alongside a complete field stating whether it is now completely signed.

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

getBlock

@Nonnull
public MultichainBlock getBlock(@Nonnull
                                         String heightOrHash)
                                  throws MultichainException,
                                         MultichainServiceException

Returns information about the block with hash (retrievable from getblockhash) or at the given height in the active chain. The verbosity level is not supported and is set to 4.

Parameters:

heightOrHash - Block height or block hash to query

Returns:

Metadata of the block, including hash and height and included transactions

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

getRawTransaction

@Nonnull
public MultichainTransaction getRawTransaction(@Nonnull
                                                        String txId)
                                                 throws MultichainException,
                                                        MultichainServiceException

If verbose is 1, returns a JSON object describing transaction txid. For a MultiChain blockchain, each transaction output includes assets and permissions fields listing any assets or permission changes encoded within that output. There will also be a data field listing the content of any OP_RETURN outputs in the transaction. The verbosity level is not supported and is set to true.

Parameters:

txId - Transaction id to query

Returns:

Metadata of the transaction, including inputs, outputs, permissions and timestamp

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listBlocks

@Nonnull
public List<MultichainBlock> listBlocks(@Nonnull
                                                 String blocks,
                                                 boolean verbose)
                                          throws MultichainException,
                                                 MultichainServiceException

Returns information about the blocks specified, on the active chain only. The blocks parameter can contain a comma-delimited list or array of block heights, hashes, height ranges (e.g. 100-200) or -n for the most recent n blocks. Alternatively, pass an object {"starttime":...,"endtime":...} for blocks whose timestamps are in the given range.

Parameters:

blocks - Query string in the above-stated form

verbose - Verbosity of the block meta data

Returns:

A list of block meta data

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

getLatestEntryOnStream

@Nonnull
public Optional<MultichainResult> getLatestEntryOnStream(@Nonnull
                                                                  String streamName,
                                                                  @Nonnull
                                                                  String key)
                                                           throws MultichainException,
                                                                  MultichainServiceException

Get latest entry for key in the stream

Parameters:

streamName - Stream to query

key - Key to query

Returns:

The latest value of the entry saved in the stream

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

grantWritePermissionsOnStream

public void grantWritePermissionsOnStream(@Nonnull
                                          String streamName,
                                          @Nonnull
                                          Iterable<String> addresses)
                                   throws MultichainException,
                                          MultichainServiceException

Grants global receive and send permission and local write permission on stream

Parameters:

streamName - Stream to grant write access to

addresses - Addresses to grant permission to

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

revokeWritePermissionsOnStream

public void revokeWritePermissionsOnStream(@Nonnull
                                           String streamName,
                                           @Nonnull
                                           Iterable<String> addresses)
                                    throws MultichainException,
                                           MultichainServiceException

Revoke global receive and send permission and local write permission on stream

Parameters:

streamName - Stream to revoke write access from

addresses - Addresses to revoke permission from

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

sendAsset

@Nonnull
public String sendAsset(@Nonnull
                                 String address,
                                 @Nonnull
                                 String asset,
                                 int qty)

Sends qty of asset to address, returning the txid. The asset can be specified using its name, ref or issuance txid – see native assets for more information. See also sendassetfrom to control the address whose funds are used, send for sending multiple assets in one transaction, and sendfrom to combine both of these.

Parameters:

address - Address to send asset to

asset - The asset can be specified using its name, ref or issuance txid

qty - Quantity of assets to send

Returns:

String

listAssets

@Nonnull
public List<MultichainAsset> listAssets()
                                          throws MultichainException,
                                                 MultichainServiceException

Returns:

Information about assets issued on the blockchain.

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

listAssets

@Nonnull
public List<MultichainAsset> listAssets(@Nonnull
                                                 Map<String,Object> args)
                                          throws MultichainException,
                                                 MultichainServiceException

Pass an asset name, ref or issuance txid in assets to retrieve information about one asset only, an array thereof for multiple assets, or * for all assets. In assets with multiple issuance events, the top-level issuetxid and details fields refer to the first issuance only – set verbose to true for details about each of the individual issuances. Use count and start to retrieve part of the list only, with negative start values (like the default) indicating the most recently created assets. Extra fields are shown for assets to which this node is subscribed.

Parameters:

args - ptinal arguments for listassets

Returns:

List

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

issue

@Nonnull
public String issue(@Nonnull
                             String address,
                             @Nonnull
                             String assetName,
                             int qty)

Creates a new asset on the blockchain, sending the initial qty units to address. To create an asset with the default behavior, use an asset name only for name|params. For more control, use an object such as {"name":"asset1","open":true}. If open is true then additional units can be issued in future by the same key which signed the original issuance, via the issuemore or issuemorefrom command.

Parameters:

address - address the asset is issued to initially

assetName - name of the asset that is issued

qty - number of units that should be send to address initially

Returns:

String

issue

@Nonnull
public String issue(@Nonnull
                             String address,
                             @Nonnull
                             String assetName,
                             int qty,
                             @Nonnull
                             Map<String,Object> args)

Creates a new asset on the blockchain, sending the initial qty units to address. To create an asset with the default behavior, use an asset name only for name|params. For more control, use an object such as {"name":"asset1","open":true}. If open is true then additional units can be issued in future by the same key which signed the original issuance, via the issuemore or issuemorefrom command. The smallest transactable unit is given by units, e.g. 0.01. If the chain uses a native currency, you can send some with the new asset using the native-amount parameter.

Parameters:

address - address the asset is issued to initially

assetName - name of the asset that is issued

qty - number of units that should be send to address initially

args - HashMap of optional parameters (native-amount & units)

Returns:

String

getAssetTransaction

@Nonnull
public MultichainAssetTransaction getAssetTransaction(@Nonnull
                                                               String asset,
                                                               @Nonnull
                                                               String txid)
                                                        throws MultichainException,
                                                               MultichainServiceException

Retrieves a specific transaction txid involving asset, passed as an asset name, ref or issuance txid, to which the node must be subscribed.

Parameters:

asset - asset can be specified using its name, ref or issuance txid

txid - txid of the transaction

Returns:

MultichainTransaction

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

extractMultichainResult

@Nonnull
public <T> T extractMultichainResult(@Nonnull
                                              Class<T> contentClass,
                                              @Nonnull
                                              org.springframework.http.ResponseEntity<String> response)
                                       throws MultichainException,
                                              MultichainServiceException

Convenience method to extract service responses

Type Parameters:

T - T

Parameters:

contentClass - Class of expected result, e.g. MultichainTransaction.class

response - Response body of the MultichainCommand

Returns:

T

Throws:

MultichainException - MultichainException

MultichainServiceException - MultichainServiceException

getDestination

public MultichainDestination getDestination()