Releases: OffchainLabs/arbitrum-orbit-sdk
v0.24.1
Summary
This release aligns how keys are sorted in the chain config object to match the behavior of Nitro.
What's Changed
Other
Full Changelog: v0.24.0...v0.24.1
v0.24.0
Summary
RollupCreator Multi-Version Support
Previously, support for Nitro contracts v2.1 and v3.1 (which use BoLD) was split across versions v0.22.* and v0.23.* of the SDK, respectively. This release simplifies things by adding support for both versions in a single build.
A couple of utilities now accept an optional parameter called rollupCreatorVersion
(accepted values are v2.1
and v3.1
with latest being the default), and have smarter types that reflect the version chosen:
createRollup
createRollupPrepareTransactionRequest
createRollupPrepareDeploymentParamsConfig
createRollupPrepareDeploymentParamsConfigDefaults
createRollupGetRetryablesFees
createRollupGetCallValue
createRollupEncodeFunctionData
createRollupEnoughCustomFeeTokenAllowance
createRollupPrepareCustomFeeTokenApprovalTransactionRequest
getRollupCreatorAddress
This change is fully backwards compatible. If you're coming from v0.23.*, no changes to your code are required. If you're coming from v0.22.*, the changes required are minimal, with you only having to explicitly provide v2.1
as the version to be used:
+ const rollupCreatorVersion = 'v2.1' as const;
createRollupPrepareTransactionRequest({
params: {
config: createRollupPrepareDeploymentParamsConfig(
publicClient,
{ chainId, owner },
+ rollupCreatorVersion,
),
batchPosters,
validators,
},
account: deployer.address,
publicClient,
+ rollupCreatorVersion,
}),
ArbOS 40
ArbOS 40 is now the default for new deployments, both using v2.1 and v3.1.
ArbOS Upgrade Scheduling
Added the buildScheduleArbOSUpgrade
action for easier of ArbOS upgrade scheduling.
What's Changed
- feat: add action for scheduling ArbOS upgrades by @spsjvc in #479
- refactor: add dedicated v3.1 deployment params files by @spsjvc in #498
- feat: add dedicated v2.1 deployment params files by @spsjvc in #499
- feat: add versioning to deployment params config by @spsjvc in #500
- feat: update createRollupGetRetryablesFees versioning by @spsjvc in #501
- feat: update createRollupEncodeFunctionData versioning by @spsjvc in #502
- feat: add versioning to createRollup by @spsjvc in #503
- refactor: clean up RollupCreator versioning types by @spsjvc in #504
- feat: default to ArbOS 40 by @spsjvc in #505
Other
- build: bump vitest from 3.0.9 to 3.2.4 by @spsjvc in #497
- test: fix async expect calls in unit tests by @spsjvc in #511
- chore: update audit-ci.jsonc by @spsjvc in #520
Full Changelog: v0.23.5...v0.24.0
v0.23.5
Summary
This release fixes a bug in createRollupFetchTransactionHash
so that upgrades of the Rollup contract (e.g. for BoLD) are properly handled and the original deployment is fetched.
It also adds the option to specify the version of RollupCreator to be used in certain utilities, with more to be added in a future release.
What's Changed
- feat: add versioning to
getRollupCreatorAddress
by @spsjvc in #470 - feat: add versioning to
createRollupGetRetryablesFees
by @spsjvc in #471 - feat: add versioning to
createRollupPrepareDeploymentParamsConfigDefaults
by @spsjvc in #487 - feat: add versioning to
createRollupEncodeFunctionData
by @spsjvc in #488 - fix: handle rollup upgrades when querying tx hash by @spsjvc in #489
Full Changelog: v0.23.4...v0.23.5
v0.22.5
Summary
This release fixes a bug in createRollupFetchTransactionHash
so that upgrades of the Rollup contract (e.g. for BoLD) are properly handled and the original deployment is fetched.
What's Changed
Full Changelog: v0.22.4...v0.22.5
v0.23.4
Summary
This release adds generateBridgeUiConfig
for easily generating a config to be used in the Arbitrum Bridge UI.
What's Changed
- feat: add generateBridgeUiConfig with example by @Jason-W123 in #396
Other
- docs: update README.md by @yahgwai in #397
- test: update expected ArbOS version to 40 by @spsjvc in #398
- ci: update testnode ref by @spsjvc in #399
- feat: add custom recipient support for fee distributors by @yahgwai in #426
- build(deps): bump pbkdf2 and update audit-ci.jsonc by @spsjvc in #472
New Contributors
Full Changelog: v0.23.3...v0.23.4
v0.22.4
Summary
This release adds generateBridgeUiConfig
for easily generating a config to be used in the Arbitrum Bridge UI.
What's Changed
- feat: add generateBridgeUiConfig with example by @Jason-W123 in #396
Other
- docs: update README.md by @yahgwai in #397
- test: update expected ArbOS version to 40 by @spsjvc in #398
- ci: update testnode ref by @spsjvc in #399
- feat: add custom recipient support for fee distributors by @yahgwai in #426
- build(deps): bump pbkdf2 and update audit-ci.jsonc by @spsjvc in #472
New Contributors
Full Changelog: v0.22.3...v0.22.4
v0.23.3
v0.22.3
v0.23.2
Summary
This release adds prepareKeysetHash
for generating keyset hashes for AnyTrust (read more here), and dependency updates.
What's Changed
Other
- build(deps-dev): bump vitest from 3.0.9 to 3.1.4 by @dependabot in #284
- build(deps-dev): bump audit-ci from 7.0.1 to 7.1.0 by @dependabot in #286
- build(deps): bump @safe-global/protocol-kit from 4.0.2 to 4.1.7 by @dependabot in #291
- build(deps): bump @arbitrum/sdk from 4.0.2 to 4.0.4 by @dependabot in #293
Full Changelog: v0.23.1...v0.23.2
v0.22.2
Summary
This release adds prepareKeysetHash
for generating keyset hashes for AnyTrust (read more here), and dependency updates.
What's Changed
Other
- build(deps-dev): bump vitest from 3.0.9 to 3.1.4 by @dependabot in #284
- build(deps-dev): bump audit-ci from 7.0.1 to 7.1.0 by @dependabot in #286
- build(deps): bump @safe-global/protocol-kit from 4.0.2 to 4.1.7 by @dependabot in #291
- build(deps): bump @arbitrum/sdk from 4.0.2 to 4.0.4 by @dependabot in #293
Full Changelog: v0.22.1...v0.22.2