安全服务客户端
软件开发包,便利与 安全交易服务API。 。 。 .
目录
安装
用纱线或npm安装软件包 :
yarn install
npm install
构建
用纱线或npm来构建软件包 :
yarn build
npm build
初始化
证明 EthAdapter
首先,我们需要创建一个 EthAdapter,包含SDKs与区块链互动所需的所有公用事业. 用来包装 网络3.js 或者说 乙醚(js) 伊特鲁姆图书馆.
根据Dapp所使用的库,有两个选项:
一旦发生 EthersAdapter 或者说 Web3Adapter 被创建,可用于SDK初始化.
初始化安全服务客户端
import SafeServiceClient from '@gnosis.pm/safe-service-client'
const safeService = new SafeServiceClient({
txServiceUrl: 'https://safe-transaction-mainnet.safe.global',
ethAdapter
})
API 参考
获取服务信息
返回服务的信息和配置.
const serviceInfo: SafeServiceInfoResponse = await safeService.getServiceInfo()
获取服务MasterCopiesInfo
返回安全主副本列表.
const masterCopies: MasterCopyResponse = await safeService.getServiceMasterCopiesInfo()
解码数据
解码指定的安全交易数据.
const decodedData = await safeService.decodeData(data)
获取SafesByOwner
返回地址为所有者的保险箱列表.
const safes: OwnerResponse = await safeService.getSafesByOwner(ownerAddress)
获取SafesByMudule
返回启用模块地址的“安全”列表.
const safes: ModulesResponse = await getSafesByModule(moduleAddress)
获取交易
返回安全交易的所有信息.
const tx: SafeMultisigTransactionResponse = await safeService.getTransaction(safeTxHash)
获取交易确认
返回给定的安全交易的确认列表.
const confirmations: SafeMultisigConfirmationListResponse = await safeService.getTransactionConfirmations(safeTxHash)
确认交易
添加安全交易的确认.
const signature: SignatureResponse = await safeService.confirmTransaction(safeTxHash, signature)
获取安全信息
返回所提供安全地址的信息和配置.
const safeInfo: SafeInfoResponse = await safeService.getSafeInfo(safeAddress)
获得安全代表
返回给定安全地址的代表名单.
const delegates: SafeDelegateListResponse = await safeService.getSafeDelegates(safeAddress)
添加安全
为给定的安全地址添加新的代表.
const delegateConfig: SafeDelegateConfig = {
safe,
delegate,
label,
signer
}
await safeService.addSafeDelegate(delegateConfig)
删除所有安全代表
删除给定的安全地址的所有代表.
await safeService.removeAllSafeDelegates(safeAddress, signer)
删除安全
删除给定的安全地址的代表.
const delegateConfig: SafeDelegateDeleteConfig = {
safe,
delegate,
signer
}
await safeService.removeSafeDelegate(delegateConfig)
获取安全创建信息
返回安全器的创建信息.
const safeCreationInfo: SafeCreationInfoResponse = await safeService.getSafeCreationInfo(safeAddress)
估计安全交易
估计特定安全多签名交易的安全性TxGas.
const estimateTx: SafeMultisigTransactionEstimateResponse = await safeService.estimateSafeTransaction(
safeAddress,
safeTransaction
)
建议交易
创建新的多签名交易,并将其存储在安全交易处.
const transactionConfig: ProposeTransactionProps = {
safeAddress,
safeTxHash,
safeTransactionData,
senderAddress,
senderSignature,
origin
}
await safeService.proposeTransaction(transactionConfig)
获取交易
返回安全账户的进账历史.
const incomingTxs: TransferListResponse = await safeService.getIncomingTransactions(safeAddress)
获取模块交易
返回安全账户模块交易的历史.
const moduleTxs: SafeModuleTransactionListResponse = await safeService.getModuleTransactions(safeAddress)
获得多相转换
返回安全账户多签名交易的历史.
const multisigTxs: SafeMultisigTransactionListResponse = await safeService.getMultisigTransactions(safeAddress)
获取待定交易
返回正在等待安全所有人确认的多签名交易清单.
const pendingTxs: SafeMultisigTransactionListResponse = await safeService.getPendingTransactions(safeAddress)
const pendingTxs: SafeMultisigTransactionListResponse = await safeService.getPendingTransactions(
safeAddress,
currentNonce
)
获取全部交易
返回安全交易列表。 该列表根据交易类型有不同的结构.
const allTxs: SafeMultisigTransactionListResponse = await safeService.getAllTransactions(safeAddress)
const allTxsOptions: AllTransactionsOptions = {
executed,
queued,
trusted
}
const allTxs: SafeMultisigTransactionListResponse = await safeService.getAllTransactions(
safeAddress,
allTxsOptions
)
获取下一个 Nonce
返回在上次待决交易后提出新交易的权利非ce.
const nextNonce = await safeService.getNextNonce(safeAddress)
获取基准
返回 Ether 和 ERC20 安全符的余额.
const balances: SafeBalanceResponse[] = await safeService.getBalances(safeAddress)
此方法可选择接受 options 参数 :
const options: SafeBalancesOptions = {
excludeSpamTokens // Optional. Default value is `true`.
}
const balances: SafeBalanceResponse[] = await safeService.getBalances(safeAddress, options)
获取UsdBalances
返回保险箱以太和 ERC20 代号的余额,并转换为美元.
const usdBalances: SafeBalanceUsdResponse[] = await safeService.getUsdBalances(safeAddress)
此方法可选择接受 options 参数 :
const options: SafeBalancesUsdOptions = {
excludeSpamTokens // Optional. Default value is `true`.
}
const usdBalances: SafeBalanceUsdResponse[] = await safeService.getUsdBalances(safeAddress, options)
获取可拼贴
返回给定的“安全”拥有的集体(ERC721)及其相关信息.
const collectibles: SafeCollectibleResponse[] = await safeService.getCollectibles(safeAddress)
此方法可选择接受 options 参数 :
const options: SafeCollectiblesOptions = {
excludeSpamTokens // Optional. Default value is `true`.
}
const collectibles: SafeCollectibleResponse[] = await safeService.getCollectibles(safeAddress, options)
获取托肯列表
返回保险箱处理的所有 ERC20 令牌的列表 .
const tokens: TokenInfoListResponse = await safeService.getTokenList()
获取托肯
返回给定的 ERC20 令牌的信息 .
const token: TokenInfoResponse = await safeService.getToken(tokenAddress)
许可证
这个库在麻省理工学院下发行.
贡献者
- 热尔曼·马丁内斯(签名)德国(中文(简体) )