sdk-core v12

[schimih]

sdk-core v12 is now released 🎉

See the updated cookbook. Also, see the migration notes.

We've added support for guarded transactions: see the new fields transaction.guardian, transaction.guardianSignature and the function transaction.applyGuardianSignature().

Creating a guarded transaction looks as follows:

const transaction = new Transaction({
    nonce: 42
    sender: addressOfAlice,
    receiver: addressOfBob,
    value: "1000000000000000000"
    gasLimit: 100000
    chainID: "D"
    guardian: addressOfTheGuardian,
    options: TransactionOptions.withOptions({ guarded: true }),
    version: TransactionVersion.withTxOptions(),
});

...

transaction.applySignature(...);
transaction.applyGuardianSignature(...);

Passing the sender is now required on most transaction builders (not only on the Transaction constructor). For example, you are required to pass the caller when using smartContract.call() or the deployer when using smartContract.deploy(). When using the interactions API, make sure to call interaction.withSender(). transaction.setSender() is also supported (if needed).

For developers of wallet / wallet-like applications: sdk-core v12 supports both sdk-wallet v3 and sdk-wallet v4. Though, we recommend migrating to sdk-wallet v4. Then, signing transactions would look as follows:

const serialized: Buffer = transaction.serializeForSigning();
const signature: Buffer = await signer.sign(serialized);
transaction.applySignature(signature);

We've slightly simplified the loading of an ABI and feeding it to a SmartContract object. See #281. In v12, this is done as follows:

const abiRegistry = AbiRegistry.create({ ... });
const contract = new SmartContract({ address: existingAddress, abi: abiRegistry });

Breaking changes

• transaction.getSignature() now returns a Buffer, instead of a ISignature object.
• TransfersFactory has been renamed to TransferTransactionsFactory
• tokenPayment.toRationalNumber() has been renamed to toAmount() - and, actually, it became private, you cannot use (should not use) it anymore. toPrettyString() is still available, but it may be deprecated in a future release, in favor of a separate, more customizable formatter.
• We've removed the static function TransactionOptions.withTxHashSignOptions. Use the constructor instead, and pass it the necessary flags (options).
• We've slightly altered the constructor of TransactionWatcher.
• The constant TRANSACTION_VERSION_TX_HASH_SIGN has been renamed to TRANSACTION_VERSION_WITH_OPTIONS.
• We've removed SmartContractAbi and ContractInterface - they were over-engineered, designed to handle multiple sets of contract endpoints (namespaces / separate interfaces etc.). We've kept AbiRegistry, which is sufficient.
• abiRegistry.getAllEndpoints has been renamed to getEndpoints().
• SmartContract.setAbi() has been removed. The ABI is passed in constructor only.
• SmartContract.getAbi() is not exposed anymore. When an ABI definition is needed (e.g. endpoint, type), it should be found in the AbiRegistry.
• Removed ContractFunction.equals() - was already deprecated for some time.

Deprecations

• TokenPayment has been deprecated (renamed). Use the new name: TokenTransfer, instead. ITokenPayment became ITokenTransfer, as well. The old names will be removed in the next major version.
• Deprecated the parameter sender of interaction.withSingleESDTNFTTransfer() and interaction.withMultiESDTNFTTransfer(). Use interaction.withSender() instead.
• Directly reading or setting the fields transaction.options, transaction.version is now deprecated. Use the get* and set* functions, instead.

Pull Requests

• Guarded transaction by @schimih in Guarded transaction #239
• support for guarded transactions for v1 relayed tx by @schimih in support for guarded transactions for v1 relayed tx #251
• TokenPayment -> TokenTransfer by @andreibancioiu in TokenPayment -> TokenTransfer #266
• Make v12 work both with wallet v3 and wallet-next. GetSignature() now returns Buffer. by @andreibancioiu in Make v12 work both with wallet v3 and wallet-next. GetSignature() now returns Buffer. #269
• Breaking change / simplification: remove "SmartContractAbi"; "AbiRegistry" is sufficient in Breaking change / simplification: remove "SmartContractAbi"; "AbiRegistry" is sufficient #281.
• A few improvements, a few deprecations (v12) by @andreibancioiu in A few improvements, a few deprecations (v12) #265
• Adjust interface of transaction in Adjust interface of transaction #280
• Fix sort custom types abi by @nvergez in Fix sort custom types abi #224
• fix: Update type of abiRegistry types by @maximechbt in fix: Update type of abiRegistry types #223
• Adjust construction of transaction options (breaking change) by @andreibancioiu in Adjust construction of transaction options (breaking change) #275
• fix relayed V1 tests by @schimih in fix relayed V1 tests #252
• Add a new parameter to the TransactionWatcher: "patience" by @andreibancioiu in Add a new parameter to the TransactionWatcher: "patience" #260

New Contributors

• @maximechbt made their first contribution in fix: Update type of abiRegistry types #223
• @schimih made their first contribution in Merge main in feat erdjs v12 #238