rippled提供了js api完整的开源库 ripple-lib.
开源地址: https://github.com/ripple/ripple-lib.git
官方文档: https://xrpl.org/get-started.html
如果自己部署的rippled服务接口没有什么变化,或者完全兼容官网的js api。web应用中直接引入官网的ripple-lib发布包即可。
<script src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.15/lodash.js"></script>
<script src="https://unpkg.com/ripple-lib@1.8.0/build/ripple-latest-min.js"></script>
01 RippleAPI 在 nodejs 中的使用
参考官网文档: RippleAPI for Node.js入门
安装稳定版本nodejs。本测试在win10上面进行,安装nodejs最新稳定版本。
参考: https://nodejs.org/en/download/package-manager/
node --version
v14.15.5
安装yarn的时候需要注意:需要把yarn的目录加入到path路径中。本测试中把yarn安装到node的全局路径下。
npm install --global yarn
nodejs安装在 D:\install\nodejs
, 在%PATH% 中加入了 D:\install\nodejs\node_global;D:\install\nodejs;
为了命令行运行,能直接找到yarn命令。
根据 RippleAPI for Node.js入门介绍的步骤,创建nodejs项目,把 get-account-info.js
中的公网地址,换成本机的rippled服务地址ws://127.0.0.1:6006
即连接到自己部署的rippled服务中。
'use strict';
const RippleAPI = require('ripple-lib').RippleAPI;
const api = new RippleAPI({
//server: 'wss://s1.ripple.com' // 公网地址
server: 'ws://127.0.0.1:6006' // 本机地址,如果配置了本机的rippled服务
});
api.connect().then(() => {
/* begin custom code ------------------------------------ */
const myAddress = 'rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn';
console.log('getting account info for', myAddress);
return api.getAccountInfo(myAddress);
}).then(info => {
console.log(info);
console.log('getAccountInfo done');
/* end custom code -------------------------------------- */
}).then(() => {
return api.disconnect();
}).then(() => {
console.log('done and disconnected.');
}).catch(console.error);
运行效果:
D:\git\rippled\buildlib\install\ripplelib>node get-account-info.js
getting account info for rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn
{
sequence: 382,
xrpBalance: '424.022979',
ownerCount: 9,
previousInitiatedTransactionID: '5E089C0CD4C52D3ECD85E5E1F38FC255F43FAFAF4FD5C42DD48A8A1B6C36DF5E',
previousAffectingTransactionID: 'CA5F4AC3E37082131121A264F75B06C2796D8D10304A560978DC5DBAD7009FBD',
previousAffectingTransactionLedgerVersion: 61547126
}
getAccountInfo done
done and disconnected.
02 web端应用
使用官网的ripple-latest-min.js测试效果:
browser-demo.html
<!DOCTYPE html>
<html>
<head>
<script src="https://unpkg.com/lodash@4.17.20/lodash.min.js"></script>
<script src="https://unpkg.com/ripple-lib@1.8.0/build/ripple-latest-min.js"></script>
<script>
<!--script src="ripple-latest-min.js"></script-->
console.log(ripple);
var api = new ripple.RippleAPI({server:'wss://s1.ripple.com/'});
//var api = new ripple.RippleAPI({server:'ws://127.0.0.1:6006/'});
api.connect().then(function() {
return api.getServerInfo();
}).then(function(server_info) {
document.body.innerHTML += "<p>Connected to rippled server!</p>" +
" <table>" +
" <tr><th>Version</th>" +
" <td>" + server_info.buildVersion + "</td></tr>" +
" <tr><th>Ledgers available</th>" +
" <td>" + server_info.completeLedgers + "</td></tr>" +
" <tr><th>hostID</th>" +
" <td>" + server_info.hostID + "</td></tr>" +
" <tr><th>Most Recent Validated Ledger Seq.</th>" +
" <td>" + server_info.validatedLedger.ledgerVersion + "</td></tr>" +
" <tr><th>Most Recent Validated Ledger Hash</th>" +
" <td>" + server_info.validatedLedger.hash + "</td></tr>" +
" <tr><th>Seconds since last ledger validated</th>" +
" <td>" + server_info.validatedLedger.age + "</td></tr>" +
" </table>";
});
</script>
<style type="text/css">
td, th { border: 1px solid black; padding: 5px; }
table { border-collapse: collapse; }
</style>
</head>
<body></body>
</html>
效果
03 自己编译ripple-lib
根据 构建与浏览器兼容的RippleAPI版本 的说明,下载ripple-lib代码,
:: 下载代码
cd d:\git
git clone https://github.com/ripple/ripple-lib.git
cd ripple-lib
:: 迁出稳定分支
git checkout -b b1.9.0 1.9.0
:: 安装必要组件,如果找不到yarn,需要把nodejs的node_global目录加入到 %path%环境变量中。
yarn
:: 编译生成ripple-latest-min.js 在当前目录的 build目录下
yarn run build
编译生成的安装包产物,可安装到nodejs组件下的内容。
04 在web应用中引用自己编译的ripple-lib库
编译生成ripple-latest-min.js,且保存到browser-demo.html相同目录。注释掉browser-demo.html中远程js,只用本地js且网址也使用本地的rippled服务。
browser-demo.html
<!DOCTYPE html>
<html>
<head>
<script src="https://unpkg.com/lodash@4.17.20/lodash.min.js"></script>
<!--script src="https://unpkg.com/ripple-lib@1.8.0/build/ripple-latest-min.js"></script>
<script-->
<script src="ripple-latest-min.js"></script>
console.log(ripple);
//var api = new ripple.RippleAPI({server:'wss://s1.ripple.com/'});
var api = new ripple.RippleAPI({server:'ws://127.0.0.1:6006/'});
api.connect().then(function() {
return api.getServerInfo();
}).then(function(server_info) {
document.body.innerHTML += "<p>Connected to rippled server!</p>" +
" <table>" +
" <tr><th>Version</th>" +
" <td>" + server_info.buildVersion + "</td></tr>" +
" <tr><th>Ledgers available</th>" +
" <td>" + server_info.completeLedgers + "</td></tr>" +
" <tr><th>hostID</th>" +
" <td>" + server_info.hostID + "</td></tr>" +
" <tr><th>Most Recent Validated Ledger Seq.</th>" +
" <td>" + server_info.validatedLedger.ledgerVersion + "</td></tr>" +
" <tr><th>Most Recent Validated Ledger Hash</th>" +
" <td>" + server_info.validatedLedger.hash + "</td></tr>" +
" <tr><th>Seconds since last ledger validated</th>" +
" <td>" + server_info.validatedLedger.age + "</td></tr>" +
" </table>";
});
</script>
<style type="text/css">
td, th { border: 1px solid black; padding: 5px; }
table { border-collapse: collapse; }
</style>
</head>
<body></body>
</html>
运行效果
05 在自己架设的web上使用ripple-lib
也可自己部署一个简单的web应用,使用自己编译的ripple-lib。