@centrifuge/sdk 1.10.0 → 1.12.1

package/dist/utils/workflowExecute.test.js

@@ -0,0 +1,117 @@
+import { expect } from 'chai';
+import { decodeAbiParameters } from 'viem';
+import { applyWorkflowExclusions, encodeConfigurableValue, encodeWorkflowInputValue, isWorkflowInputOptional, } from './workflowExecute.js';
+const ADDRESS_A = '0x1111111111111111111111111111111111111111';
+const ADDRESS_B = '0x2222222222222222222222222222222222222222';
+/** Minimal workflow whose actions carry the given `optional` flags. */
+function workflowWithActions(optionalFlags) {
+    return {
+        workflowRef: 'wf',
+        name: 'WF',
+        template: 't',
+        chainId: 1,
+        variables: {},
+        workflowId: `0x${'0'.repeat(64)}`,
+        version: 1,
+        actions: optionalFlags.map((optional, i) => ({
+            target: '$spoke',
+            selector: `function a${i}()`,
+            inputs: [],
+            optional,
+        })),
+    };
+}
+describe('utils/workflowExecute', () => {
+    describe('encodeWorkflowInputValue', () => {
+        it('encodes integer types', () => {
+            const encoded = encodeWorkflowInputValue('uint256', '100');
+            expect(encoded).to.match(/^0x[0-9a-f]{64}$/);
+            expect(decodeAbiParameters([{ type: 'uint256' }], encoded)[0]).to.equal(100n);
+            // uint128 (and other widths) go through the same path
+            expect(decodeAbiParameters([{ type: 'uint128' }], encodeWorkflowInputValue('uint128', '42'))[0]).to.equal(42n);
+        });
+        it('encodes addresses (case-insensitive)', () => {
+            const encoded = encodeWorkflowInputValue('address', ADDRESS_A);
+            expect(decodeAbiParameters([{ type: 'address' }], encoded)[0].toLowerCase()).to.equal(ADDRESS_A);
+        });
+        it('rejects a non-address for an address parameter', () => {
+            expect(() => encodeWorkflowInputValue('address', 'not-an-address')).to.throw();
+        });
+        it('encodes booleans', () => {
+            expect(decodeAbiParameters([{ type: 'bool' }], encodeWorkflowInputValue('bool', 'true'))[0]).to.equal(true);
+            expect(decodeAbiParameters([{ type: 'bool' }], encodeWorkflowInputValue('bool', 'false'))[0]).to.equal(false);
+            expect(() => encodeWorkflowInputValue('bool', 'yes')).to.throw();
+        });
+        it('encodes fixed bytes and rejects the wrong length', () => {
+            const value = `0x${'ab'.repeat(32)}`;
+            expect(decodeAbiParameters([{ type: 'bytes32' }], encodeWorkflowInputValue('bytes32', value))[0]).to.equal(value);
+            expect(() => encodeWorkflowInputValue('bytes32', '0xabcd')).to.throw();
+        });
+        it('encodes an (address,uint256)[] from newline-separated lines', () => {
+            const encoded = encodeWorkflowInputValue('(address,uint256)[]', `${ADDRESS_A}, 1\n${ADDRESS_B}, 2`);
+            const [tuples] = decodeAbiParameters([{ type: 'tuple[]', components: [{ type: 'address' }, { type: 'uint256' }] }], encoded);
+            expect(tuples).to.have.length(2);
+            expect(tuples[0][0].toLowerCase()).to.equal(ADDRESS_A);
+            expect(tuples[1][1]).to.equal(2n);
+        });
+        it('encodes an (address,address)[]', () => {
+            const encoded = encodeWorkflowInputValue('(address,address)[]', `${ADDRESS_A}, ${ADDRESS_B}`);
+            const [tuples] = decodeAbiParameters([{ type: 'tuple[]', components: [{ type: 'address' }, { type: 'address' }] }], encoded);
+            expect(tuples).to.have.length(1);
+            expect(tuples[0][1].toLowerCase()).to.equal(ADDRESS_B);
+        });
+        it('treats array types as optional (empty value encodes an empty array)', () => {
+            const encoded = encodeWorkflowInputValue('(address,uint256)[]', '');
+            const [tuples] = decodeAbiParameters([{ type: 'tuple[]', components: [{ type: 'address' }, { type: 'uint256' }] }], encoded);
+            expect(tuples).to.have.length(0);
+        });
+        it('throws on a missing value for a required (non-array) parameter', () => {
+            expect(() => encodeWorkflowInputValue('uint256', '')).to.throw(/Missing value/);
+        });
+        it('throws on an unsupported parameter type', () => {
+            expect(() => encodeWorkflowInputValue('string', 'hello')).to.throw(/Unsupported/);
+        });
+        it('exposes encodeConfigurableValue as an alias', () => {
+            expect(encodeConfigurableValue).to.equal(encodeWorkflowInputValue);
+        });
+    });
+    describe('isWorkflowInputOptional', () => {
+        it('is true only for the array tuple types', () => {
+            expect(isWorkflowInputOptional('(address,uint256)[]')).to.equal(true);
+            expect(isWorkflowInputOptional('(address,address)[]')).to.equal(true);
+            expect(isWorkflowInputOptional('uint256')).to.equal(false);
+            expect(isWorkflowInputOptional('address')).to.equal(false);
+        });
+    });
+    describe('applyWorkflowExclusions', () => {
+        it('returns the same workflow when nothing is excluded', () => {
+            const wf = workflowWithActions([true, false, true]);
+            expect(applyWorkflowExclusions(wf, [])).to.equal(wf);
+            expect(applyWorkflowExclusions(wf).actions).to.have.length(3);
+        });
+        it('drops an excluded optional action', () => {
+            const wf = workflowWithActions([true, false, true]);
+            const result = applyWorkflowExclusions(wf, [0]);
+            expect(result.actions).to.have.length(2);
+            expect(result.actions.map((a) => a.selector)).to.deep.equal(['function a1()', 'function a2()']);
+            // does not mutate the input
+            expect(wf.actions).to.have.length(3);
+        });
+        it('drops multiple optional actions regardless of input order', () => {
+            const wf = workflowWithActions([true, false, true]);
+            const result = applyWorkflowExclusions(wf, [2, 0]);
+            expect(result.actions.map((a) => a.selector)).to.deep.equal(['function a1()']);
+        });
+        it('throws when excluding a non-optional action', () => {
+            expect(() => applyWorkflowExclusions(workflowWithActions([true, false]), [1])).to.throw(/not optional/);
+        });
+        it('throws on an out-of-range or negative index', () => {
+            expect(() => applyWorkflowExclusions(workflowWithActions([true]), [5])).to.throw(/invalid action index/);
+            expect(() => applyWorkflowExclusions(workflowWithActions([true]), [-1])).to.throw(/invalid action index/);
+        });
+        it('throws when the same action is excluded twice', () => {
+            expect(() => applyWorkflowExclusions(workflowWithActions([true, true]), [0, 0])).to.throw(/more than once/);
+        });
+    });
+});
+//# sourceMappingURL=workflowExecute.test.js.map

