com.klaytn.caver.account.AccountKeyNil Maven / Gradle / Ivy
/*
* Copyright 2020 The caver-java Authors
*
* Licensed under the Apache License, Version 2.0 (the “License”);
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an “AS IS” BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.klaytn.caver.account;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.klaytn.caver.tx.account.AccountKeyRoleBased;
import org.web3j.utils.Numeric;
import java.io.IOException;
/**
* AccountKeyNil represents an empty key. If an account tries to having an AccountKeyNil object,
* the transaction will be failed. AccountKeyNil is only used only for TxTypeAccountUpdate transactions
* with role-based keys. For example, if an account tries to update RoleAccountUpdate key only, the key
* field of the TxTypeAccountUpdate transaction would be: [AccountKeyNil, NewKey, AccountKeyNil]
* Then, only the RoleAccountUpdate key is updated. Other roles are not updated.
*/
@JsonSerialize(using = AccountKeyNil.AccountKeyNilSerializer.class)
public class AccountKeyNil implements IAccountKey{
/**
* AccountKeyNil's RLP-Encoded data
*/
private static final byte[] RLP = new byte[]{(byte) 0x80};
/**
* Creates an AccountKeyNil instance.
*/
public AccountKeyNil() {
}
/**
* Decodes a RLP-encoded AccountKeyNil string
* @param rlpEncodedKey RLP-encoded AccountKeyNil string
* @return AccountKeyNil
*/
public static AccountKeyNil decode(String rlpEncodedKey) {
return decode(Numeric.hexStringToByteArray(rlpEncodedKey));
}
/**
* Decodes a RLP-encoded AccountKeyNil byte array
* @param rlpEncodedKey RLP-encoded AccountKeyNil byte array
* @return AccountKeyNil
*/
public static AccountKeyNil decode(byte[] rlpEncodedKey) {
if (rlpEncodedKey.length != 1 || rlpEncodedKey[0] != RLP[0]) {
throw new IllegalArgumentException("Invalid RLP-encoded AccountKeyNil");
}
return new AccountKeyNil();
}
/**
* Encodes a AccountKeyNil Object by an RLP-Encoding method.
* @return RLP-encoded AccountKeyNil String
*/
@Override
public String getRLPEncoding() {
return Numeric.toHexString(RLP);
}
/**
* Return an AccountKeyNil's type attribute.
* @return AccountKeyNil's type attribute.
*/
public static String getType() {
return Numeric.toHexString(RLP);
}
/**
* Serialize class to AccountKeyNil object into JSON.
*/
public static class AccountKeyNilSerializer extends JsonSerializer {
@Override
public void serialize(AccountKeyNil value, JsonGenerator gen, SerializerProvider serializers) throws IOException, JsonProcessingException {
gen.writeStartObject();
gen.writeFieldName("keyType");
gen.writeNumber(0);
gen.writeFieldName("key");
gen.writeStartObject();
gen.writeEndObject();
gen.writeEndObject();
}
}
}