Chainsql (ChainSQL JAVA API 3.0.0 API)

java.lang.Object
- com.peersafe.chainsql.core.Submit
- - com.peersafe.chainsql.core.Chainsql

```
public class Chainsql
extends Submit
```

嵌套类概要
- 从类继承的嵌套类/接口 com.peersafe.chainsql.core.Submit
  Submit.CrossChainArgs, Submit.SchemaOpType, Submit.SubmitState, Submit.SyncCond, Submit.SyncState

字段概要

字段
限定符和类型字段和说明

EventManager event

static Logger logger

static String MAIN_SCHEMA
- 从类继承的字段 com.peersafe.chainsql.core.Submit
  cache, cb, condition, connection, crossChainArgs, eventManager, extraDrop, mapToken, needVerify, schemaCreateTx, schemaModifyTx, signed, strictMode, transaction

字段
限定符和类型	字段和说明
`EventManager`	`event`
`static Logger`	`logger`
`static String`	`MAIN_SCHEMA`

构造器概要

构造器
构造器和说明

Chainsql()

构造器
构造器和说明
`Chainsql()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`Ripple`	`accountSet(int nFlag, boolean bSet)` accountSet
`Ripple`	`accountSet(String transferRate, String transferFeeMin, String transferFeeMax)`
`Chainsql`	`addTableFields(String name, List<String> rawList)` Add fields for a table
`static List<String>`	`array(String val0, String... vals)` Transfer variable number of Strings to List of String
`void`	`as(String address, String secret)` Assigning the operating user.
`void`	`beginTran()` Begin a sql-transaction type operation.
`org.json.JSONObject`	`commit()` Commit a sql-transaction type operation.
`org.json.JSONObject`	`commit(Publisher.Callback<?> cb)` Commit sql-transactoin asynchronously.
`org.json.JSONObject`	`commit(Submit.SyncCond cond)` Commit sql-transactoin synchronously.
`Connection`	`connect(String url)` Connect to a websocket url.
`Connection`	`connect(String url, Publisher.Callback<Client> connectCb)` Connect to a websocket url.
`Connection`	`connect(String url, Publisher.Callback<Client> connectCb, Publisher.Callback<Client> disconnectCb)` Connect to a websocket url.
`Connection`	`connect(String url, String serverCertPath, String storePass)` Connect to a secure websocket url.
`Connection`	`connect(String url, String serverCertPath, String storePass, Publisher.Callback<Client> connectCb)` Connect to a secure websocket url.
`Connection`	`connect(String url, String serverCertPath, String storePass, Publisher.Callback<Client> connectCb, Publisher.Callback<Client> disconnectCb)` Connect to a secure websocket url.
`Chainsql`	`createIndex(String name, List<String> rawList)` Add fields for a table
`Ripple`	`createRippleTransaction(org.json.JSONObject tx_json)` Start a Ripple transaction
`Chainsql`	`createSchema(org.json.JSONObject schemaInfo)` SchemaName String withState ture 锚定区块
`Chainsql`	`createTable(String name, List<String> raw)` A create table operation.
`Chainsql`	`createTable(String name, List<String> rawList, boolean confidential)` A create table operation.
`Chainsql`	`createTable(String name, List<String> raw, org.json.JSONObject operationRule)` Create table with operation-rule
`String`	`decrypt(String cipher, String secret)` 解密接口
`Chainsql`	`deleteIndex(String name, List<String> rawList)` Add fields for a table
`Chainsql`	`deleteTableFields(String name, List<String> rawList)` Add fields for a table
`void`	`disconnect()` Disconnect the websocket connection.
`org.json.JSONObject`	`doCommit(Object commitType)` sqlTransaction commit
`Chainsql`	`dropTable(String name)` A drop table operation.
`String`	`encrypt(String plainText, List<String> listPublicKey)` 加密接口
`Ripple`	`escrowCancel(String sOwner, int nCreateEscrowSeq)`
`Ripple`	`escrowCreate(String sDestAddr, String value, String dateFormatTMFinish, String dateFormatTMCancel)`
`Ripple`	`escrowCreate(String sDestAddr, String value, String sCurrency, String sIssuer, String dateFormatTMFinish, String dateFormatTMCancel)`
`Ripple`	`escrowExecute(String sOwner, int nCreateEscrowSeq)`
`org.json.JSONObject`	`generateAddress()` Generate a new account.
`org.json.JSONObject`	`generateAddress(org.json.JSONObject options)` generate address
`org.json.JSONObject`	`generateAddress(String secret)`
`String`	`getAccountBalance(String address)`
`org.json.JSONObject`	`getAccountInfo(String address)`
`org.json.JSONObject`	`getAccountTables(String address, boolean bGetDetail)` 获取账户建的表
`void`	`getAccountTables(String address, boolean bGetDetail, Publisher.Callback<org.json.JSONObject> cb)` 获取账户建的表
`org.json.JSONObject`	`getAccountTransactions(String address)` Get trasactions submitted by notified account.
`org.json.JSONObject`	`getAccountTransactions(String address, int limit)` Get trasactions submitted by notified account,asynchronous.
`void`	`getAccountTransactions(String address, int limit, Publisher.Callback<org.json.JSONObject> cb)` Get trasactions submitted by notified account,asynchronous.
`void`	`getAccountTransactions(String address, Publisher.Callback<org.json.JSONObject> cb)` Get trasactions submitted by notified account,asynchronous.
`org.json.JSONObject`	`getBySqlAdmin(String sql)` 根据sql语句查询，admin接口，同步调用
`void`	`getBySqlAdmin(String sql, Publisher.Callback<org.json.JSONObject> cb)` 根据sql语句查询，admin接口，异步调用
`org.json.JSONObject`	`getBySqlUser(String sql)` 根据sql语句查询，普通用户接口，需签名验证
`void`	`getBySqlUser(String sql, Publisher.Callback<org.json.JSONObject> cb)` 根据sql语句查询，普通用户接口，异步调用
`org.json.JSONObject`	`getChainInfo()`
`Connection`	`getConnection()`
`org.json.JSONObject`	`getCrossChainTxs(String hash, int limit, boolean include)` Get transactions from chain
`org.json.JSONObject`	`getLedger()` Get the newest generated ledger.
`org.json.JSONObject`	`getLedger(Integer ledger_index)` Get the ledger identified by ledger_index.
`void`	`getLedger(Integer ledger_index, Publisher.Callback<org.json.JSONObject> cb)` Get the ledger identified by ledger_index.
`void`	`getLedger(Publisher.Callback<org.json.JSONObject> cb)` An asynchronous api to get the ledger identified by ledger_index.
`org.json.JSONObject`	`getLedgerTxs(Integer ledgerSeq, boolean bIncludeSuccess, boolean bIncludefailure)` 获取区块中的交易，在bIncludeSuccess与bIncludefailure都为false的情况下，只返回成功与失败的交易数量
`void`	`getLedgerTxs(Integer ledgerSeq, boolean bIncludeSuccess, boolean bIncludefailure, Publisher.Callback<org.json.JSONObject> cb)` 获取区块中的交易，在bIncludeSuccess与bIncludefailure都为false的情况下，只返回成功与失败的交易数量
`org.json.JSONObject`	`getLedgerVersion()` Get newest validated ledger index
`void`	`getLedgerVersion(Publisher.Callback<org.json.JSONObject> cb)` Get newest validated ledger index,asynchronous.
`org.json.JSONObject`	`getPeers()` Get server info.
`org.json.JSONObject`	`getSchemaInfo(String schemaID)` 查询子链的信息
`org.json.JSONObject`	`getSchemaList(org.json.JSONObject params)` Get schema list.
`org.json.JSONObject`	`getServerInfo()` Get server info.
`org.json.JSONObject`	`getTableAuth(String owner, String tableName)` 获取表授权列表
`org.json.JSONObject`	`getTableAuth(String owner, String tableName, List<String> accounts)` 获取表授权列表
`void`	`getTableAuth(String owner, String tableName, List<String> accounts, Publisher.Callback<org.json.JSONObject> cb)` 获取表授权列表
`void`	`getTableAuth(String owner, String tableName, Publisher.Callback<org.json.JSONObject> cb)` 获取表授权列表
`org.json.JSONObject`	`getTableNameInDB(String owner, String tableName)` 获取表的NameInDB字符串
`void`	`getTableNameInDB(String owner, String tableName, Publisher.Callback<org.json.JSONObject> cb)`
`org.json.JSONObject`	`getTransaction(org.json.JSONObject txInfo)` Get transaction identified by hash.
`org.json.JSONObject`	`getTransaction(String hash)` Get transaction identified by hash.
`void`	`getTransaction(String hash, Publisher.Callback<org.json.JSONObject> cb)` Get transaction by hash asynrhonously.
`org.json.JSONObject`	`getUnlList()` Get validation publickey list
`Chainsql`	`grant(String name, String user, String flag)` Grant a user with authorities to operate a table.
`Chainsql`	`grant(String name, String user, String userPublicKey, String flag)` Grant a user with authorities to operate a table.
`boolean`	`isUseGM()`
`Chainsql`	`modifySchema(Submit.SchemaOpType type, org.json.JSONObject schemaInfo)`
`Chainsql`	`modifyTableFields(String name, List<String> rawList)` Add fields for a table
`void`	`onReconnected(Publisher.Callback<org.json.JSONObject> cb)` Subscribe 'reconnected' event,cb.called trigger when connection lost and reconnect succeed.
`void`	`onReconnecting(Publisher.Callback<org.json.JSONObject> cb)` Subscribe 'reconnecting' event,cb.called trigger when connection lost and reconnecting started.
`Ripple`	`pay(String accountId, String value)` Start a payment transaction, can be used to activate account
`Ripple`	`pay(String accountId, String value, String sCurrency, String sIssuer)`
`Ripple`	`payToContract(String contract_address, String value, int gasLimit)`
`protected org.json.JSONObject`	`prepareSigned()`
`Chainsql`	`recreateTable(String name)` Recreate a table, for slimming the chain.
`Chainsql`	`renameTable(String oldName, String newName)` Rename a table.
`Chainsql`	`report()`
`void`	`setExtraFee(int extraDrop)`
`void`	`setSchema(String schemaID)` 设置操作链的ID
`void`	`setUseGM(boolean useGM, boolean bNewKeyPair, String pin)` use guomi algorithm
`static void`	`shutdown()`
`byte[]`	`sign(byte[] message, String secret)` 签名接口
`org.json.JSONObject`	`sign(org.json.JSONObject tx, String secret)` Sign a transaction.
`org.json.JSONObject`	`signFor(org.json.JSONObject tx, String secret)` sign for
`Table`	`table(String name)` Create a Table object by giving a table name.
`Ripple`	`trustSet(String value, String sCurrency, String sIssuer)`
`void`	`use(String address)` Assigning table owner.
`void`	`useCert(String userCert)`
`org.json.JSONObject`	`validationCreate()` Create validation keys.
`org.json.JSONArray`	`validationCreate(int count)` Create validation key
`org.json.JSONObject`	`validationCreate(org.json.JSONObject options)`
`boolean`	`verify(byte[] message, byte[] signature, String publicKey)` 验证签名接口
`Ripple`	`whitelistSet(org.json.JSONArray whitelists, int setFlag)`

从类继承的方法 com.peersafe.chainsql.core.Submit
doSubmit, doSubmitNoPrepare, eventManager, getTableArray, isCrossChainArgsSet, mapError, setCrossChainArgs, setCrossChainArgs, setNeedVerify, setRestrict, submit, submit, submit, toTransaction

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - logger
```
public static final Logger logger
```
  - MAIN_SCHEMA
```
public static String MAIN_SCHEMA
```
  - event
```
public final EventManager event
```
- 构造器详细资料
  - Chainsql
```
public Chainsql()
```
- 方法详细资料
  - as
```
public void as(String address,
               String secret)
