@alephium/web3 0.2.0-rc.4 → 0.2.0-rc.5

package/templates/base/package.json

@@ -3,7 +3,7 @@
   "version": "0.1.0",
   "license": "GPL",
   "config": {
-    "alephium_version": "1.5.0-rc4"
+    "alephium_version": "1.5.0-rc5"
   },
   "scripts": {
     "build": "rm -rf dist && npx tsc --build .",
@@ -12,7 +12,7 @@
     "stop-devnet": "node scripts/stop-devnet.js"
   },
   "dependencies": {
-    "@alephium/web3": "0.2.0-rc.4"
+    "@alephium/web3": "0.2.0-rc.5"
   },
   "devDependencies": {
     "@types/elliptic": "^6.4.13",

package/templates/react/package.json

@@ -2,7 +2,7 @@
   "name": "my-dapp",
   "version": "0.1.0",
   "config": {
-    "alephium_version": "1.5.0-rc4"
+    "alephium_version": "1.5.0-rc5"
   },
   "dependencies": {
     "@testing-library/jest-dom": "^5.16.4",
@@ -12,7 +12,7 @@
     "@types/node": "^16.11.26",
     "@types/react": "^18.0.3",
     "@types/react-dom": "^18.0.0",
-    "@alephium/web3": "0.2.0-rc.4",
+    "@alephium/web3": "0.2.0-rc.5",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
     "react-scripts": "5.0.1",

package/test/contract.test.ts

@@ -20,16 +20,18 @@ import * as fs from 'fs'
 import * as path from 'path'
 
 import { NodeProvider } from '../src/api'
-import { Contract, Script, TestContractParams } from '../src/contract'
+import { Contract, Project, Script, TestContractParams } from '../src/contract'
 import { testWallet } from '../src/test'
 import { addressFromContractId } from '../src/utils'
 
 describe('contract', function () {
   async function testSuite1() {
     const provider = new NodeProvider('http://127.0.0.1:22973')
+    await Project.build(provider)
 
-    const add = await Contract.fromSource(provider, 'add/add.ral')
-    const sub = await Contract.fromSource(provider, 'sub/sub.ral')
+    // ignore unused private function warnings
+    const add = Project.contract('add/add.ral', false)
+    const sub = Project.contract('sub/sub.ral')
 
     const subState = sub.toState({ result: 0 }, { alphAmount: BigInt('1000000000000000000') })
     const testParams: TestContractParams = {
@@ -37,7 +39,7 @@ describe('contract', function () {
       testArgs: { array: [2, 1] },
       existingContracts: [subState]
     }
-    const testResult = await add.testPublicMethod(provider, 'add', testParams)
+    const testResult = await add.testPublicMethod('add', testParams)
     expect(testResult.returns).toEqual([[3, 1]])
     expect(testResult.contracts[0].codeHash).toEqual(sub.codeHash)
     expect(testResult.contracts[0].fields.result).toEqual(1)
@@ -52,7 +54,7 @@ describe('contract', function () {
     expect(events[1].fields.x).toEqual(2)
     expect(events[1].fields.y).toEqual(1)
 
-    const testResultPrivate = await add.testPrivateMethod(provider, 'addPrivate', testParams)
+    const testResultPrivate = await add.testPrivateMethod('addPrivate', testParams)
     expect(testResultPrivate.returns).toEqual([[3, 1]])
 
     const signer = await testWallet(provider)
@@ -85,13 +87,13 @@ describe('contract', function () {
     const addContractAddress = addressFromContractId(addContractId)
 
     // Check state for add/sub before main script is executed
-    let fetchedSubState = await sub.fetchState(provider, subContractAddress, 0)
+    let fetchedSubState = await sub.fetchState(subContractAddress, 0)
     expect(fetchedSubState.fields.result).toEqual(0)
-    let fetchedAddState = await add.fetchState(provider, addContractAddress, 0)
+    let fetchedAddState = await add.fetchState(addContractAddress, 0)
     expect(fetchedAddState.fields.subContractId).toEqual(subContractId)
     expect(fetchedAddState.fields.result).toEqual(0)
 
-    const main = await Script.fromSource(provider, 'main.ral')
+    const main = Project.script('main.ral')
     const mainScriptTx = await main.transactionForDeployment(signer, {
       initialFields: { addContractId: addContractId }
     })
@@ -102,22 +104,23 @@ describe('contract', function () {
     expect(mainSubmitResult.toGroup).toEqual(0)
 
     // Check state for add/sub after main script is executed
-    fetchedSubState = await sub.fetchState(provider, subContractAddress, 0)
+    fetchedSubState = await sub.fetchState(subContractAddress, 0)
     expect(fetchedSubState.fields.result).toEqual(1)
-    fetchedAddState = await add.fetchState(provider, addContractAddress, 0)
+    fetchedAddState = await add.fetchState(addContractAddress, 0)
     expect(fetchedAddState.fields.subContractId).toEqual(subContractId)
     expect(fetchedAddState.fields.result).toEqual(3)
   }
 
   async function testSuite2() {
     const provider = new NodeProvider('http://127.0.0.1:22973')
+    await Project.build(provider)
 
-    const greeter = await Contract.fromSource(provider, 'greeter/greeter.ral')
+    const greeter = Project.contract('greeter/greeter.ral')
 
     const testParams: TestContractParams = {
       initialFields: { btcPrice: 1 }
     }
-    const testResult = await greeter.testPublicMethod(provider, 'greet', testParams)
+    const testResult = await greeter.testPublicMethod('greet', testParams)
     expect(testResult.returns).toEqual([1])
     expect(testResult.contracts[0].codeHash).toEqual(greeter.codeHash)
     expect(testResult.contracts[0].fields.btcPrice).toEqual(1)
@@ -136,7 +139,7 @@ describe('contract', function () {
     expect(submitResult.txId).toEqual(deployTx.txId)
 
     const greeterContractId = deployTx.contractId
-    const main = await Script.fromSource(provider, 'greeter_main.ral')
+    const main = Project.script('greeter_main.ral')
 
     const mainScriptTx = await main.transactionForDeployment(signer, {
       initialFields: { greeterContractId: greeterContractId }
@@ -167,6 +170,14 @@ describe('contract', function () {
     Script.fromJson(loadJson(fileName))
   }
 
+  it('should load source files by order', async () => {
+    const sourceFiles = await Project['loadSourceFiles']('./contracts') // `loadSourceFiles` is a private method
+    expect(sourceFiles.length).toEqual(8)
+    sourceFiles.slice(0, 5).forEach((c) => expect(c.type).toEqual(0)) // contracts
+    sourceFiles.slice(5, 7).forEach((s) => expect(s.type).toEqual(1)) // scripts
+    sourceFiles.slice(7).forEach((i) => expect(i.type).toEqual(3)) // interfaces
+  })
+
   it('should load contract from json', async () => {
     loadContract('./artifacts/add/add.ral.json')
     loadContract('./artifacts/sub/sub.ral.json')
@@ -178,7 +189,8 @@ describe('contract', function () {
 
   it('should extract metadata of contracts', async () => {
     const provider = new NodeProvider('http://127.0.0.1:22973')
-    const contract = await Contract.fromSource(provider, 'test/metadata.ral')
+    await Project.build(provider)
+    const contract = Project.contract('test/metadata.ral', false)
     expect(contract.functions.map((func) => func.name)).toEqual(['foo', 'bar', 'baz'])
     expect(contract.publicFunctions()).toEqual(['foo'])
     expect(contract.usingPreapprovedAssetsFunctions()).toEqual(['foo'])
@@ -187,14 +199,15 @@ describe('contract', function () {
 
   it('should handle compiler warnings', async () => {
     const provider = new NodeProvider('http://127.0.0.1:22973')
-    const contract = await Contract.fromSource(provider, 'test/warnings.ral', false)
+    await Project.build(provider)
+    const contract = Project.contract('test/warnings.ral', false)
     expect(contract.publicFunctions()).toEqual(['foo'])
 
-    await expect(Contract.fromSource(provider, 'test/warnings.ral')).rejects.toThrowError(
-      'Compilation warnings:\n  - Found unused variables in function foo: foo.y\n  - Found unused fields: b'
+    expect(() => Project.contract('test/warnings.ral')).toThrowError(
+      'Compilation warnings:\n  - Found unused variables in Warnings: foo.y\n  - Found unused fields in Warnings: b'
     )
-    await expect(Contract.fromSource(provider, 'test/warnings.ral', true, false)).rejects.toThrowError(
-      'Compilation warnings:\n  - Found unused variables in function foo: foo.y\n  - Found unused constants: C\n  - Found unused fields: b'
+    expect(() => Project.contract('test/warnings.ral', true, false)).toThrowError(
+      'Compilation warnings:\n  - Found unused variables in Warnings: foo.y\n  - Found unused constants in Warnings: C\n  - Found unused fields in Warnings: b'
     )
   })
 })

package/test/events.test.ts

@@ -18,15 +18,17 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 
 import { NodeProvider } from '../src/api'
 import { subscribeToEvents } from '../src/contract/events'
-import { Contract, Script } from '../src/contract'
+import { Project, Script } from '../src/contract'
 import { NodeWallet, SignExecuteScriptTxParams } from '../src/signer'
 import { ContractEvent } from '../src/api/api-alephium'
 import { testWallet } from '../src/test'
 import { SubscribeOptions, timeout } from '../src/utils'
 
 describe('events', function () {
-  async function deployContract(provider: NodeProvider, signer: NodeWallet): Promise<[string, string]> {
-    const sub = await Contract.fromSource(provider, 'sub/sub.ral')
+  async function deployContract(signer: NodeWallet): Promise<[string, string]> {
+    const provider = new NodeProvider('http://127.0.0.1:22973')
+    await Project.build(provider)
+    const sub = Project.contract('sub/sub.ral')
     const subDeployTx = await sub.transactionForDeployment(signer, {
       initialFields: { result: 0 },
       initialTokenAmounts: []
@@ -35,7 +37,8 @@ describe('events', function () {
     const subSubmitResult = await signer.submitTransaction(subDeployTx.unsignedTx, subDeployTx.txId)
     expect(subSubmitResult.txId).toEqual(subDeployTx.txId)
 
-    const add = await Contract.fromSource(provider, 'add/add.ral')
+    // ignore unused private function warnings
+    const add = Project.contract('add/add.ral', false)
     const addDeployTx = await add.transactionForDeployment(signer, {
       initialFields: { subContractId: subContractId, result: 0 },
       initialTokenAmounts: []
@@ -54,9 +57,10 @@ describe('events', function () {
 
   it('should subscribe contract events', async () => {
     const provider = new NodeProvider('http://127.0.0.1:22973')
+    await Project.build(provider)
     const signer = await testWallet(provider)
 
-    const [contractAddress, contractId] = await deployContract(provider, signer)
+    const [contractAddress, contractId] = await deployContract(signer)
     const events: Array<ContractEvent> = []
     const subscriptOptions: SubscribeOptions<ContractEvent> = {
       provider: provider,
@@ -72,7 +76,7 @@ describe('events', function () {
       }
     }
     const subscription = subscribeToEvents(subscriptOptions, contractAddress)
-    const script = await Script.fromSource(provider, 'main.ral')
+    const script = Project.script('main.ral')
     const scriptTxParams = await script.paramsForDeployment({
       initialFields: { addContractId: contractId },
       signerAddress: (await signer.getAccounts())[0].address
@@ -94,9 +98,10 @@ describe('events', function () {
 
   it('should cancel event subscription', async () => {
     const provider = new NodeProvider('http://127.0.0.1:22973')
+    await Project.build(provider)
     const signer = await testWallet(provider)
 
-    const [contractAddress, contractId] = await deployContract(provider, signer)
+    const [contractAddress, contractId] = await deployContract(signer)
     const events: Array<ContractEvent> = []
     const subscriptOptions = {
       provider: provider,
@@ -112,7 +117,7 @@ describe('events', function () {
       }
     }
     const subscription = subscribeToEvents(subscriptOptions, contractAddress)
-    const script = await Script.fromSource(provider, 'main.ral')
+    const script = Project.script('main.ral')
     const scriptTx0 = await script.transactionForDeployment(signer, {
       initialFields: { addContractId: contractId }
     })

package/test/transaction.test.ts

@@ -18,7 +18,7 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 
 import { NodeProvider } from '../src/api'
 import { subscribeToTxStatus } from '../src/transaction/status'
-import { Contract } from '../src/contract'
+import { Project } from '../src/contract'
 import { TxStatus } from '../src/api/api-alephium'
 import { testWallet } from '../src/test'
 import { SubscribeOptions, timeout } from '../src/utils'
@@ -26,7 +26,8 @@ import { SubscribeOptions, timeout } from '../src/utils'
 describe('transactions', function () {
   it('should subscribe transaction status', async () => {
     const provider = new NodeProvider('http://127.0.0.1:22973')
-    const sub = await Contract.fromSource(provider, 'sub/sub.ral')
+    await Project.build(provider)
+    const sub = Project.contract('sub/sub.ral')
     const signer = await testWallet(provider)
     const subDeployTx = await sub.transactionForDeployment(signer, {
       initialFields: { result: 0 },
@@ -67,6 +68,7 @@ describe('transactions', function () {
     const counterAfterUnsubscribe = counter
     await timeout(1500)
     expect(txStatus).toMatchObject({ type: 'Confirmed' })
-    expect(counterAfterUnsubscribe).toEqual(counter)
+    // There maybe a pending request when we unsubscribe
+    expect([counter, counter - 1]).toContain(counterAfterUnsubscribe)
   }, 10000)
 })