Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle NativeScript as ScriptRef #460

Merged
merged 3 commits into from
Oct 15, 2024
Merged

Handle NativeScript as ScriptRef #460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5cab0bf
Handle NativeScript as ScriptRef
satran004 Oct 11, 2024
24e4287
Add support for detecting multi-asset minting in transactions
satran004 Oct 11, 2024
9ae837d
Add scriptRefBytes method to test mock classes
satran004 Oct 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 7 additions & 26 deletions common-spec/src/main/java/com/bloxbean/cardano/client/spec/Script.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
package com.bloxbean.cardano.client.spec;

import co.nstant.in.cbor.CborException;
import co.nstant.in.cbor.model.Array;
import co.nstant.in.cbor.model.ByteString;
import co.nstant.in.cbor.model.DataItem;
import co.nstant.in.cbor.model.UnsignedInteger;
import com.bloxbean.cardano.client.common.cbor.CborSerializationUtil;
import com.bloxbean.cardano.client.exception.CborRuntimeException;
import com.bloxbean.cardano.client.exception.CborSerializationException;
import com.bloxbean.cardano.client.util.HexUtil;
import com.fasterxml.jackson.annotation.JsonIgnore;
Expand All @@ -33,26 +27,6 @@ default byte[] serialize() throws CborSerializationException {
return finalBytes;
}

/**
* Get serialized bytes for script reference. This is used in TransactionOutput's script_ref
* @return
* @throws CborSerializationException
*/
default byte[] scriptRefBytes() throws CborSerializationException {
int type = getScriptType();
byte[] serializedBytes = serializeScriptBody();

Array array = new Array();
array.add(new UnsignedInteger(type));
array.add(new ByteString(serializedBytes));

try {
return CborSerializationUtil.serialize(array);
} catch (CborException e) {
throw new CborRuntimeException(e);
}
}

@JsonIgnore
default byte[] getScriptHash() throws CborSerializationException {
return blake2bHash224(serialize());
Expand All @@ -63,6 +37,13 @@ default String getPolicyId() throws CborSerializationException {
return HexUtil.encodeHexString(getScriptHash());
}

/**
* Get serialized bytes for script reference. This is used in TransactionOutput's script_ref
* @return byte[]
* @throws CborSerializationException
*/
byte[] scriptRefBytes() throws CborSerializationException;

DataItem serializeAsDataItem() throws CborSerializationException;
byte[] serializeScriptBody() throws CborSerializationException;
@JsonIgnore
Expand Down
33 changes: 33 additions & 0 deletions core-api/src/main/java/com/bloxbean/cardano/client/api/util/ReferenceScriptUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
package com.bloxbean.cardano.client.api.util;

import co.nstant.in.cbor.model.Array;
import co.nstant.in.cbor.model.DataItem;
import co.nstant.in.cbor.model.UnsignedInteger;
import com.bloxbean.cardano.client.api.ScriptSupplier;
import com.bloxbean.cardano.client.api.UtxoSupplier;
import com.bloxbean.cardano.client.api.model.Utxo;
import com.bloxbean.cardano.client.common.cbor.CborSerializationUtil;
import com.bloxbean.cardano.client.exception.CborRuntimeException;
import com.bloxbean.cardano.client.plutus.spec.PlutusScript;
import com.bloxbean.cardano.client.spec.Script;
import com.bloxbean.cardano.client.transaction.spec.TransactionInput;
import com.bloxbean.cardano.client.transaction.spec.script.NativeScript;
import com.bloxbean.cardano.client.util.Try;
import com.bloxbean.cardano.client.transaction.spec.Transaction;

Expand Down Expand Up @@ -85,4 +92,30 @@ public static List<PlutusScript> resolveReferenceScripts(UtxoSupplier utxoSuppli
}
}