```
    Assigning the operating user.
    
    参数:
    
    address - Account address,start with a lower case 'z'.
    
    secret - Account secret,start with a lower case 'x'.
  - useCert
```
public void useCert(String userCert)
```
  - setSchema
```
public void setSchema(String schemaID)
```
    设置操作链的ID
    
    参数:
    
    schemaID - schemaID="" 代表操作的是主链;
  - use
```
public void use(String address)
```
    Assigning table owner.
    
    参数:
    
    address - Address of table owner.
  - connect
```
public Connection connect(String url)
```
    Connect to a websocket url.
    
    参数:
    
    url - Websocket url to connect,e.g.:"ws://127.0.0.1:5006".
    
    返回:
    
    Connection object after connected.
  - connect
```
public Connection connect(String url,
                          String serverCertPath,
                          String storePass)
```
    Connect to a secure websocket url.
    
    参数:
    
    url - url,e.g.:"ws://127.0.0.1:5006".
    
    serverCertPath - server certificate path
    
    storePass - password
    
    返回:
    
    Connection
  - connect
```
public Connection connect(String url,
                          Publisher.Callback<Client> connectCb)
```
    Connect to a websocket url.
    
    参数:
    
    url - Websocket url to connect,e.g.:"ws://127.0.0.1:5006".
    
    connectCb - callback when connected
    
    返回:
    
    Connection object after connected.
  - connect
```
public Connection connect(String url,
                          Publisher.Callback<Client> connectCb,
                          Publisher.Callback<Client> disconnectCb)
