@gnosis.pm/safe-core-sdk

中文文档
3.2.0发布于 2022/11/23MITTypeScriptCommonJS近 30 天下载 1.4万

安全核心 SDK

此软件包已被标记为弃用

Package no longer supported. It has been migrated to @safe-global/protocol-kit. Please, update your dependencies.

中文使用文档
文档目录50 节
  1. 目录
  2. 安装
  3. 构建
  4. 开始
  5. 1. 证明EthAdapter
  6. 2. 部署新的保险箱
  7. 3. 建立安全交易
  8. 3.a. 链外签名
  9. 3.b. 链上签名
  10. 4. 交易执行
  11. 安全工厂 API 参考文献
  12. 创建
  13. 部署安全
  14. 安全核心 SDK API 参考
  15. 创建
  16. 连接
  17. 获取地址
  18. 获取合同
  19. 获取奥纳斯
  20. 获取诺斯
  21. 获得危险
  22. 获取ChainId
  23. 获取布兰斯
  24. 获取守护
  25. 获取摩多
  26. 模块已启用
  27. 是奥纳
  28. 创建交易
  29. 创建拒绝 交易
  30. 复制交易
  31. 获取交易
  32. 签名
  33. 签名TypedData
  34. 签名交易
  35. 核准交易
  36. 获得Owners Who Approved Tx 许可
  37. 创建 EnableFallBack HandlerTx 程序
  38. 创建不可移动反光汉德勒Tx
  39. 创建可创建的守护Tx
  40. 创建可禁用守护Tx
  41. 创建可创建的模块Tx
  42. 创建可拆卸模块Tx
  43. 创建AddOwnerTx
  44. 创建 Remove OwnerTx
  45. 创建 SwapOwnerTx
  46. 创建变化风险Tx
  47. 变相交易
  48. 执行交易
  49. 许可证
  50. 贡献者

安全核心 SDK

NPM Version GitHub Release GitHub

软件开发包,便利与 安全合同。 。 。 .

目录

安装

用纱线或npm安装软件包 :

yarn install
npm install

构建

用纱线或npm来构建软件包 :

yarn build
npm build

开始

以下步骤展示了如何建立"安全核心"Safe Core SDK,部署新的"安全",创建"安全"交易,生成所需的所有者签名并进行交易. 然而,仅使用安全核心SDK将无法在链外收集所有者签名. 要做到这一点,并能够看到和确认在 安全网络应用程序,建议你跟随这个 指南 包括使用安全核心SDK,以及安全服务客户端.

1. 证明EthAdapter

首先,我们需要创建一个 EthAdapter,包含SDKs与区块链互动所需的所有公用事业. 用来包装 网络3.js 或者说 乙醚(js) 伊特鲁姆图书馆.

根据Dapp所使用的库,有两个选项:

一旦发生 EthersAdapter 或者说 Web3Adapter 被创建,可用于SDK初始化.

2. 部署新的保险箱

部署一个新的安全账户 即时 SafeFactory 班级和呼叫 deploySafe 用于配置新“保险箱”。 这包括确定保险箱的所有人名单和门槛。 3个所有者的安全账户和等值3的安全账户将作为本例子的起点,但任何安全配置都是有效的.

import Safe, { SafeFactory, SafeAccountConfig } from '@gnosis.pm/safe-core-sdk'

const safeFactory = await SafeFactory.create({ ethAdapter })

const owners = ['0x<address>', '0x<address>', '0x<address>']
const threshold = 3
const safeAccountConfig: SafeAccountConfig = {
  owners,
  threshold,
  // ...
}

const safeSdk: Safe = await safeFactory.deploySafe({ safeAccountConfig })

这个 deploySafe 方法执行交易 owner1 账户,部署新的“安全”并返回连接到新的“安全”的“安全核心SDK”实例。 检查 deploySafe 方法中 API 参考 需要更多关于附加配置参数和回调的详情.

打电话 getAddress 例如,检查新部署的Safe地址的方法.

const newSafeAddress = safeSdk.getAddress()

将安全核心SDK从现有的Safe中 直接传递给它 EthAdapter 课堂和安全地址.

import Safe from '@gnosis.pm/safe-core-sdk'