package/dist/utils/workflowExecute.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflowExecute.test.js","sourceRoot":"","sources":["../../src/utils/workflowExecute.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAC7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAA;AAE1C,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,GACxB,MAAM,sBAAsB,CAAA;AAE7B,MAAM,SAAS,GAAG,4CAA4C,CAAA;AAC9D,MAAM,SAAS,GAAG,4CAA4C,CAAA;AAE9D,uEAAuE;AACvE,SAAS,mBAAmB,CAAC,aAAwB;IACnD,OAAO;QACL,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,GAAG;QACb,OAAO,EAAE,CAAC;QACV,SAAS,EAAE,EAAE;QACb,UAAU,EAAE,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;QACjC,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YAC3C,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,aAAa,CAAC,IAAI;YAC5B,MAAM,EAAE,EAAE;YACV,QAAQ;SACT,CAAC,CAAC;KAC8B,CAAA;AACrC,CAAC;AAED,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACxC,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;YAC/B,MAAM,OAAO,GAAG,wBAAwB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;YAC1D,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAA;YAC5C,MAAM,CAAC,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAC7E,sDAAsD;YACtD,MAAM,CAAC,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,wBAAwB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAChH,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,MAAM,OAAO,GAAG,wBAAwB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;YAC9D,MAAM,CAAE,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAY,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QAC9G,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,MAAM,CAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;QAChF,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;YAC1B,MAAM,CAAC,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAC3G,MAAM,CAAC,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,wBAAwB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YAC7G,MAAM,CAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;QAClE,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,KAAK,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAA;YACpC,MAAM,CAAC,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,wBAAwB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YACjH,MAAM,CAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;QACxE,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,OAAO,GAAG,wBAAwB,CAAC,qBAAqB,EAAE,GAAG,SAAS,QAAQ,SAAS,KAAK,CAAC,CAAA;YACnG,MAAM,CAAC,MAAM,CAAC,GAAG,mBAAmB,CAClC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,EAC7E,OAAO,CACwC,CAAA;YACjD,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;YAChC,MAAM,CAAE,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAY,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;YACnE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QACpC,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,MAAM,OAAO,GAAG,wBAAwB,CAAC,qBAAqB,EAAE,GAAG,SAAS,KAAK,SAAS,EAAE,CAAC,CAAA;YAC7F,MAAM,CAAC,MAAM,CAAC,GAAG,mBAAmB,CAClC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,EAC7E,OAAO,CACwC,CAAA;YACjD,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;YAChC,MAAM,CAAE,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAY,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QACrE,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,qEAAqE,EAAE,GAAG,EAAE;YAC7E,MAAM,OAAO,GAAG,wBAAwB,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAA;YACnE,MAAM,CAAC,MAAM,CAAC,GAAG,mBAAmB,CAClC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,EAC7E,OAAO,CACkB,CAAA;YAC3B,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QAClC,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACxE,MAAM,CAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;QACjF,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,CAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;QACnF,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,CAAC,uBAAuB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA;QACpE,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACvC,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,CAAC,uBAAuB,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACrE,MAAM,CAAC,uBAAuB,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACrE,MAAM,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YAC1D,MAAM,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QAC5D,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACvC,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,EAAE,GAAG,mBAAmB,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;YACnD,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;YACpD,MAAM,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QAC/D,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC3C,MAAM,EAAE,GAAG,mBAAmB,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;YACnD,MAAM,MAAM,GAAG,uBAAuB,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;YAC/C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;YACxC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC,CAAA;YAC/F,4BAA4B;YAC5B,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QACtC,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,EAAE,GAAG,mBAAmB,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;YACnD,MAAM,MAAM,GAAG,uBAAuB,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;YAClD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,CAAC,CAAA;QAChF,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,CAAC,GAAG,EAAE,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;QACzG,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,CAAC,GAAG,EAAE,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;YACxG,MAAM,CAAC,GAAG,EAAE,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;QAC3G,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,MAAM,CAAC,GAAG,EAAE,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;QAC7G,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@centrifuge/sdk",
-  "version": "1.10.0",
+  "version": "1.12.1",
   "description": "",
   "homepage": "https://github.com/centrifuge/sdk/tree/main#readme",
   "author": "",