```
    Connect to a websocket url.
    
    参数:
    
    url - Websocket url to connect,e.g.:"ws://127.0.0.1:5006".
    
    connectCb - callback when connected
    
    disconnectCb - callback when disconnected
    
    返回:
    
    Connection object after connected.
  - connect
```
public Connection connect(String url,
                          String serverCertPath,
                          String storePass,
                          Publisher.Callback<Client> connectCb)
```
    Connect to a secure websocket url.
    
    参数:
    
    url - url,e.g.:"ws://127.0.0.1:5006".
    
    serverCertPath - server certificate path
    
    storePass - password
    
    connectCb - callback when connected
    
    返回:
    
    Connection
  - connect
```
public Connection connect(String url,
                          String serverCertPath,
                          String storePass,
                          Publisher.Callback<Client> connectCb,
                          Publisher.Callback<Client> disconnectCb)
```
    Connect to a secure websocket url.
    
    参数:
    
    url - url,e.g.:"ws://127.0.0.1:5006".
    
    serverCertPath - server certificate path
    
    storePass - password
    
    connectCb - callback when connected
    
    disconnectCb - callback when disconnected
    
    返回:
    
    Connection
  - shutdown
```
public static void shutdown()
```
  - array
```
public static List<String> array(String val0,
                                 String... vals)
```
    Transfer variable number of Strings to List of String
    
    参数:
    
    val0 - Parameter
    
    vals - Parameter
    
    返回:
    
    List of String
  - onReconnected
```
public void onReconnected(Publisher.Callback<org.json.JSONObject> cb)
```
    Subscribe 'reconnected' event,cb.called trigger when connection lost and reconnect succeed.
    
    参数:
    
    cb - Callback
  - onReconnecting
```
public void onReconnecting(Publisher.Callback<org.json.JSONObject> cb)
```
    Subscribe 'reconnecting' event,cb.called trigger when connection lost and reconnecting started.
    
    参数:
    
    cb - Callback
  - disconnect
```
public void disconnect()
```
    Disconnect the websocket connection.
  - table
```
public Table table(String name)
```
    Create a Table object by giving a table name.
    
    参数:
    
    name - Name of a table.
    
    返回:
    
    Table object.
  - setUseGM
```
public void setUseGM(boolean useGM,
                     boolean bNewKeyPair,
                     String pin)
              throws Exception
