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

Jump to bottom

Add some APIs to make it more convenient for users to construct InvokeHostFunction. #497

Merged
merged 7 commits into from
Jul 31, 2023
Merged

Add some APIs to make it more convenient for users to construct InvokeHostFunction. #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
edfda08
Add some APIs to make it more convenient for users to construct Invok…
overcat Jul 31, 2023
da0cd56
Add some APIs to make it more convenient for users to construct Invok…
overcat Jul 31, 2023
c8e4a88
change func name.
overcat Jul 31, 2023
d3572e3
add tests
overcat Jul 31, 2023
015ba73
add tests
overcat Jul 31, 2023
193c144
add xdr test
overcat Jul 31, 2023
ac72107
fix typo
overcat Jul 31, 2023
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
221 changes: 221 additions & 0 deletions src/main/java/org/stellar/sdk/InvokeHostFunctionOperation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,33 @@
package org.stellar.sdk;

import java.security.SecureRandom;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import javax.annotation.Nullable;
import lombok.EqualsAndHashCode;
import lombok.NonNull;
import lombok.Singular;
import lombok.Value;
import lombok.experimental.SuperBuilder;
import org.stellar.sdk.xdr.ContractExecutable;
import org.stellar.sdk.xdr.ContractExecutableType;
import org.stellar.sdk.xdr.ContractIDPreimage;
import org.stellar.sdk.xdr.ContractIDPreimageType;
import org.stellar.sdk.xdr.CreateContractArgs;
import org.stellar.sdk.xdr.Hash;
import org.stellar.sdk.xdr.HostFunction;
import org.stellar.sdk.xdr.HostFunctionType;
import org.stellar.sdk.xdr.InvokeHostFunctionOp;
import org.stellar.sdk.xdr.OperationType;
import org.stellar.sdk.xdr.SCSymbol;
import org.stellar.sdk.xdr.SCVal;
import org.stellar.sdk.xdr.SCValType;
import org.stellar.sdk.xdr.SCVec;
import org.stellar.sdk.xdr.SorobanAuthorizationEntry;
import org.stellar.sdk.xdr.Uint256;
import org.stellar.sdk.xdr.XdrString;

/**
* Represents <a
Expand Down Expand Up @@ -46,6 +63,210 @@ public static InvokeHostFunctionOperation fromXdr(InvokeHostFunctionOp op) {
.build();
}

/**
* This function will create an {@link InvokeHostFunctionOperationBuilder} with the "hostFunction"
* parameter preset, so that you can conveniently build an {@link InvokeHostFunctionOperation} to
* upload contract wasm.
*
* @param wasm The wasm bytes to upload.
* @return {@link InvokeHostFunctionOperationBuilder}
*/
public static InvokeHostFunctionOperationBuilder<?, ?> uploadContractWasmOperationBuilder(
byte[] wasm) {
HostFunction hostFunction =
new HostFunction.Builder()
.discriminant(HostFunctionType.HOST_FUNCTION_TYPE_UPLOAD_CONTRACT_WASM)
.wasm(wasm)
.build();
return builder().hostFunction(hostFunction);
}

/**
* This function will create an {@link InvokeHostFunctionOperationBuilder} with the "hostFunction"
* parameter preset, so that you can conveniently build an {@link InvokeHostFunctionOperation} to
* create contract.
*
* @param wasmId The hex-encoded wasm id to use for contract creation.
* @param address The address to use to derive the contract ID.
* @param salt The 32-byte salt to use to derive the contract ID, if null, a random salt will be
* generated.
* @return {@link InvokeHostFunctionOperationBuilder}
*/
public static InvokeHostFunctionOperationBuilder<?, ?> createContractOperationBuilder(
String wasmId, Address address, @Nullable byte[] salt) {
byte[] wasmIdBytes = Util.hexToBytes(wasmId);
return createContractOperationBuilder(wasmIdBytes, address, salt);
}

/**
* This function will create an {@link InvokeHostFunctionOperationBuilder} with the "hostFunction"
* parameter preset, so that you can conveniently build an {@link InvokeHostFunctionOperation} to
* create contract.
*
* @param wasmId The wasm id to use for contract creation.
* @param address The address to use to derive the contract ID.
* @param salt The 32-byte salt to use to derive the contract ID, if null, a random salt will be
* generated.
* @return {@link InvokeHostFunctionOperationBuilder}
*/
public static InvokeHostFunctionOperationBuilder<?, ?> createContractOperationBuilder(
byte[] wasmId, Address address, @Nullable byte[] salt) {
if (salt == null) {
salt = new byte[32];
new SecureRandom().nextBytes(salt);
} else if (salt.length != 32) {
throw new IllegalArgumentException("\"salt\" must be 32 bytes long");
}

if (wasmId.length != 32) {
throw new IllegalArgumentException("\"wasmId\" must be 32 bytes long");
}

CreateContractArgs createContractArgs =
new CreateContractArgs.Builder()
.contractIDPreimage(
new ContractIDPreimage.Builder()
.discriminant(ContractIDPreimageType.CONTRACT_ID_PREIMAGE_FROM_ADDRESS)
.fromAddress(
new ContractIDPreimage.ContractIDPreimageFromAddress.Builder()
.address(address.toSCAddress())
.salt(new Uint256(salt))
.build())
.build())
.executable(
new ContractExecutable.Builder()
.discriminant(ContractExecutableType.CONTRACT_EXECUTABLE_WASM)
.wasm_hash(new Hash(wasmId))
.build())
.build();
HostFunction hostFunction =
new HostFunction.Builder()
.discriminant(HostFunctionType.HOST_FUNCTION_TYPE_CREATE_CONTRACT)
.createContract(createContractArgs)
.build();
return builder().hostFunction(hostFunction);
}

