晒啦 js sdk 说明文档

安装

npm i cellar-js-sdk

引入

ESM

import { Cellar, CellarEnv } from "cellar-js-sdk";

UMD

<script
  type="text/javascript"
  src="https://cdn.jsdelivr.net/npm/[email protected]/dist/cellar-js-sdk.umd.min.js"
/>;

调用方法

/**
 * 初始化
 * @appId 应用id
 * @env   插件执行环境目前支持 CellarEnv.PRE(测试环境) 与 CellarEnv.PRO(正式环境)
 * @walletList   是否展示钱包列表，false：默认钱包授权，true：从钱包列表中选择钱包授权 
 */
let cellar = new Cellar({
  appId: "#appId",
  env: CellarEnv.PRE,
  walletList: false,
});

/**
 * 初始化后, 所有方法都通过如下方式调用
 */
cellar.request({
  method: "方法名",
  params: [{
    /**
     * 调用的方法不同, 参数也不同
     */
  }],
}).then((result) => {
  /**
   * 所有方法正常执行完成后都会执行该回调函数
   */
  console.log(result);
}).catch((errorMsg) => {
  /**
   * 所有方法执行出错就会执行该回调函数
   */
  console.log(errorMsg);
});

目前支持的方法 method

| method | 说明 | | :------------------ | :--------------------- | | cellar_version | 获取版本号 | | cellar_loginState | 检查登录授权状态 | | cellar_loginOut | 退出当前登录授权的账户 | | cfx_accounts | 登录授权 | | cfx_sendTransaction | 调用合约 |

cfx_sendTransaction 调用链上合约

参数

| 键名 | 类型 | 说明 | | :--: | :----: | :----------------------------------------- | | from | string | 调用方地址 | | to | string | 合约地址 | | data | string | 十六进制调用数据（通过Conflux JS SDK生成） |

返回值

| 键名 | 类型 | 说明 | | :--: | :----: | :------- | | - | string | 交易hash |

cfx_accounts 登录授权

参数

| 键名 | 类型 | 说明 | | :--: | :--: | :----- | | - | - | 无参数 |

返回值

| 键名 | 类型 | 说明 | | :-----------: | :----: | :------------------- | | userCode | string | 登录账户code | | userWallet | string | 授权登录账户钱包地址 | | authorityCode | string | 授权码 |

cellar_loginState 检查登录授权状态

参数

| 键名 | 类型 | 说明 | | :--: | :--: | :----- | | - | - | 无参数 |

返回值

| 键名 | 类型 | 说明 | | :-----------: | :----: | :------------------- | | userCode | string | 登录账户code | | userWallet | string | 授权登录账户钱包地址 | | authorityCode | string | 授权码 |

如果未登录授权, 则会进入 catch() 回调

cellar_loginOut 退出当前登录账户

参数

| 键名 | 类型 | 说明 | | :--: | :--: | :----- | | - | - | 无参数 |

返回值

| 键名 | 类型 | 说明 | | :--: | :--: | :---------------------------------- | | - | - | 无返回值,只要回到 then() 就代表成功 |

cellar_version 获取晒啦js sdk 的版本号

参数

| 键名 | 类型 | 说明 | | :--: | :--: | :----- | | - | - | 无参数 |

返回值

| 键名 | 类型 | 说明 | | :--: | :----: | :------------------------------------- | | - | string | 晒啦 js-sdk 的版本号 以及 当前运行环境 |