```
    use guomi algorithm
    
    参数:
    
    useGM - 是否使用国密
    
    bNewKeyPair - 是否生成新的公私钥对
    
    pin - default is '666666'
    
    抛出:
    
    Exception - throws exception if failed.
  - isUseGM
```
public boolean isUseGM()
```
  - sign
```
public org.json.JSONObject sign(org.json.JSONObject tx,
                                String secret)
```
    Sign a transaction.
    
    参数:
    
    tx - transaction Json.
    
    secret - Secret used to sign
    
    返回:
    
    tx_blob and hash: { "tx_blob":"xxxxx", "hash":"xxx" }
  - signFor
```
public org.json.JSONObject signFor(org.json.JSONObject tx,
                                   String secret)
```
    sign for
    
    参数:
    
    tx - transaction Json.
    
    secret - Secret used to sign
    
    返回:
    
    sign result form: { "Signer":{ "Account":"rDsFXt1KRDNNckSh3exyTqkQeBKQCXawb2", "SigningPubKey":"02E37D565DF377D0C30D93163CF40F41BB81B966B11757821F25FBCDCFEA18E8A9", "TxnSignature":"3044022050903320FF924BCD7F55D3BE095A457BF2421E805C5B39DA77F006BB217D6398022024C51DECA25018D80CB16AB65674B71BFD20789D63EC47FD5EAD7FC75B880055" }, "hash":"" }
  - prepareSigned
```
protected org.json.JSONObject prepareSigned()
```
    指定者:
    
    prepareSigned 在类中 Submit
  - setExtraFee
```
public void setExtraFee(int extraDrop)
                 throws Exception
```
    参数:
    
    extraDrop - 额外的费用,单位为drop
    
    抛出:
    
    Exception
  - createTable
```
public Chainsql createTable(String name,
                            List<String> raw)
```
    A create table operation.
    
    参数:
    
    name - Table name
    
    raw - Option or conditions to create a table.
    
    返回:
    
    You can use this to call other Chainsql functions continuely.
  - createTable
```
public Chainsql createTable(String name,
                            List<String> raw,
                            org.json.JSONObject operationRule)
```
    Create table with operation-rule
    
    参数:
    
    name - Table name
    
    raw - Option or conditions to create a table.
    
    operationRule - Conditions to operate this table,this is a json-string like: "{ 'Insert':{ 'Condition':{'account':'$account','txid':'$tx_hash'}, 'Count':{'AccountField':'account','CountLimit':5} }, 'Update':{ 'Condition':{'$or':[{'age':{'$le':28}},{'id':2}]}, 'Fields':['age'] }, 'Delete':{ 'Condition':{'age':'$lt18'} }, 'Get':{ 'Condition':{'id':{'$ge':3}} } }"
    
    返回:
    
    You can use this to call other Chainsql functions continuely.
  - createTable
```
public Chainsql createTable(String name,
                            List<String> rawList,
                            boolean confidential)
```
    A create table operation.
    
    参数:
    
    name - Table name.
    
    rawList - Option or conditions to create a table.
    
    confidential - Table will be confidential or not.
    
    返回:
    
    You can use this to call other Chainsql functions continuely.
  - createSchema
```
public Chainsql createSchema(org.json.JSONObject schemaInfo)
                      throws Exception
```
    SchemaName String withState ture 锚定区块
    
    返回:
    
    抛出:
    
    Exception
  - modifySchema
```
public Chainsql modifySchema(Submit.SchemaOpType type,
                             org.json.JSONObject schemaInfo)
                      throws Exception
```
    抛出:
    
    Exception
  - recreateTable
```
public Chainsql recreateTable(String name)
```
    Recreate a table, for slimming the chain.
    
    参数:
    
    name - Table name.
    
    返回:
    
    You can use this to call other Chainsql functions continuely.
  - dropTable
```
public Chainsql dropTable(String name)
```
    A drop table operation.
    
    参数:
    
    name - Table name.
    
    返回:
    
    You can use this to call other Chainsql functions continuely.
  - renameTable
```
public Chainsql renameTable(String oldName,
                            String newName)
```
    Rename a table.
    
    参数:
    
    oldName - Old table name.
    
    newName - New table name.
    
    返回:
    
    You can use this to call other Chainsql functions continuely.
  - addTableFields
```
public Chainsql addTableFields(String name,
                               List<String> rawList)
                        throws Exception
```
    Add fields for a table
    
    参数:
    
    name - Table name
    
    rawList - Raw specifing the new fields.
    
    返回:
    
    抛出:
    
    Exception
  - deleteTableFields
```
public Chainsql deleteTableFields(String name,
                                  List<String> rawList)
                           throws Exception
```
    Add fields for a table
    
    参数:
    
    name - Table name
    
    rawList - Raw specifing the new fields.
    
    返回:
    
    抛出:
    
    Exception
  - modifyTableFields
```
public Chainsql modifyTableFields(String name,
                                  List<String> rawList)
                           throws Exception