public static Script deserializeScriptRef(byte[] scriptRefBytes) {
Array scriptArray = (Array) CborSerializationUtil.deserialize(scriptRefBytes);

List<DataItem> dataItemList = scriptArray.getDataItems();
if (dataItemList == null || dataItemList.size() == 0 || dataItemList.size() < 2) {
throw new CborRuntimeException("Reference Script deserialization failed. Invalid no of DataItem : " + dataItemList.size());
}

int type = ((UnsignedInteger) dataItemList.get(0)).getValue().intValue();

try {
switch (type) {
case 0:
return NativeScript.deserializeScriptRef(scriptRefBytes);
case 1:
case 2:
case 3:
return PlutusScript.deserializeScriptRef(scriptRefBytes);
default:
throw new CborRuntimeException("Invalid script type : " + type);
}
} catch (Exception e) {
throw new CborRuntimeException("Reference Script deserialization failed.", e);
}
}

}
72 changes: 72 additions & 0 deletions core-api/src/test/java/com/bloxbean/cardano/client/api/util/ReferenceScriptUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@
import com.bloxbean.cardano.client.api.UtxoSupplier;
import com.bloxbean.cardano.client.api.model.Utxo;
import com.bloxbean.cardano.client.exception.CborSerializationException;
import com.bloxbean.cardano.client.plutus.spec.PlutusV1Script;
import com.bloxbean.cardano.client.plutus.spec.PlutusV2Script;
import com.bloxbean.cardano.client.plutus.spec.PlutusV3Script;
import com.bloxbean.cardano.client.transaction.spec.Transaction;
import com.bloxbean.cardano.client.transaction.spec.TransactionBody;
import com.bloxbean.cardano.client.transaction.spec.TransactionInput;
import com.bloxbean.cardano.client.transaction.spec.script.NativeScript;
import com.bloxbean.cardano.client.transaction.spec.script.ScriptAtLeast;
import com.bloxbean.cardano.client.util.HexUtil;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
Expand Down Expand Up @@ -184,4 +189,71 @@ void totalRefScriptsSizeInRefInputs_noScript() throws CborSerializationException

assertThat(refScriptsSize).isEqualTo(0);
}

@Test
void deserializeScriptRef_plutusV1() throws CborSerializationException {
PlutusV1Script plutusScript = PlutusV1Script.builder()
.type("PlutusScriptV1")
.cborHex("4e4d01000033222220051200120011")
.build();

var scriptRefBytes = plutusScript.scriptRefBytes();

var script = ReferenceScriptUtil.deserializeScriptRef(scriptRefBytes);

assertThat(script).isInstanceOf(PlutusV1Script.class);
assertThat(script).isEqualTo(plutusScript);
}

@Test
void deserializeScriptRef_plutusV2() throws CborSerializationException {
PlutusV2Script plutusScript = PlutusV2Script.builder()
.type("PlutusScriptV2")
.cborHex("49480100002221200101")
.build();

var scriptRefBytes = plutusScript.scriptRefBytes();

var script = ReferenceScriptUtil.deserializeScriptRef(scriptRefBytes);

assertThat(script).isInstanceOf(PlutusV2Script.class);
assertThat(script).isEqualTo(plutusScript);
}

@Test
void deserializeScriptRef_plutusV3() throws CborSerializationException {
PlutusV3Script plutusScript = PlutusV3Script.builder()
.type("PlutusScriptV3")
.cborHex("46450101002499")
.build();

var scriptRefBytes = plutusScript.scriptRefBytes();

var script = ReferenceScriptUtil.deserializeScriptRef(scriptRefBytes);

assertThat(script).isInstanceOf(PlutusV3Script.class);
assertThat(script).isEqualTo(plutusScript);
}

@Test
void deserializeScriptRef_nativeScript() throws CborSerializationException {
var policy = PolicyUtil.createMultiSigScriptAtLeastPolicy("test", 2, 1);

var scriptRefBytes = policy.getPolicyScript().scriptRefBytes();

var script = ReferenceScriptUtil.deserializeScriptRef(scriptRefBytes);

assertThat(script).isInstanceOf(NativeScript.class);
assertThat(script).isInstanceOf(ScriptAtLeast.class);
assertThat(script).isEqualTo(policy.getPolicyScript());
}

@Test
void deserializeScriptRef_nativeScriptBytes() {
String scriptRefBytesHex = "82008200581ca0dfc5656b946dea62a1fc23ff8881eb6468fdc14c295e2839c3ece3";

var script = ReferenceScriptUtil.deserializeScriptRef(HexUtil.decodeHexString(scriptRefBytesHex));

assertThat(script).isInstanceOf(NativeScript.class);
}
}
5 changes: 5 additions & 0 deletions core/src/test/java/com/bloxbean/cardano/client/address/AddressProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,11 @@ public String getPolicyId() throws CborSerializationException {
return null;
}