const safeSdk: Safe = await Safe.create({ ethAdapter: ethAdapterOwner1, safeAddress })

检查 create 方法中 API 参考 关于附加配置参数的更详细信息.

3. 建立安全交易

import { SafeTransactionDataPartial } from '@gnosis.pm/safe-core-sdk-types'

const safeTransactionData: SafeTransactionDataPartial = {
  to: '0x<address>',
  value: '<eth_value_in_wei>',
  data: '0x<data>'
}
const safeTransaction = await safeSdk.createTransaction({ safeTransactionData })

检查 createTransaction 方法中 API 参考 关于创建多端交易的其他细节.

在执行这项交易之前,必须由所有者签字,并且可以在链外或链上进行。 在这个例子中 owner1 将签下它, owner2 将在链上签名 owner3 将执行它(执行者也将透明地签署交易).

3.a. 链外签名

这个 owner1 账户在交易链外签名.

const signedSafeTransaction = await safeSdk.signTransaction(safeTransaction)

由于签字是脱链的,因此与合同没有互动关系,签字可在 signedSafeTransaction.signatures。 。 。 .

3.b. 链上签名

要连接 owner2 到安全,我们需要创造一个新的实例 阶级 EthAdapter 交给它的建筑师 我们想要连接的主人。 之后 owner2 账户连接到SDK,作为交易散列将在链上获得批准的标志.

const ethAdapterOwner2 = new EthersAdapter({ ethers, signer: owner2 })
const safeSdk2 = await safeSdk.connect({ ethAdapter: ethAdapterOwner2, safeAddress })
const txHash = await safeSdk2.getTransactionHash(safeTransaction)
const approveTxResponse = await safeSdk2.approveTransactionHash(txHash)
await approveTxResponse.transactionResponse?.wait()

4. 交易执行

终于, owner3 账户与 SDK 连接,作为安全交易的签名和执行者执行.

const ethAdapterOwner3 = new EthersAdapter({ ethers, signer: owner3 })
const safeSdk3 = await safeSdk2.connect({ ethAdapter: ethAdapterOwner3, safeAddress })
const executeTxResponse = await safeSdk3.executeTransaction(safeTransaction)
await executeTxResponse.transactionResponse?.wait()

所有用于执行交易的签名现在都可以在 safeTransaction.signatures。 。 。 .

安全工厂 API 参考文献

创建

返回安全工厂的例子.

import { SafeFactory } from '@gnosis.pm/safe-core-sdk'

const safeFactory = await SafeFactory.create({ ethAdapter })
  • 这个 isL1SafeMasterCopy 旗帜

    安全合同有两个版本: GnosisSafe.sol (英语) 不引发事件,以节省气体和 GnosisSafeL2. 溶液 更适合L2网络.

    默认 GnosisSafe.sol 将只用于Ethereum Mainnet。 在已部署安全合同的其余网络中 GnosisSafeL2.sol 除非您添加 isL1SafeMasterCopy 用于强制使用 GnosisSafe.sol 合同.

    const safeFactory = await SafeFactory.create({ ethAdapter, isL1SafeMasterCopy: true })
    
  • 这个 contractNetworks 属性

    如果安全合同没有部署到您目前的网络 contractNetworks 财产需要注明你以前部署的安全合同地址.

    import { ContractNetworksConfig } from '@gnosis.pm/safe-core-sdk'
    
    const chainId = await ethAdapter.getChainId()
    const contractNetworks: ContractNetworksConfig = {
      [chainId]: {
        safeMasterCopyAddress: '<MASTER_COPY_ADDRESS>',
        safeProxyFactoryAddress: '<PROXY_FACTORY_ADDRESS>',
        multiSendAddress: '<MULTI_SEND_ADDRESS>',
        multiSendCallOnlyAddress: '<MULTI_SEND_CALL_ONLY_ADDRESS>',
        fallbackHandlerAddress: '<FALLBACK_HANDLER_ADDRESS>',
        signMessageLibAddress: '<SIGN_MESSAGE_LIB_ADDRESS>',
        createCallAddress: '<CREATE_CALL_ADDRESS>',
        safeMasterCopyAbi: '<MASTER_COPY_ABI>', // Optional. Only needed with web3.js
        safeProxyFactoryAbi: '<PROXY_FACTORY_ABI>', // Optional. Only needed with web3.js
        multiSendAbi: '<MULTI_SEND_ABI>', // Optional. Only needed with web3.js
        multiSendCallOnlyAbi: '<MULTI_SEND_CALL_ONLY_ABI>', // Optional. Only needed with web3.js
        fallbackHandlerAbi: '<FALLBACK_HANDLER_ABI>', // Optional. Only needed with web3.js 
        signMessageLibAbi: '<SIGN_MESSAGE_LIB_ABI>', // Optional. Only needed with web3.js
        createCallAbi: '<CREATE_CALL_ABI>' // Optional. Only needed with web3.js
      }
    }
    
    const safeFactory = await SafeFactory.create({ ethAdapter, contractNetworks })
    
  • 这个 safeVersion 属性

    这个 SafeFactory 构造器还接受 safeVersion 以指定将部署的安全合同版本。 此字符串可以取取值 1.1.1, (中文(简体) ), 1.2.0 或者说 1.3.0。如果没有指定,将默认使用最新的合同版本.

    const safeVersion = 'X.Y.Z'
    const safeFactory = await SafeFactory.create({ ethAdapter, safeVersion })
    