```
    Add fields for a table
    
    参数:
    
    name - Table name
    
    rawList - Raw specifing the fields to modify.
    
    返回:
    
    抛出:
    
    Exception
  - createIndex
```
public Chainsql createIndex(String name,
                            List<String> rawList)
                     throws Exception
```
    Add fields for a table
    
    参数:
    
    name - Table name
    
    rawList - Raw specifing the index to create.
    
    返回:
    
    抛出:
    
    Exception
  - deleteIndex
```
public Chainsql deleteIndex(String name,
                            List<String> rawList)
                     throws Exception
```
    Add fields for a table
    
    参数:
    
    name - Table name
    
    rawList - Indexes name to delete.
    
    返回:
    
    抛出:
    
    Exception
  - grant
```
public Chainsql grant(String name,
                      String user,
                      String userPublicKey,
                      String flag)
```
    Grant a user with authorities to operate a table.
    
    参数:
    
    name - Table name
    
    user - User address,start with a lower case 'z'.
    
    userPublicKey - User's public key,start with a lower case 'c'. Will be used if the table is confidential.
    
    flag - Options to notify the authorities.eg:"{insert:true,delete:false}" means the user can insert to this table,but cannot delete from this table.
    
    返回:
    
    You can use this to call other Chainsql functions continuely.
  - grant
```
public Chainsql grant(String name,
                      String user,
                      String flag)
```
    Grant a user with authorities to operate a table.
    
    参数:
    
    name - Table name
    
    user - User address,start with a lower case 'z'.
    
    flag - Options to notify the authorities.eg:"{insert:true,delete:false}" means the user can insert to this table,but cannot delete from this table.
    
    返回:
    
    You can use this to call other Chainsql functions continuely.
  - createRippleTransaction
```
public Ripple createRippleTransaction(org.json.JSONObject tx_json)
```
    Start a Ripple transaction
    
    参数:
    
    tx_json - transaction tx_json
    
    返回:
    
    You can use this to call other Ripple functions continually.
  - pay
```
public Ripple pay(String accountId,
                  String value)
```
    Start a payment transaction, can be used to activate account
    
    参数:
    
    accountId - The Address of an account.
    
    value - Count of coins to transfer,Unit:ZXC,max value:1e11.
    
    返回:
    
    You can use this to call other Ripple functions continually.
  - pay
```
public Ripple pay(String accountId,
                  String value,
                  String sCurrency,
                  String sIssuer)
```
    参数:
    
    accountId - The Address of an account.
    
    value - Count of coins to transfer,max value:1e11.
    
    sCurrency - Arbitrary code for currency.
    
    sIssuer - currency Issuer address
    
    返回:
    
    You can use this to call other Ripple functions continually.
  - payToContract
```
public Ripple payToContract(String contract_address,
                            String value,
                            int gasLimit)
```
    参数:
    
    contract_address - The Address of a contract account.
    
    value - Count of coins to transfer.
    
    gasLimit - The maximum amount of gas available
    
    返回:
    
    You can use this to call other Ripple functions continually.
  - escrowCreate
```
public Ripple escrowCreate(String sDestAddr,
                           String value,
                           String dateFormatTMFinish,
                           String dateFormatTMCancel)
                    throws Exception
```
    参数:
    
    sDestAddr - Address to receive escrowed amount
    
    value - Amounts to escrow,Unit:ZXC.
    
    dateFormatTMFinish - The time(format:yyyy-MM-dd HH:mm:ss), in seconds since the Ripple Epoch, when the escrowed ZXC can be released to the recipient,use "" if not set.
    
    dateFormatTMCancel - The time(format:yyyy-MM-dd HH:mm:ss), in seconds since the Ripple Epoch, when this escrow expires,use "" if not set.
    
    返回:
    
    You can use this to call other Chainsql functions continually.
    
    抛出:
    
    Exception - Exceptions.
  - escrowCreate
```
public Ripple escrowCreate(String sDestAddr,
                           String value,
                           String sCurrency,
                           String sIssuer,
                           String dateFormatTMFinish,
                           String dateFormatTMCancel)
                    throws Exception
```
    参数:
    
    sDestAddr - Address to receive escrowed amount
    
    value - Amounts to escrow
    
    sCurrency - Arbitrary code for currency.
    
    sIssuer - currency Issuer
    
    dateFormatTMFinish - The time(format:yyyy-MM-dd HH:mm:ss), in seconds since the Ripple Epoch, when the escrowed coin can be released to the recipient,use "" if not set.
    
    dateFormatTMCancel - The time(format:yyyy-MM-dd HH:mm:ss), in seconds since the Ripple Epoch, when this escrow expires,use "" if not set.
    
    返回:
    
    You can use this to call other Chainsql functions continually.
    
    抛出:
    
    Exception - Exceptions.
  - escrowExecute
```
public Ripple escrowExecute(String sOwner,
                            int nCreateEscrowSeq)
```
    参数:
    
    sOwner - Address of the source account that funded the held payment.
    
    nCreateEscrowSeq - Transaction sequence of EscrowCreate transaction that created the held payment to finish.
    
    返回:
    
    You can use this to call other Ripple functions continually.
  - escrowCancel
```
public Ripple escrowCancel(String sOwner,
                           int nCreateEscrowSeq)