@Override
public byte[] scriptRefBytes() throws CborSerializationException {
return new byte[0];
}

@Override
public byte[] getScriptTypeBytes() {
return new byte[0];
Expand Down
5 changes: 5 additions & 0 deletions core/src/test/java/com/bloxbean/cardano/client/address/AddressServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,11 @@ public String getPolicyId() throws CborSerializationException {
return null;
}

@Override
public byte[] scriptRefBytes() throws CborSerializationException {
return new byte[0];
}

@Override
public byte[] getScriptTypeBytes() {
return new byte[0];
Expand Down
5 changes: 3 additions & 2 deletions .../main/java/com/bloxbean/cardano/client/function/helper/DuplicateScriptWitnessChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package com.bloxbean.cardano.client.function.helper;

import com.bloxbean.cardano.client.function.TxBuilder;
import com.bloxbean.cardano.client.plutus.spec.PlutusScript;
import com.bloxbean.cardano.client.spec.Script;
import com.bloxbean.cardano.client.util.HexUtil;
import com.bloxbean.cardano.client.util.Try;

Expand Down Expand Up @@ -29,6 +29,7 @@ public static TxBuilder removeDuplicateScriptWitnesses() {

//Remove duplicate script from witness set
if (refScriptHashes != null && !refScriptHashes.isEmpty()) {
removeDuplicateScripts(txn.getWitnessSet().getNativeScripts(), refScriptHashes);
removeDuplicateScripts(txn.getWitnessSet().getPlutusV1Scripts(), refScriptHashes);
removeDuplicateScripts(txn.getWitnessSet().getPlutusV2Scripts(), refScriptHashes);
removeDuplicateScripts(txn.getWitnessSet().getPlutusV3Scripts(), refScriptHashes);
Expand All @@ -37,7 +38,7 @@ public static TxBuilder removeDuplicateScriptWitnesses() {
};
}

private static void removeDuplicateScripts(List<? extends PlutusScript> scripts, Set<String> refScriptHashes) {
private static void removeDuplicateScripts(List<? extends Script> scripts, Set<String> refScriptHashes) {
if (scripts == null || scripts.isEmpty())
return;

Expand Down
45 changes: 44 additions & 1 deletion plutus/src/main/java/com/bloxbean/cardano/client/plutus/spec/PlutusScript.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@

import co.nstant.in.cbor.CborDecoder;
import co.nstant.in.cbor.CborException;
import co.nstant.in.cbor.model.Array;
import co.nstant.in.cbor.model.ByteString;
import co.nstant.in.cbor.model.DataItem;
import co.nstant.in.cbor.model.UnsignedInteger;
import com.bloxbean.cardano.client.common.cbor.CborSerializationUtil;
import com.bloxbean.cardano.client.exception.CborRuntimeException;
import com.bloxbean.cardano.client.exception.CborSerializationException;
import com.bloxbean.cardano.client.spec.Script;
import com.bloxbean.cardano.client.util.HexUtil;
Expand Down Expand Up @@ -47,6 +51,45 @@ public byte[] serializeScriptBody() throws CborSerializationException {
return serializeAsDataItem().getBytes();
}

public abstract Language getLanguage();
@Override
public byte[] scriptRefBytes() throws CborSerializationException {
int type = getScriptType();
byte[] serializedBytes = serializeScriptBody();

Array array = new Array();
array.add(new UnsignedInteger(type));
array.add(new ByteString(serializedBytes));

try {
return CborSerializationUtil.serialize(array);
} catch (CborException e) {
throw new CborRuntimeException(e);
}
}

public static PlutusScript deserializeScriptRef(byte[] scriptRefBytes) {
Array plutusScriptArray = (Array) CborSerializationUtil.deserialize(scriptRefBytes);
List<DataItem> dataItemList = plutusScriptArray.getDataItems();
if (dataItemList == null || dataItemList.size() == 0) {
throw new CborRuntimeException("PlutusScript deserialization failed. Invalid no of DataItem");
}

int type = ((UnsignedInteger) dataItemList.get(0)).getValue().intValue();
ByteString scriptBytes = ((ByteString) dataItemList.get(1));
try {
if (type == 1) {
return PlutusV1Script.deserialize(scriptBytes);
} else if (type == 2) {
return PlutusV2Script.deserialize(scriptBytes);
} else if (type == 3) {
return PlutusV3Script.deserialize(scriptBytes);
} else {
throw new CborRuntimeException("Invalid type : " + type);
}
} catch (Exception e) {
throw new CborRuntimeException("PlutusScript deserialization failed.", e);
}
}

public abstract Language getLanguage();
}
41 changes: 41 additions & 0 deletions quicktx/src/it/java/com/bloxbean/cardano/client/quicktx/QuickTxBuilderIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,47 @@ void minting() throws CborSerializationException {
checkIfUtxoAvailable(result.getValue(), sender1Addr);
}

@Test
void minting_withScriptRef() throws CborSerializationException {
Policy policy = PolicyUtil.createMultiSigScriptAtLeastPolicy("test_policy", 1, 1);

String assetName = "MyAsset";
BigInteger qty = BigInteger.valueOf(1000);

Tx tx1 = new Tx()
.payToAddress(sender1Addr, Amount.ada(5), policy.getPolicyScript())
.from(sender1Addr);

Result<String> result1 = quickTxBuilder.compose(tx1)
.withSigner(SignerProviders.signerFrom(sender1))
.withTxInspector(tx -> {
System.out.println(JsonUtil.getPrettyJson(tx));
})
.completeAndWait();

System.out.println(result1);
assertThat(result1.isSuccessful()).isTrue();

checkIfUtxoAvailable(result1.getValue(), sender1Addr);

Tx tx = new Tx()
.mintAssets(policy.getPolicyScript(), new Asset(assetName, qty), sender1.baseAddress())
.attachMetadata(MessageMetadata.create().add("Minting tx"))
.from(sender1.baseAddress());

Result<String> result = quickTxBuilder.compose(tx)
.withSigner(SignerProviders.signerFrom(sender1))
.withSigner(SignerProviders.signerFrom(policy))
.removeDuplicateScriptWitnesses(true)
.completeAndWait();

System.out.println(result);
assertTrue(result.isSuccessful());
waitForTransaction(result);

checkIfUtxoAvailable(result.getValue(), sender1Addr);
}

@Test
void minting_withTransfer() throws CborSerializationException {
Policy policy = PolicyUtil.createMultiSigScriptAtLeastPolicy("test_policy", 1, 1);
Expand Down
9 changes: 9 additions & 0 deletions quicktx/src/main/java/com/bloxbean/cardano/client/quicktx/AbstractTx.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,15 @@ public T attachMetadata(Metadata metadata) {
return (T) this;
}

/**
* Checks if the transaction has any multi-asset minting or burning.
*
* @return true if there are multi-assets to be minted; false otherwise
*/
boolean hasMultiAssetMinting() {
return multiAssets != null && !multiAssets.isEmpty();
}

TxBuilder complete() {
TxOutputBuilder txOutputBuilder = null;

Expand Down
5 changes: 4 additions & 1 deletion quicktx/src/main/java/com/bloxbean/cardano/client/quicktx/QuickTxBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ public Transaction build() {
TxBuilder txBuilder = (context, txn) -> {
};
boolean containsScriptTx = false;
boolean hasMultiAssetMint = false;

Set<String> fromAddresses = new HashSet<>();
for (AbstractTx tx : txList) {
Expand All @@ -253,6 +254,8 @@ public Transaction build() {

if (tx instanceof ScriptTx)
containsScriptTx = true;

hasMultiAssetMint = hasMultiAssetMint || tx.hasMultiAssetMinting();
}

int totalSigners = getTotalSigners();
Expand Down Expand Up @@ -358,7 +361,7 @@ public Transaction build() {
//Balance outputs
txBuilder = txBuilder.andThen(ScriptBalanceTxProviders.balanceTx(feePayer, totalSigners, containsScriptTx));

if (containsScriptTx && removeDuplicateScriptWitnesses) {
if ((containsScriptTx || hasMultiAssetMint) && removeDuplicateScriptWitnesses) {
txBuilder = txBuilder.andThen(DuplicateScriptWitnessChecker.removeDuplicateScriptWitnesses());
}

Expand Down
Loading
Loading