/**
* This function will create an {@link InvokeHostFunctionOperationBuilder} with the "hostFunction"
* parameter preset, so that you can conveniently build an {@link InvokeHostFunctionOperation} to
* create a token contract wrapping a classic asset.
*
* @param asset The classic asset to wrap.
* @return {@link InvokeHostFunctionOperationBuilder}
*/
public static InvokeHostFunctionOperationBuilder<?, ?> createTokenContractOperationBuilder(
Asset asset) {
CreateContractArgs createContractArgs =
new CreateContractArgs.Builder()
.contractIDPreimage(
new ContractIDPreimage.Builder()
.discriminant(ContractIDPreimageType.CONTRACT_ID_PREIMAGE_FROM_ASSET)
.fromAsset(asset.toXdr())
.build())
.executable(
new ContractExecutable.Builder()
.discriminant(ContractExecutableType.CONTRACT_EXECUTABLE_TOKEN)
.build())
.build();
HostFunction hostFunction =
new HostFunction.Builder()
.discriminant(HostFunctionType.HOST_FUNCTION_TYPE_CREATE_CONTRACT)
.createContract(createContractArgs)
.build();
return builder().hostFunction(hostFunction);
}

/**
* This function will create an {@link InvokeHostFunctionOperationBuilder} with the "hostFunction"
* parameter preset, so that you can conveniently build an {@link InvokeHostFunctionOperation} to
* create a token contract wrapping a classic asset.
*
* @param address The address to use to derive the contract ID.
* @param salt The 32-byte salt to use to derive the contract ID, if null, a random salt will be
* generated.
* @return {@link InvokeHostFunctionOperationBuilder}
*/
public static InvokeHostFunctionOperationBuilder<?, ?> createTokenContractOperationBuilder(
Address address, @Nullable byte[] salt) {
if (salt == null) {
salt = new byte[32];
new SecureRandom().nextBytes(salt);
} else if (salt.length != 32) {
throw new IllegalArgumentException("\"salt\" must be 32 bytes long");
}

CreateContractArgs createContractArgs =
new CreateContractArgs.Builder()
.contractIDPreimage(
new ContractIDPreimage.Builder()
.discriminant(ContractIDPreimageType.CONTRACT_ID_PREIMAGE_FROM_ADDRESS)
.fromAddress(
new ContractIDPreimage.ContractIDPreimageFromAddress.Builder()
.address(address.toSCAddress())
.salt(new Uint256(salt))
.build())
.build())
.executable(
new ContractExecutable.Builder()
.discriminant(ContractExecutableType.CONTRACT_EXECUTABLE_TOKEN)
.build())
.build();
HostFunction hostFunction =
new HostFunction.Builder()
.discriminant(HostFunctionType.HOST_FUNCTION_TYPE_CREATE_CONTRACT)
.createContract(createContractArgs)
.build();
return builder().hostFunction(hostFunction);
}

/**
* This function will create an {@link InvokeHostFunctionOperationBuilder} with the "hostFunction"
* parameter preset, so that you can conveniently build an {@link InvokeHostFunctionOperation} to
* invoke a contract function.
*
* @see <a
* href="https://soroban.stellar.org/docs/fundamentals-and-concepts/interacting-with-contracts"
* target="_blank">Interacting with Contracts</a>
* @param contractId The ID of the contract to invoke.
* @param functionName The name of the function to invoke.
* @param parameters The parameters to pass to the method.
* @return {@link InvokeHostFunctionOperationBuilder}
*/
public static InvokeHostFunctionOperationBuilder<?, ?> invokeContractFunctionOperationBuilder(
String contractId, String functionName, @Nullable Collection<SCVal> parameters) {
Address address = new Address(contractId);
if (address.getType() != Address.AddressType.CONTRACT) {
throw new IllegalArgumentException("\"contractId\" must be a contract address");
}
SCVal contractIdScVal = address.toSCVal();
SCVal functionNameScVal =
new SCVal.Builder()
.discriminant(SCValType.SCV_SYMBOL)
.sym(new SCSymbol(new XdrString(functionName)))
.build();

List<SCVal> invokeContractParams =
new ArrayList<>(2 + (parameters != null ? parameters.size() : 0));
invokeContractParams.add(contractIdScVal);
invokeContractParams.add(functionNameScVal);
if (parameters != null) {
for (SCVal parameter : parameters) {
if (parameter == null) {
throw new IllegalArgumentException("\"parameters\" contains null element");
}
invokeContractParams.add(parameter);
}
}

HostFunction hostFunction =
new HostFunction.Builder()
.discriminant(HostFunctionType.HOST_FUNCTION_TYPE_INVOKE_CONTRACT)
.invokeContract(new SCVec(invokeContractParams.toArray(new SCVal[0])))
.build();
return builder().hostFunction(hostFunction);
}

@Override
org.stellar.sdk.xdr.Operation.OperationBody toOperationBody(AccountConverter accountConverter) {
InvokeHostFunctionOp op = new InvokeHostFunctionOp();
Expand Down
Loading
Loading