```
    参数:
    
    sOwner - Address of the source account that funded the held payment.
    
    nCreateEscrowSeq - Transaction sequence of EscrowCreate transaction that created the held payment to finish.
    
    返回:
    
    You can use this to call other Ripple functions continually.
  - accountSet
```
public Ripple accountSet(int nFlag,
                         boolean bSet)
```
    accountSet
    
    参数:
    
    nFlag - accountSet flag which can be enable or disabled for an account
    
    bSet - true:SetFlag; false:ClearFlag
    
    返回:
    
    You can use this to call other Ripple functions continually.
  - accountSet
```
public Ripple accountSet(String transferRate,
                         String transferFeeMin,
                         String transferFeeMax)
                  throws Exception
```
    参数:
    
    transferRate - 1.0 - 2.0 string
    
    transferFeeMin - decimal number string
    
    transferFeeMax - decimal number string
    
    返回:
    
    You can use this to call other Ripple functions continually.
    
    抛出:
    
    Exception
  - whitelistSet
```
public Ripple whitelistSet(org.json.JSONArray whitelists,
                           int setFlag)
                    throws Exception
```
    抛出:
    
    Exception
  - trustSet
```
public Ripple trustSet(String value,
                       String sCurrency,
                       String sIssuer)
```
    参数:
    
    value - Amounts to escrow
    
    sCurrency - Arbitrary code for currency.
    
    sIssuer - currency Issuer
    
    返回:
    
    You can use this to call other Ripple functions continually.
  - beginTran
```
public void beginTran()
```
    Begin a sql-transaction type operation. Sql-transaction is like the transaction in db. Transactions in it will all success or all rollback.
  - commit
```
public org.json.JSONObject commit()
```
    Commit a sql-transaction type operation.
    
    返回:
    
    Commit result.
  - report
```
public Chainsql report()
```
  - getServerInfo
```
public org.json.JSONObject getServerInfo()
```
    Get server info.
    
    返回:
    
    Server's informations.
  - getPeers
```
public org.json.JSONObject getPeers()
```
    Get server info.
    
    返回:
    
    Server's informations.
  - getChainInfo
```
public org.json.JSONObject getChainInfo()
```
  - getLedger
```
public org.json.JSONObject getLedger()
```
    Get the newest generated ledger.
    
    返回:
    
    Ledger data.
  - getLedger
```
public org.json.JSONObject getLedger(Integer ledger_index)
```
    Get the ledger identified by ledger_index.
    
    参数:
    
    ledger_index - Index of a ledger.
    
    返回:
    
    Ledger informations.
  - getLedger
```
public void getLedger(Publisher.Callback<org.json.JSONObject> cb)
```
    An asynchronous api to get the ledger identified by ledger_index.
    
    参数:
    
    cb - Callback.
  - getLedger
```
public void getLedger(Integer ledger_index,
                      Publisher.Callback<org.json.JSONObject> cb)
```
    Get the ledger identified by ledger_index.
    
    参数:
    
    ledger_index - Ledger index.
    
    cb - Callback.
  - getLedgerVersion
```
public org.json.JSONObject getLedgerVersion()
```
    Get newest validated ledger index
    
    返回:
    
    LedgerVersion data
  - getLedgerVersion
```
public void getLedgerVersion(Publisher.Callback<org.json.JSONObject> cb)
```
    Get newest validated ledger index,asynchronous.
    
    参数:
    
    cb - Callback.
  - getAccountTransactions
```
public org.json.JSONObject getAccountTransactions(String address,
                                                  int limit)
```
    Get trasactions submitted by notified account,asynchronous.
    
    参数:
    
    address - Account address.
    
    limit - Max transaction count to get.
    
    返回:
    
    Result.
  - getCrossChainTxs
```
public org.json.JSONObject getCrossChainTxs(String hash,
                                            int limit,
                                            boolean include)
```
    Get transactions from chain
    
    参数:
    
    hash - Start tx hash(can be tx_hash,ledger_seq,or "",if "",get from start tx).
    
    limit - Count to get.
    
    include - If the return should include the tx corresponding to hash we identified.
    
    返回:
    
    A JSONObject including transactions.
  - getAccountTransactions
```
public org.json.JSONObject getAccountTransactions(String address)
```
    Get trasactions submitted by notified account.
    
    参数:
    
    address - Account address.
    
    返回:
    
    Result.
  - getAccountTransactions
```
public void getAccountTransactions(String address,
                                   Publisher.Callback<org.json.JSONObject> cb)
```
    Get trasactions submitted by notified account,asynchronous.
    
    参数:
    
    address - Account address.
    
    cb - Callback.
  - getAccountTransactions
```
public void getAccountTransactions(String address,
                                   int limit,
                                   Publisher.Callback<org.json.JSONObject> cb)
```
    Get trasactions submitted by notified account,asynchronous.
    
    参数:
    
    address - Account address.
    
    limit - Max transaction count to get.
    
    cb - Callback.
  - getTransaction
```
public org.json.JSONObject getTransaction(String hash)
```
    Get transaction identified by hash.
    
    参数:
    
    hash - Transaction hash.
    
    返回:
    
    Transaction information.
  - getTransaction
```
public org.json.JSONObject getTransaction(org.json.JSONObject txInfo)
                                   throws Exception