部署安全

部署一个新的安全器,并返回一个与部署的安全器相连的安全核心SDK的例子。 主副本、安全合同版本和合同的地址(GnosisSafe.sol 或者说 GnosisSafeL2.sol安全性取决于 safeFactory 举个例子.

const safeAccountConfig: SafeAccountConfig = {
  owners,
  threshold,
  to, // Optional
  data, // Optional
  fallbackHandler, // Optional
  paymentToken, // Optional
  payment, // Optional
  paymentReceiver // Optional
}

const safeSdk = await safeFactory.deploySafe({ safeAccountConfig })

此方法可选择接受 safeDeploymentConfig 用于定义 saltNonce。 。 。 .

const safeAccountConfig: SafeAccountConfig = {
  owners,
  threshold,
  to, // Optional
  data, // Optional
  fallbackHandler, // Optional
  paymentToken, // Optional
  payment, // Optional
  paymentReceiver // Optional
}
const safeDeploymentConfig: SafeDeploymentConfig = { saltNonce }

const safeSdk = await safeFactory.deploySafe({ safeAccountConfig, safeDeploymentConfig })

可选的,一些属性可以作为执行选项传递:

const options: Web3TransactionOptions = {
  from, // Optional
  gas, // Optional
  gasPrice, // Optional
  maxFeePerGas, // Optional
  maxPriorityFeePerGas // Optional
  nonce // Optional
}
const options: EthersTransactionOptions = {
  from, // Optional
  gasLimit, // Optional
  gasPrice, // Optional
  maxFeePerGas, // Optional
  maxPriorityFeePerGas // Optional
  nonce // Optional
}
const safeSdk = await safeFactory.deploySafe({ safeAccountConfig, safeDeploymentConfig, options })

也可以使用可选的回调来接收 txHash 在返回安全核心SDK新实例之前的安全部署交易:

const callback = (txHash: string): void => {
  console.log({ txHash })
}

const safeSdk = await safeFactory.deploySafe({ safeAccountConfig, callback })

安全核心 SDK API 参考

创建

返回连接到 safeAddress。 。 。 .

import Safe from '@gnosis.pm/safe-core-sdk'

const safeSdk = await Safe.create({ ethAdapter, safeAddress })
  • 这个 isL1SafeMasterCopy 旗帜

    安全合同有两个版本: GnosisSafe.sol (英语) 不引发事件,以节省气体和 GnosisSafeL2. 溶液 更适合L2网络.

    默认 GnosisSafe.sol 将只用于Ethereum Mainnet。 在已部署安全合同的其余网络中 GnosisSafeL2.sol 除非您添加 isL1SafeMasterCopy 用于强制使用 GnosisSafe.sol 合同.

    const safeSdk = await Safe.create({ ethAdapter, safeAddress, isL1SafeMasterCopy: true })
    
  • 这个 contractNetworks 属性

    如果安全合同没有部署到您目前的网络 contractNetworks 财产需要注明你以前部署的安全合同地址.

    import { ContractNetworksConfig } from '@gnosis.pm/safe-core-sdk'
    
    const chainId = await ethAdapter.getChainId()
    const contractNetworks: ContractNetworksConfig = {
      [chainId]: {
        safeMasterCopyAddress: '<MASTER_COPY_ADDRESS>',
        safeProxyFactoryAddress: '<PROXY_FACTORY_ADDRESS>',
        multiSendAddress: '<MULTI_SEND_ADDRESS>',
        multiSendCallOnlyAddress: '<MULTI_SEND_CALL_ONLY_ADDRESS>',
        fallbackHandlerAddress: '<FALLBACK_HANDLER_ADDRESS>',
        signMessageLibAddress: '<SIGN_MESSAGE_LIB_ADDRESS>',
        createCallAddress: '<CREATE_CALL_ADDRESS>',
        safeMasterCopyAbi: '<MASTER_COPY_ABI>', // Optional. Only needed with web3.js
        safeProxyFactoryAbi: '<PROXY_FACTORY_ABI>', // Optional. Only needed with web3.js
        multiSendAbi: '<MULTI_SEND_ABI>', // Optional. Only needed with web3.js
        multiSendCallOnlyAbi: '<MULTI_SEND_CALL_ONLY_ABI>', // Optional. Only needed with web3.js
        fallbackHandlerAbi: '<FALLBACK_HANDLER_ABI>', // Optional. Only needed with web3.js 
        signMessageLibAbi: '<SIGN_MESSAGE_LIB_ABI>', // Optional. Only needed with web3.js
        createCallAbi: '<CREATE_CALL_ABI>' // Optional. Only needed with web3.js
      }
    }
    
    const safeSdk = await Safe.create({ ethAdapter, safeAddress, contractNetworks })
    

连接

返回连接到 safeAddress。 。 。 .

const safeSdk2 = await safeSdk.connect({ ethAdapter, safeAddress })
  • 这个 isL1SafeMasterCopy 旗帜

    安全合同有两个版本: GnosisSafe.sol (英语) 不引发事件,以节省气体和 GnosisSafeL2. 溶液 更适合L2网络.

    默认 GnosisSafe.sol 将只用于Ethereum Mainnet。 在已部署安全合同的其余网络中 GnosisSafeL2.sol 除非您添加 isL1SafeMasterCopy 用于强制使用 GnosisSafe.sol 合同.

    const safeSdk = await Safe.connect({ ethAdapter, safeAddress, isL1SafeMasterCopy: true })
    
  • 这个 contractNetworks 属性

    如果安全合同没有部署到您目前的网络 contractNetworks 财产需要注明你以前部署的安全合同地址.

    import { ContractNetworksConfig } from '@gnosis.pm/safe-core-sdk'
    
    const chainId = await ethAdapter.getChainId()
    const contractNetworks: ContractNetworksConfig = {
      [chainId]: {
        safeMasterCopyAddress: '<MASTER_COPY_ADDRESS>',
        safeProxyFactoryAddress: '<PROXY_FACTORY_ADDRESS>',
        multiSendAddress: '<MULTI_SEND_ADDRESS>',
        multiSendCallOnlyAddress: '<MULTI_SEND_CALL_ONLY_ADDRESS>',
        fallbackHandlerAddress: '<FALLBACK_HANDLER_ADDRESS>',
        signMessageLibAddress: '<SIGN_MESSAGE_LIB_ADDRESS>',
        createCallAddress: '<CREATE_CALL_ADDRESS>',
        safeMasterCopyAbi: '<MASTER_COPY_ABI>', // Optional. Only needed with web3.js
        safeProxyFactoryAbi: '<PROXY_FACTORY_ABI>', // Optional. Only needed with web3.js
        multiSendAbi: '<MULTI_SEND_ABI>', // Optional. Only needed with web3.js
        multiSendCallOnlyAbi: '<MULTI_SEND_CALL_ONLY_ABI>', // Optional. Only needed with web3.js
        fallbackHandlerAbi: '<FALLBACK_HANDLER_ABI>', // Optional. Only needed with web3.js 
        signMessageLibAbi: '<SIGN_MESSAGE_LIB_ABI>', // Optional. Only needed with web3.js
        createCallAbi: '<CREATE_CALL_ABI>' // Optional. Only needed with web3.js
      }
    }
    const safeSdk = await Safe.connect({ ethAdapter, safeAddress, contractNetworks })
    

获取地址

返回当前SafeProxy合同的地址.

const safeAddress = safeSdk.getAddress()

获取合同

返回安全主复制合同版本.

const contractVersion = await safeSdk.getContractVersion()

获取奥纳斯

返回安全所有者账户列表.

const ownerAddresses = await safeSdk.getOwners()

获取诺斯

返回安全非ce.

const nonce = await safeSdk.getNonce()

获得危险

返回安全阈值.

const threshold = await safeSdk.getThreshold()

获取ChainId

返回连接网络的链路ID.

const chainId = await safeSdk.getChainId()

获取布兰斯

返回保险箱的ETH平衡.

const balance = await safeSdk.getBalance()

获取守护

如果未启用守护, 返回启用的安全保卫或 0x 地址 .

const guardAddress = await safeSdk.getGuard()

获取摩多

返回所有启用的安全模块的地址列表 .

const moduleAddresses = await safeSdk.getModules()

模块已启用

检查是否启用了当前安全模块 .

const isEnabled = await safeSdk.isModuleEnabled(moduleAddress)

是奥纳

检查特定地址是否为当前保险箱的拥有者 .

const isOwner = await safeSdk.isOwner(address)

创建交易

A 安全交易准备由所有者签署并执行。 安全核心SDK支持创建单一安全交易,但也支持多端交易.

  • 单笔交易

    这种方法可以取取类型对象 SafeTransactionDataPartial 代表我们要执行的交易(一旦收到签名)。 它接受以下一些可选属性.

    import { SafeTransactionDataPartial } from '@gnosis.pm/safe-core-sdk-types'
    
    const safeTransactionData: SafeTransactionDataPartial = {
      to,
      data,
      value,
      operation, // Optional
      safeTxGas, // Optional
      baseGas, // Optional
      gasPrice, // Optional
      gasToken, // Optional
      refundReceiver, // Optional
      nonce // Optional
    }
    const safeTransaction = await safeSdk.createTransaction({ safeTransactionData })
    
  • 多端交易

    这种方法可以采取一系列 MetaTransactionData 代表我们要包含在多端交易中的多个交易的对象。 如果我们想要指定我们MultiSend交易中的一些可选属性, 我们可以将第二个参数传递给 createTransaction 使用该方法 SafeTransactionOptionalProps 对象.

    const safeTransactionData: MetaTransactionData[] = [
      {
        to,
        data,
        value,
        operation // Optional
      },
      {
        to,
        data,
        value,
        operation // Optional
      },
      // ...
    ]
    const safeTransaction = await safeSdk.createTransaction({ safeTransactionData })
    

    这种方法也可以收到 options 在多端交易中设置可选属性的参数 :

    const safeTransactionData: MetaTransactionData[] = [
      {
        to,
        data,
        value,
        operation // Optional
      },
      {
        to,
        data,
        value,
        operation // Optional
      },
      // ...
    ]
    const options: SafeTransactionOptionalProps = {
      safeTxGas, // Optional
      baseGas, // Optional
      gasPrice, // Optional
      gasToken, // Optional
      refundReceiver, // Optional
      nonce // Optional
    }
    const safeTransaction = await safeSdk.createTransaction({ safeTransactionData, options })
    

    此外,可选办法 callsOnly 参数,即 false 在默认情况下,允许强制使用 MultiSendCallOnly 代替 MultiSend 发送批次交易时的合同 :

    const callsOnly = true
    const safeTransaction = await safeSdk.createTransaction({ safeTransactionData, options, callsOnly })
    

如果没有手动设定可选属性,返回的Safe 交易将拥有每个的默认值:

  • operation数字 : OperationType.Call (0)是默认值.
  • safeTxGas:正确的气体估计是默认值.
  • baseGas: 0 是默认值.
  • gasPrice: 0 是默认值.
  • gasToken: 0x地址是默认值.
  • refundReceiver: 0x地址是默认值.
  • nonce: 当前的安全非ce 是默认值 .

更多关于 安全交易属性。 。 。 .

创建拒绝 交易

返回一个安全交易,准备由所有者签署,使待处理的安全交易/与特定非现金的交易无效.

const safeTransactionData: SafeTransactionDataPartial = {
  // ...
}
const safeTransaction =  await safeSdk.createTransaction({ safeTransactionData })
const rejectionTransaction = await safeSdk.createRejectionTransaction(safeTransaction.data.nonce)

复制交易

复制一个安全交易.

const safeTransaction1 = await safeSdk.createTransaction({ safeTransactionData })
const safeTransaction2 = await copyTransaction(safeTransaction1)

获取交易

返回安全交易的散列.

const safeTransactionData: SafeTransactionDataPartial = {
  // ...
}
const safeTransaction =  await safeSdk.createTransaction({ safeTransactionData })
const txHash = await safeSdk.getTransactionHash(safeTransaction)

签名

使用当前所有者账户签署散列 .

const safeTransactionData: SafeTransactionDataPartial = {
  // ...
}
const safeTransaction =  await safeSdk.createTransaction({ safeTransactionData })
const txHash = await safeSdk.getTransactionHash(safeTransaction)
const signature = await safeSdk.signTransactionHash(txHash)

签名TypedData

根据 EIP-712 使用当前签名账户签名交易.

const safeTransactionData: SafeTransactionDataPartial = {
  // ...
}
const safeTransaction = await safeSdk.createTransaction({ safeTransactionData })
const signature = await safeSdk.signTypedData(safeTransaction)

签名交易

返回一个新的 SafeTransaction 对象,包括当前所有者的签名. eth_sign 将默认用于生成签名.

const safeTransactionData: SafeTransactionDataPartial = {
  // ...
}
const safeTransaction = await safeSdk.createTransaction({ safeTransactionData })
const signedSafeTransaction = await safeSdk.signTransaction(safeTransaction)

可选地通过一个附加参数来指定不同的签名方式:

const signedSafeTransaction = await safeSdk.signTransaction(safeTransaction, 'eth_signTypedData')
const signedSafeTransaction = await safeSdk.signTransaction(safeTransaction, 'eth_sign') // default option.

核准交易

批准使用当前所有者账户进行散列.

const safeTransactionData: SafeTransactionDataPartial = {
  // ...
}
const safeTransaction =  await safeSdk.createTransaction({ safeTransactionData })
const txHash = await safeSdk.getTransactionHash(safeTransaction)
const txResponse = await safeSdk.approveTransactionHash(txHash)
await txResponse.transactionResponse?.wait()

可选的,一些属性可以作为执行选项传递:

const options: Web3TransactionOptions = {
  from, // Optional
  gas, // Optional
  gasPrice, // Optional
  maxFeePerGas, // Optional
  maxPriorityFeePerGas // Optional
  nonce // Optional
}
const options: EthersTransactionOptions = {
  from, // Optional
  gasLimit, // Optional
  gasPrice, // Optional
  maxFeePerGas, // Optional
  maxPriorityFeePerGas // Optional
  nonce // Optional
}
const txResponse = await safeSdk.approveTransactionHash(txHash, options)

获得Owners Who Approved Tx 许可

返回已批准特定安全交易的所有人名单.

const safeTransactionData: SafeTransactionDataPartial = {
  // ...
}
const safeTransaction =  await safeSdk.createTransaction({ safeTransactionData })
const txHash = await safeSdk.getTransactionHash(safeTransaction)
const ownerAddresses = await safeSdk.getOwnersWhoApprovedTx(txHash)

创建 EnableFallBack HandlerTx 程序

返回 Safe 交易以启用倒置处理器 .

const safeTransaction = await safeSdk.createEnableFallbackHandlerTx(fallbackHandlerAddress)
const txResponse = await safeSdk.executeTransaction(safeTransaction)
await txResponse.transactionResponse?.wait()

此方法可选择接受 options 参数 :

const options: SafeTransactionOptionalProps = {
  safeTxGas, // Optional
  baseGas, // Optional
  gasPrice, // Optional
  gasToken, // Optional
  refundReceiver, // Optional
  nonce // Optional
}
const safeTransaction = await safeSdk.createEnableFallbackHandlerTx(fallbackHandlerAddress, options)

创建不可移动反光汉德勒Tx

返回安全交易以禁用后退处理器 .

const safeTransaction = await safeSdk.createDisableFallbackHandlerTx()
const txResponse = await safeSdk.executeTransaction(safeTransaction)
await txResponse.transactionResponse?.wait()

此方法可选择接受 options 参数 :

const options: SafeTransactionOptionalProps = { ... }
const safeTransaction = await safeSdk.createDisableFallbackHandlerTx(options)

创建可创建的守护Tx

返回安全交易以启用安全警卫.

const safeTransaction = await safeSdk.createEnableGuardTx(guardAddress)
const txResponse = await safeSdk.executeTransaction(safeTransaction)
await txResponse.transactionResponse?.wait()

此方法可选择接受 options 参数 :

const options: SafeTransactionOptionalProps = {
  safeTxGas, // Optional
  baseGas, // Optional
  gasPrice, // Optional
  gasToken, // Optional
  refundReceiver, // Optional
  nonce // Optional
}
const safeTransaction = await safeSdk.createEnableGuardTx(guardAddress, options)

创建可禁用守护Tx

返回安全交易以禁用安全警卫.

const safeTransaction = await safeSdk.createDisableGuardTx()
const txResponse = await safeSdk.executeTransaction(safeTransaction)
await txResponse.transactionResponse?.wait()

此方法可选择接受 options 参数 :

const options: SafeTransactionOptionalProps = { ... }
const safeTransaction = await safeSdk.createDisableGuardTx(options)

创建可创建的模块Tx

A 安全交易准备就绪,可以使用安全模块.

const safeTransaction = await safeSdk.createEnableModuleTx(moduleAddress)
const txResponse = await safeSdk.executeTransaction(safeTransaction)
await txResponse.transactionResponse?.wait()

此方法可选择接受 options 参数 :

const options: SafeTransactionOptionalProps = { ... }
const safeTransaction = await safeSdk.createEnableModuleTx(moduleAddress, options)

创建可拆卸模块Tx

返回一个安全交易,准备签名,将禁用安全模块.

const safeTransaction = await safeSdk.createDisableModuleTx(moduleAddress)
const txResponse = await safeSdk.executeTransaction(safeTransaction)
await txResponse.transactionResponse?.wait()

此方法可选择接受 options 参数 :

const options: SafeTransactionOptionalProps = { ... }
const safeTransaction = await safeSdk.createDisableModuleTx(moduleAddress, options)

创建AddOwnerTx

返回“安全”交易,以添加所有者,并选择更改阈值.

const params: AddOwnerTxParams = {
  ownerAddress,
  threshold // Optional. If `threshold` is not provided the current threshold will not change.
}
const safeTransaction = await safeSdk.createAddOwnerTx(params)
const txResponse = await safeSdk.executeTransaction(safeTransaction)
await txResponse.transactionResponse?.wait()

此方法可选择接受 options 参数 :

const options: SafeTransactionOptionalProps = { ... }
const safeTransaction = await safeSdk.createAddOwnerTx(params, options)

创建 Remove OwnerTx

返回安全交易以删除所有者并选择更改阈值.

const params: RemoveOwnerTxParams = {
  ownerAddress,
  newThreshold // Optional. If `newThreshold` is not provided, the current threshold will be decreased by one.
}
const safeTransaction = await safeSdk.createRemoveOwnerTx(params)
const txResponse = await safeSdk.executeTransaction(safeTransaction)
await txResponse.transactionResponse?.wait()

此方法可选择接受 options 参数 :

const options: SafeTransactionOptionalProps = { ... }
const safeTransaction = await safeSdk.createRemoveOwnerTx(params, options)

创建 SwapOwnerTx

返回安全交易以替换安全交易的所有人.

const params: SwapOwnerTxParams = {
  oldOwnerAddress,
  newOwnerAddress
}
const safeTransaction = await safeSdk.createSwapOwnerTx(params)
const txResponse = await safeSdk.executeTransaction(safeTransaction)
await txResponse.transactionResponse?.wait()

此方法可选择接受 options 参数 :

const options: SafeTransactionOptionalProps = { ... }
const safeTransaction = await safeSdk.createSwapOwnerTx(params, options)

创建变化风险Tx

返回安全交易以改变阈值.

const safeTransaction = await safeSdk.createChangeThresholdTx(newThreshold)
const txResponse = await safeSdk.executeTransaction(safeTransaction)
await txResponse.transactionResponse?.wait()

此方法可选择接受 options 参数 :

const options: SafeTransactionOptionalProps = { ... }
const safeTransaction = await safeSdk.createChangeThresholdTx(newThreshold, options)

变相交易

检查安全交易是否能够成功执行, 没有出错 .

const safeTransactionData: SafeTransactionDataPartial = {
  // ...
}
const safeTransaction =  await safeSdk.createTransaction({ safeTransactionData })
const isValidTx = await safeSdk.isValidTransaction(safeTransaction)

可选的,一些属性可以作为执行选项传递:

const options: Web3TransactionOptions = {
  from, // Optional
  gas, // Optional
  gasPrice, // Optional
  maxFeePerGas, // Optional
  maxPriorityFeePerGas // Optional
  nonce // Optional
}
const options: EthersTransactionOptions = {
  from, // Optional
  gasLimit, // Optional
  gasPrice, // Optional
  maxFeePerGas, // Optional
  maxPriorityFeePerGas // Optional
  nonce // Optional
}
const isValidTx = await safeSdk.isValidTransaction(safeTransaction, options)

执行交易

执行安全交易.

const safeTransactionData: SafeTransactionDataPartial = {
  // ...
}
const safeTransaction =  await safeSdk.createTransaction({ safeTransactionData })
const txResponse = await safeSdk.executeTransaction(safeTransaction)
await txResponse.transactionResponse?.wait()

可选的,一些属性可以作为执行选项传递:

const options: Web3TransactionOptions = {
  from, // Optional
  gas, // Optional
  gasPrice, // Optional
  maxFeePerGas, // Optional
  maxPriorityFeePerGas // Optional
  nonce // Optional
}
const options: EthersTransactionOptions = {
  from, // Optional
  gasLimit, // Optional
  gasPrice, // Optional
  maxFeePerGas, // Optional
  maxPriorityFeePerGas // Optional
  nonce // Optional
}
const txResponse = await safeSdk.executeTransaction(safeTransaction, options)

许可证

这个库在麻省理工学院下发行.

贡献者

  • 热尔曼·马丁内斯(签名)德国(中文(简体) )

版本与发布记录

@gnosis.pm/safe-core-sdk 共发布 26 个版本,首次发布于 2021/05/05;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.2.0latest2022/11/233 年前
3.1.12022/09/224 年前
3.1.02022/09/214 年前
3.0.02022/08/314 年前
2.3.22022/08/034 年前
2.2.32022/08/034 年前

关于 @gnosis.pm/safe-core-sdk 的常见问题

@gnosis.pm/safe-core-sdk 是什么?

安全核心 SDK注意:该包已被作者标记为弃用——Package no longer supported. It has been migrated to @safe-global/protocol-kit. Please, update your dependencies.

如何安装 @gnosis.pm/safe-core-sdk?

在项目目录运行 npm install @gnosis.pm/safe-core-sdk,或使用 pnpm add / yarn add / bun add。

@gnosis.pm/safe-core-sdk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gnosis.pm/safe-core-sdk 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@gnosis.pm/safe-core-sdk 可以商用吗?

@gnosis.pm/safe-core-sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gnosis.pm/safe-core-sdk 的下载量有多少?

根据 npm 官方下载统计,@gnosis.pm/safe-core-sdk 在 2026/10/17 – 2026/11/15 这 30 天内被下载 14,380 次,日均约 479 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gnosis.pm/safe-core-sdk 还在维护吗?

最新版本 3.2.0 发布于 2022/11/23(3 年前);至今共发布 26 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/05/05。作者已将其标记为弃用,新项目建议寻找替代方案。