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.

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

[Don't Merge] Fix publish maven, fix javadocs #690

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ name: Continuous delivery in GitHub and Maven Central Repository

on:
push:
tags:
- 'rc/v*'
branch:
- 'eval-exec/exec/fix-publish'

jobs:
create_release_draft:
Expand Down
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# 3.0.1 (2024-12-10)
- fix: fix javaDocs error

# 3.0.0 (2024-11-26)
- feat: support indexer filter script_len_range
- feat: support v0.119.0 rpcs #683
Expand Down
6 changes: 3 additions & 3 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ apply plugin: 'io.codearte.nexus-staging'
mainClassName = 'org.nervos.ckb.example.RpcExample'
applicationName = 'ckb-sdk-java'

description 'ckb-sdk-java base project'
description = 'ckb-sdk-java base project'

allprojects {

sourceCompatibility = 1.8
targetCompatibility = 1.8

group 'org.nervos.ckb'
version '3.0.0'
version '3.0.1'
apply plugin: 'java'

repositories {
Expand Down Expand Up @@ -105,7 +105,7 @@ configure(subprojects.findAll { it.name != 'tests' }) {
publications {
mavenJava(MavenPublication) {
groupId 'org.nervos.ckb'
version '3.0.0'
version '3.0.1'
from components.java

pom {
Expand Down
2 changes: 1 addition & 1 deletion ckb/src/main/java/org/nervos/ckb/CkbRpcApi.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ default TransactionWithStatus getTransaction(@Nonnull byte[] transactionHash) th
*
* @param transactionHash the transaction hash
* @return the RPC does not return the transaction content and the field transaction must be null.
* @throws IOException
* @throws IOException RPC Errors
*/
default TransactionWithStatus getTransactionStatus(@Nonnull byte[] transactionHash) throws IOException {
return getTransactionStatus(transactionHash, null);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ public abstract class AbstractTransactionBuilder {
*
* @param configuration This is the bundle of configuration for builder,
* such as fee rate and registerred {@link org.nervos.ckb.transaction.handler.ScriptHandler}.
* @param availableInputs This is the iterator of available inputs for the transaction.
*/
public AbstractTransactionBuilder(TransactionBuilderConfiguration configuration, Iterator<TransactionInput> availableInputs) {
this.configuration = configuration;
Expand Down Expand Up @@ -101,6 +102,7 @@ protected static long calculateTxFee(Transaction transaction, long feeRate) {
* default context null. Use {@link #build(Object...)} to pass custom contexts.
*
* @see org.nervos.ckb.transaction.handler.ScriptHandler#buildTransaction(AbstractTransactionBuilder, ScriptGroup, Object)
* @return none
*/
public TransactionWithScriptGroups build() {
return build((Object) null);
Expand Down Expand Up @@ -149,6 +151,8 @@ public Map<Script, ScriptGroup> rebuildScriptGroups(Map<Script, ScriptGroup> scr
* The contexts will be passed to the registered script handlers in the same order.
*
* @see org.nervos.ckb.transaction.handler.ScriptHandler#buildTransaction(AbstractTransactionBuilder, ScriptGroup, Object)
* @param contexts objects
* @return none
*/
abstract TransactionWithScriptGroups build(Object... contexts);
}
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ public CkbTransactionBuilder(TransactionBuilderConfiguration configuration, Iter
* Add a potential input for the transaction.
* <p>
* The input may not be actually used if there's already enough capacity for the outputs.
* @param transactionInput the transactionInput
* @return none
*/
public CkbTransactionBuilder addInput(TransactionInput transactionInput) {
transactionInputs.add(transactionInput);
Expand All @@ -45,6 +47,9 @@ public CkbTransactionBuilder addHeaderDep(String headerDep) {

/**
* Add outputs and data. The two parameters should have the same size.
* @param outputs the outputs
* @param outputsData the outputsData
* @return none
*/
public CkbTransactionBuilder setOutputs(List<CellOutput> outputs, List<byte[]> outputsData) {
tx.outputs.addAll(outputs);
Expand Down Expand Up @@ -75,6 +80,9 @@ public CkbTransactionBuilder addDaoDepositOutput(String address, long capacity)
* Set possible change output. Its capacity must be 0.
* <p>
* Change output should be set only once.
* @param output the change output
* @param data the data
* @return none
*/
public CkbTransactionBuilder setChangeOutput(@Nonnull CellOutput output, @Nonnull byte[] data) {
if (changeOutput != null) {
Expand All @@ -92,6 +100,8 @@ public CkbTransactionBuilder setChangeOutput(@Nonnull CellOutput output, @Nonnul
* Set possible change output address.
* <p>
* Change output should be set only once.
* @param address the address of change output
* @return none
*/
public CkbTransactionBuilder setChangeOutput(@Nonnull String address) {
CellOutput output = new CellOutput(0, Address.decode(address).getScript());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ public interface ScriptHandler {
*
* <p>For example:</p>
*
* <pre>{@code
* @Override
* <pre>
* {@code
* boolean buildTransaction(AbstractTransactionBuilder txBuilder, ScriptGroup scriptGroup, Object context) {
* // Only change the transaction when the script is used.
* if (scriptGroup == null || !isMatched(scriptGroup.getScript())) {
Expand Down
6 changes: 3 additions & 3 deletions core/src/main/java/org/nervos/ckb/sign/ScriptSigner.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ public interface ScriptSigner {
* @param context This is passed from {@code TransactionSigner.signTransaction}
* @return {@code true} when the script handler has modified the transaction.
*
* @see TransactionSigner#signTransaction(TransactionWithScriptGroups, Context...)
* @see TransactionSigner#signTransaction(TransactionWithScriptGroups, Set<Context>)
* @see TransactionSigner#signTransaction(TransactionWithScriptGroups, String...)
* @see "TransactionSigner#signTransaction(TransactionWithScriptGroups, Context...)"
* @see "TransactionSigner#signTransaction(TransactionWithScriptGroups, Set<Context>)"
* @see "TransactionSigner#signTransaction(TransactionWithScriptGroups, String...)"
*/
boolean signTransaction(Transaction transaction, ScriptGroup scriptGroup, Context context);
}
Loading