```
    Get transaction identified by hash.
    
    参数:
    
    txInfo - txInfo {"hash": "B168F7FC87EC5D435F85885B21DEA3C55B98C9390CA9FDB75F14571E451BD1B3", "meta":false,"meta_chain":true}
    
    返回:
    
    Transaction information.
    
    抛出:
    
    Exception
  - getTransaction
```
public void getTransaction(String hash,
                           Publisher.Callback<org.json.JSONObject> cb)
```
    Get transaction by hash asynrhonously.
    
    参数:
    
    hash - Transaction hash.
    
    cb - Callback.
  - generateAddress
```
public org.json.JSONObject generateAddress()
```
    Generate a new account.
    
    返回:
    
    Contains folling fields: secret:Account secret. address:Account address. publicKey:Account publickey.
  - generateAddress
```
public org.json.JSONObject generateAddress(String secret)
```
  - generateAddress
```
public org.json.JSONObject generateAddress(org.json.JSONObject options)
```
    generate address
    
    参数:
    
    options - {algorithm:"softGMAlg",secret:"pw5MLePoMLs1DA8y7CgRZWw6NfHik7ZARg8Wp2pr44vVKrpSeUV"}
    
    返回:
  - validationCreate
```
public org.json.JSONArray validationCreate(int count)
```
    Create validation key
    
    参数:
    
    count - Count to create.
    
    返回:
    
    JSONArray contains validation keys, each with a structue of {"seed":xxx,"publickey":xxx}
  - validationCreate
```
public org.json.JSONObject validationCreate()
```
    Create validation keys.
    
    返回:
    
    JSONObject with field "seed" and "publickey".
  - validationCreate
```
public org.json.JSONObject validationCreate(org.json.JSONObject options)
```
    参数:
    
    options - JSONObject with field "seed" and "algorithm".
    
    返回:
    
    JSONObject with field "seed" and "publickey".
  - getUnlList
```
public org.json.JSONObject getUnlList()
```
    Get validation publickey list
    
    返回:
    
    validation publickey list
  - getConnection
```
public Connection getConnection()
```
  - getAccountInfo
```
public org.json.JSONObject getAccountInfo(String address)
```
  - getAccountBalance
```
public String getAccountBalance(String address)
```
  - doCommit
```
public org.json.JSONObject doCommit(Object commitType)
```
    sqlTransaction commit
    
    参数:
    
    commitType - Commit type.
    
    返回:
    
    Commit result.
  - commit
```
public org.json.JSONObject commit(Submit.SyncCond cond)
```
    Commit sql-transactoin synchronously.
    
    参数:
    
    cond - Return condition.
    
    返回:
    
    Commit result.
  - commit
```
public org.json.JSONObject commit(Publisher.Callback<?> cb)
```
    Commit sql-transactoin asynchronously.
    
    参数:
    
    cb - Callback object.
    
    返回:
    
    Commit result.
  - encrypt
```
public String encrypt(String plainText,
                      List<String> listPublicKey)
```
    加密接口
    
    参数:
    
    plainText - 明文
    
    listPublicKey - 公钥数组
    
    返回:
    
    密文
  - decrypt
```
public String decrypt(String cipher,
                      String secret)
```
    解密接口
    
    参数:
    
    cipher - 密文
    
    secret - 私钥
    
    返回:
    
    明文，解密失败返回""
  - getAccountTables
```
public org.json.JSONObject getAccountTables(String address,
                                            boolean bGetDetail)
```
    获取账户建的表
    
    参数:
    
    address - 账户地址
    
    bGetDetail - 是否获取详细信息（建表的raw字段）
    
    返回:
    
    用户建的表（数组）
  - getAccountTables
```
public void getAccountTables(String address,
                             boolean bGetDetail,
                             Publisher.Callback<org.json.JSONObject> cb)
```
    获取账户建的表
    
    参数:
    
    address - 账户地址
    
    bGetDetail - 是否获取详细信息（建表的raw字段）
    
    cb - 回调函数
  - getTableAuth
```
public org.json.JSONObject getTableAuth(String owner,
                                        String tableName)
```
    获取表授权列表
    
    参数:
    
    owner - 表的拥有者地址
    
    tableName - 表名
    
    返回:
    
    授权列表
  - getTableAuth
```
public org.json.JSONObject getTableAuth(String owner,
                                        String tableName,
                                        List<String> accounts)
```
    获取表授权列表
    
    参数:
    
    owner - 表的拥有者地址
    
    tableName - 表名
    
    accounts - 指定账户地址列表，只查这个列表中相关地址的授权
    
    返回:
    
    授权列表
  - getTableAuth
```
public void getTableAuth(String owner,
                         String tableName,
                         Publisher.Callback<org.json.JSONObject> cb)
```
    获取表授权列表
    
    参数:
    
    owner - 表的拥有者地址
    
    tableName - 表名
    
    cb - 回调函数
  - getTableAuth
```
public void getTableAuth(String owner,
                         String tableName,
                         List<String> accounts,
                         Publisher.Callback<org.json.JSONObject> cb)
