编写和发布 scrypt-ts 库合约

Posted 2022-12-28 sCrypt 智能合约

近期我们发布了名为 scrypt-ts 的项目，允许开发者可以使用 Typesript 语言开发 BSV 智能合约。今天很高兴在这里宣布一个最新进展，大家可以使用 npm 直接发布和使用 scrypt-ts 的库合约了。

什么是 scrypt-ts 库合约？

智能合约库可以提供可以在许多合约中重复使用的功能，开发人员可以使用现有的库来降低开发自己的合约的成本。

scrypt-ts 智能库合约与普通合约有以下不同：

• 一个库合约不能有任何 public/entry @methods，这意味着一个库不能通过 tx 直接部署或调用，它们只能在普通合约或其他库中被调用。

• 库合约不能有任何状态属性，即被标记为 @prop(true) 的属性，但声明为 @prop() 的属性是可以的。

编写库合约

使用 scrypt-ts 我们可以像下面这样创建一个库合约类：

class MyLib extends SmartContractLib 

  @prop()
  buf: ByteString;

  constructor(buf: ByteString) 
    super(buf);
    this.buf = buf;
  

  @method
  append(content: ByteString) 
    this.buf += content;
  

  @method
  static add(x: bigint, y: bigint): bigint 
    return x + y;
  

库合约需要声明为扩展 SmartContractLib 的类。它和普通合约一样也可能有 @props 和 @methods ，它们都需遵循之前介绍过的规则。 库合约的方法可以在 @methods 被使用，如下所示：

class MyContract extends SmartContract 
  @method
  public unlock(x: ByteString) 
    // 创建库合约的实例
    let myLib = new MyLib(hexToByteString('0123'));
    // 调用库合约实例方法
    myLib.append(x);
    // 调用库合约静态方法
    assert(MyLib.add(1n, 2n) === 3n);
  

测试库合约

你可以像测试普通类一样测试库合约，例如编写一些单元测试：

describe('Test SmartContractLib `MyLib`', () => 
  it('should pass unit test successfully.', () => 
    expect(MyLib.add(1n, 2n)).to.eq(3n);
  )
)

另外，你可以写一个普通合约来调用库合约，之后针对普通合约编写一些测试，比如：

// 测试用的普通合约
class TestLib extends SmartContract 
  @method
  public unlock(x: bigint) 
    // 调用库合约方法
    assert(MyLib.add(1n, 2n) === x);
  


describe('Test SmartContractLib `Lib`', () => 
  before(async() => 
    await TestLib.compile();
  )

  it('should pass integration test successfully.', () => 
    let testLib = new TestLib();
    // 直接测试普通合约的公共方法
    let result = testLib.verify(self => self.unlock(3n));
    expect(result.success, result.error).to.be.true;
  
)

发布库合约

如果你已经构建了一个库合约，你可以考虑将它发布为一个 npm 包。 请注意，为了使导入系统正常工作，你应该始终发布自动生成的 sCrypt 合约（包括 scrypt.index.json 文件）以及 javascript 输出。 包的结构可能是这样的：

node_modules
|__ my_package
    |__ dist
        |__ myLib.js
        |__ myLib.d.ts
    |__ scrypts
        |__ myLib.scrypt
    |__ scrypt.index.json
    …

scrypt.index.json 文件将在 typescript 编译时生成在与 tsconfig.json 相同的目录中，该目录应放在根文件夹中，并且不要手动移动或修改它。 你可以通过在 tsconfig.json 中配置 outDir 选项来更改自动生成的 sCrypt 文件的文件夹，例如：

"compilerOptions": 
  "plugins": [
    
      "transform": "../dist/transformer",
      "transformProgram": "true",
      "outDir": "my_scrypts_dir"
    
  ]

库合约的用户可以使用 npm install 来安装它，然后将导出的库合约作为普通模块来使用。

请注意，目前尚不支持命名导入。 你只使用类似这样的导入语句：

import  MyLib  from “my_package”;

相关工具

scrypt-ts-lib 是我们提供的一个智能合约库的集合，你可以在这里找到一些有用的工具，同样也欢迎大家发起 PR 贡献自己的库合约。