```
    获取表授权列表
    
    参数:
    
    owner - 表的拥有者地址
    
    tableName - 表名
    
    accounts - 指定账户地址列表，只查这个列表中相关地址的授权
    
    cb - 回调函数
  - sign
```
public byte[] sign(byte[] message,
                   String secret)
```
    签名接口
    
    参数:
    
    message - 要签名的内容
    
    secret - 签名私钥
    
    返回:
    
    签名
  - verify
```
public boolean verify(byte[] message,
                      byte[] signature,
                      String publicKey)
```
    验证签名接口
    
    参数:
    
    message - 被签名的内容
    
    signature - 签名
    
    publicKey - 签名公钥
    
    返回:
    
    是否验签成功
  - getBySqlAdmin
```
public org.json.JSONObject getBySqlAdmin(String sql)
```
    根据sql语句查询，admin接口，同步调用
    
    参数:
    
    sql - 要查询的sql语句
    
    返回:
    
    返回格式： { "lines":[...] "status":"..." }
  - getBySqlAdmin
```
public void getBySqlAdmin(String sql,
                          Publisher.Callback<org.json.JSONObject> cb)
```
    根据sql语句查询，admin接口，异步调用
    
    参数:
    
    sql - 要查询的sql语句
    
    cb - 查询结果回调
  - getBySqlUser
```
public org.json.JSONObject getBySqlUser(String sql)
```
    根据sql语句查询，普通用户接口，需签名验证
    
    参数:
    
    sql - 要查询的sql语句
    
    返回:
    
    返回格式： { "lines":[...] "status":"..." }
  - getBySqlUser
```
public void getBySqlUser(String sql,
                         Publisher.Callback<org.json.JSONObject> cb)
```
    根据sql语句查询，普通用户接口，异步调用
    
    参数:
    
    sql - 要查询的sql语句
    
    cb - 查询结果回调
  - getTableNameInDB
```
public org.json.JSONObject getTableNameInDB(String owner,
                                            String tableName)
```
    获取表的NameInDB字符串
    
    参数:
    
    owner - 表的拥有者地址
    
    tableName - 表名
    
    返回:
    
    success: { "status":"success" "nameInDB":"xxx" } failed: { "status":"error" "error_message":"xxx" }
  - getTableNameInDB
```
public void getTableNameInDB(String owner,
                             String tableName,
                             Publisher.Callback<org.json.JSONObject> cb)
```
  - getLedgerTxs
```
public org.json.JSONObject getLedgerTxs(Integer ledgerSeq,
                                        boolean bIncludeSuccess,
                                        boolean bIncludefailure)
```
    获取区块中的交易，在bIncludeSuccess与bIncludefailure都为false的情况下，只返回成功与失败的交易数量
    
    参数:
    
    ledgerSeq - 要查询的区块号
    
    bIncludeSuccess - 查询结果中是否包含成功交易
    
    bIncludefailure - 查询结果中是否包含失败交易
  - getLedgerTxs
```
public void getLedgerTxs(Integer ledgerSeq,
                         boolean bIncludeSuccess,
                         boolean bIncludefailure,
                         Publisher.Callback<org.json.JSONObject> cb)
```
    获取区块中的交易，在bIncludeSuccess与bIncludefailure都为false的情况下，只返回成功与失败的交易数量
    
    参数:
    
    ledgerSeq - 要查询的区块号
    
    bIncludeSuccess - 查询结果中是否包含成功交易
    
    bIncludefailure - 查询结果中是否包含失败交易
    
    cb - 查询结果回调
  - getSchemaList
```
public org.json.JSONObject getSchemaList(org.json.JSONObject params)
```
    Get schema list.
    
    返回:
    
    schema information.
  - getSchemaInfo
```
public org.json.JSONObject getSchemaInfo(String schemaID)
```
    查询子链的信息
    
    参数:
    
    schemaID - schemaID

类 Chainsql

嵌套类概要

从类继承的嵌套类/接口 com.peersafe.chainsql.core.Submit

字段概要

从类继承的字段 com.peersafe.chainsql.core.Submit

构造器概要

方法概要

从类继承的方法 com.peersafe.chainsql.core.Submit

从类继承的方法 java.lang.Object

字段详细资料

logger

MAIN_SCHEMA

event

构造器详细资料

Chainsql

方法详细资料

as

useCert

setSchema

use

connect

connect

connect

connect

connect

connect

shutdown

array

onReconnected

onReconnecting

disconnect

table

setUseGM

isUseGM

sign

signFor

prepareSigned

setExtraFee

createTable

createTable

createTable

createSchema

modifySchema

recreateTable

dropTable

renameTable

addTableFields

deleteTableFields

modifyTableFields

createIndex

deleteIndex

grant

grant

createRippleTransaction

pay

pay

payToContract

escrowCreate

escrowCreate

escrowExecute

escrowCancel

accountSet

accountSet

whitelistSet

trustSet

beginTran

commit

report

getServerInfo

getPeers

getChainInfo

getLedger

getLedger

getLedger

getLedger

getLedgerVersion

getLedgerVersion

getAccountTransactions

getCrossChainTxs

getAccountTransactions