@geoprotocol/geo-sdk 0.18.3 → 0.20.0-beta.0

package/dist/src/client/dao-spaces.d.ts

@@ -0,0 +1,380 @@
+import type { Op } from '@geoprotocol/grc-20';
+import type { VoteOption, VotingMode } from '../dao-space/types.js';
+import { type CreateDaoSpaceCalldataParams, type VotingSettingsInput } from '../encodings/get-create-dao-space-calldata.js';
+import type { Id } from '../id.js';
+import type { GeoClientContext } from './context.js';
+export type CreateDaoSpaceParams = Omit<CreateDaoSpaceCalldataParams, 'initialEditsContentUri' | 'initialMemberSpaceIds'> & {
+    name: string;
+    author: Id | string;
+    initialMemberSpaceIds?: `0x${string}`[];
+    ops?: Op[];
+};
+export type ProposalAction = {
+    to: `0x${string}`;
+    value: bigint;
+    data: `0x${string}`;
+};
+export type CreateProposalParams = {
+    fromSpaceId: string;
+    daoSpaceId: string;
+    proposalId?: string;
+    votingMode?: VotingMode;
+    actions: ProposalAction[];
+    updateProposal?: boolean;
+};
+export type ProposeEditParams = {
+    name: string;
+    ops: Op[];
+    author: Id | string;
+    daoSpaceAddress: `0x${string}`;
+    callerSpaceId: string;
+    daoSpaceId: string;
+    votingMode?: VotingMode;
+    proposalId?: string;
+    updateProposal?: boolean;
+    versionId?: number;
+};
+export type VoteProposalParams = {
+    authorSpaceId: string;
+    spaceId: string;
+    proposalId: string;
+    versionId?: number;
+    vote: VoteOption;
+};
+export type ExecuteProposalParams = {
+    authorSpaceId: string;
+    spaceId: string;
+    proposalId: string;
+};
+type DaoSpaceRoleProposalBaseParams = {
+    authorSpaceId: string;
+    spaceId: string;
+    daoSpaceAddress: `0x${string}`;
+    votingMode?: VotingMode;
+    proposalId?: string;
+};
+type SlowDaoSpaceRoleProposalBaseParams = Omit<DaoSpaceRoleProposalBaseParams, 'votingMode'> & {
+    votingMode?: 'SLOW';
+};
+export type ProposeAddMemberParams = DaoSpaceRoleProposalBaseParams & {
+    newMemberSpaceId: string;
+};
+export type ProposeRemoveMemberParams = DaoSpaceRoleProposalBaseParams & {
+    memberToRemoveSpaceId: string;
+};
+export type ProposeAddEditorParams = SlowDaoSpaceRoleProposalBaseParams & {
+    newEditorSpaceId: string;
+};
+export type ProposeRemoveEditorParams = SlowDaoSpaceRoleProposalBaseParams & {
+    editorToRemoveSpaceId: string;
+};
+export type ProposeRequestMembershipParams = {
+    authorSpaceId: string;
+    spaceId: string;
+    proposalId?: string;
+};
+export type ProposeUpdateVotingSettingsParams = SlowDaoSpaceRoleProposalBaseParams & {
+    votingSettings: VotingSettingsInput;
+};
+declare function encodePublishEditProposalAction(daoSpaceAddress: `0x${string}`, cid: string): ProposalAction;
+declare function encodeUpdateVotingSettingsAction(daoSpaceAddress: `0x${string}`, votingSettings: VotingSettingsInput): ProposalAction;
+/**
+ * Publishes the initial DAO edit and returns calldata for creating a DAO space.
+ *
+ * The helper first validates DAO voting settings and required contract
+ * addresses, then creates the space entity ops, publishes the initial edit, and
+ * encodes `createDAOSpaceProxy` calldata using the resulting CID. Unless
+ * `initialTopicId` is provided, the DAO topic is set to the generated space
+ * entity ID.
+ *
+ * @example
+ * ```ts
+ * const tx = await geo.daoSpaces.create({
+ *   name: 'Research DAO',
+ *   author: authorSpaceId,
+ *   initialEditorSpaceIds: [authorSpaceId],
+ *   votingSettings: {
+ *     partialPercentageSupportThreshold: 50,
+ *     universalPercentageSupportThreshold: 90,
+ *     flatSupportThreshold: 1,
+ *     quorum: 1,
+ *     durationInDays: 2,
+ *     disableFastPathAccessForNewMembers: true,
+ *     executionGracePeriodInDays: 14,
+ *   },
+ * });
+ *
+ * await walletClient.sendTransaction({
+ *   to: tx.to,
+ *   data: tx.calldata,
+ * });
+ * ```
+ *
+ * @param context Client context containing network, contract, API, and fetch configuration.
+ * @param params DAO name, author, voting settings, initial editors/members, and optional extra ops.
+ * @returns DAO factory address, calldata, generated space entity ID, and initial edit CID.
+ * @throws When DAO settings are invalid, required contracts are missing, IDs are invalid, or edit publishing fails.
+ */
+export declare function create(context: GeoClientContext, params: CreateDaoSpaceParams): Promise<{
+    to: `0x${string}`;
+    calldata: `0x${string}`;
+    spaceEntityId: Id;
+    cid: `ipfs://${string}`;
+}>;
+/**
+ * Builds calldata for creating or updating a DAO proposal from prebuilt proposal actions.
+ *
+ * This uses the configured `SPACE_REGISTRY_ADDRESS` and encodes a
+ * `GOVERNANCE.PROPOSAL_CREATED` or `GOVERNANCE.PROPOSAL_UPDATED`
+ * `SpaceRegistry.enter(...)` call. Prefer the high-level
+ * `geo.daoSpaces.propose*` helpers for public client code.
+ *
+ * @example
+ * ```ts
+ * const tx = geo.daoSpaces.proposeAddMember({
+ *   authorSpaceId,
+ *   spaceId: daoSpaceId,
+ *   daoSpaceAddress,
+ *   newMemberSpaceId,
+ * });
+ * ```
+ *
+ * @param context Client context containing the target network configuration.
+ * @param params Caller space, DAO space, voting mode, optional proposal ID, and actions.
+ * @returns Target registry address, calldata, and proposal ID.
+ * @throws When IDs are invalid or the configured network is missing `SPACE_REGISTRY_ADDRESS`.
+ * @internal
+ */
+export declare function createProposal(context: GeoClientContext, params: CreateProposalParams): {
+    to: `0x${string}`;
+    calldata: `0x${string}`;
+    proposalId: `0x${string}`;
+};
+/**
+ * Publishes an edit and wraps it in a DAO-space proposal.
+ *
+ * This helper validates the proposal shape before upload, publishes the edit
+ * through the configured API, creates a DAO `ping(...)` action with the
+ * resulting CID, and returns calldata for proposal creation.
+ *
+ * @example
+ * ```ts
+ * const proposal = await geo.daoSpaces.proposeEdit({
+ *   name: 'Update entity',
+ *   ops,
+ *   author: authorSpaceId,
+ *   daoSpaceAddress,
+ *   callerSpaceId: authorSpaceId,
+ *   daoSpaceId,
+ * });
+ * ```
+ *
+ * @param context Client context containing network, contract, API, and fetch configuration.
+ * @param params Edit publication params plus DAO proposal target details.
+ * @returns Edit ID, CID, target registry address, calldata, and proposal ID.
+ * @throws When IDs are invalid, required contracts are missing, or edit publishing fails.
+ */
+export declare function proposeEdit(context: GeoClientContext, params: ProposeEditParams): Promise<{
+    to: `0x${string}`;
+    calldata: `0x${string}`;
+    proposalId: `0x${string}`;
+    editId: Id;
+    cid: `ipfs://${string}`;
+    versionId: number;
+}>;
+/**
+ * Builds calldata for a DAO proposal that adds a member space.
+ *
+ * `daoSpaceAddress` is required because the proposal action calls the DAO
+ * space contract directly.
+ *
+ * @example
+ * ```ts
+ * const tx = geo.daoSpaces.proposeAddMember({
+ *   authorSpaceId,
+ *   spaceId: daoSpaceId,
+ *   daoSpaceAddress,
+ *   newMemberSpaceId: memberSpaceId,
+ * });
+ * ```
+ */
+export declare function proposeAddMember(context: GeoClientContext, params: ProposeAddMemberParams): {
+    to: `0x${string}`;
+    calldata: `0x${string}`;
+    proposalId: `0x${string}`;
+};
+/**
+ * Builds calldata for a DAO proposal that removes a member space.
+ *
+ * @example
+ * ```ts
+ * const tx = geo.daoSpaces.proposeRemoveMember({
+ *   authorSpaceId,
+ *   spaceId: daoSpaceId,
+ *   daoSpaceAddress,
+ *   memberToRemoveSpaceId,
+ * });
+ * ```
+ */
+export declare function proposeRemoveMember(context: GeoClientContext, params: ProposeRemoveMemberParams): {
+    to: `0x${string}`;
+    calldata: `0x${string}`;
+    proposalId: `0x${string}`;
+};
+/**
+ * Builds calldata for a DAO proposal that adds an editor space.
+ *
+ * Editor changes only support SLOW voting.
+ *
+ * @example
+ * ```ts
+ * const tx = geo.daoSpaces.proposeAddEditor({
+ *   authorSpaceId,
+ *   spaceId: daoSpaceId,
+ *   daoSpaceAddress,
+ *   newEditorSpaceId: editorSpaceId,
+ * });
+ * ```
+ */
+export declare function proposeAddEditor(context: GeoClientContext, params: ProposeAddEditorParams): {
+    to: `0x${string}`;
+    calldata: `0x${string}`;
+    proposalId: `0x${string}`;
+};
+/**
+ * Builds calldata for a DAO proposal that removes an editor space.
+ *
+ * Editor changes only support SLOW voting.
+ *
+ * @example
+ * ```ts
+ * const tx = geo.daoSpaces.proposeRemoveEditor({
+ *   authorSpaceId,
+ *   spaceId: daoSpaceId,
+ *   daoSpaceAddress,
+ *   editorToRemoveSpaceId,
+ * });
+ * ```
+ */
+export declare function proposeRemoveEditor(context: GeoClientContext, params: ProposeRemoveEditorParams): {
+    to: `0x${string}`;
+    calldata: `0x${string}`;
+    proposalId: `0x${string}`;
+};
+/**
+ * Builds calldata for a DAO proposal that updates voting settings.
+ *
+ * Updating voting settings only supports SLOW voting.
+ * The client validates deterministic numeric bounds before encoding; the DAO
+ * contract still enforces flat threshold and quorum against the current editor
+ * count when the proposal executes.
+ *
+ * @example
+ * ```ts
+ * const tx = geo.daoSpaces.proposeUpdateVotingSettings({
+ *   authorSpaceId,
+ *   spaceId: daoSpaceId,
+ *   daoSpaceAddress,
+ *   votingSettings: {
+ *     partialPercentageSupportThreshold: 50,
+ *     universalPercentageSupportThreshold: 90,
+ *     flatSupportThreshold: 1,
+ *     quorum: 1,
+ *     durationInDays: 2,
+ *     disableFastPathAccessForNewMembers: true,
+ *     executionGracePeriodInDays: 14,
+ *   },
+ * });
+ * ```
+ */
+export declare function proposeUpdateVotingSettings(context: GeoClientContext, params: ProposeUpdateVotingSettingsParams): {
+    to: `0x${string}`;
+    calldata: `0x${string}`;
+    proposalId: `0x${string}`;
+};
+/**
+ * Builds calldata for requesting membership in a DAO space.
+ *
+ * Unlike governance proposals, this emits `GOVERNANCE.MEMBERSHIP_REQUESTED`
+ * and can be submitted by a non-member space.
+ *
+ * @example
+ * ```ts
+ * const tx = geo.daoSpaces.proposeRequestMembership({
+ *   authorSpaceId: requesterSpaceId,
+ *   spaceId: daoSpaceId,
+ * });
+ * ```
+ */
+export declare function proposeRequestMembership(context: GeoClientContext, params: ProposeRequestMembershipParams): {
+    to: `0x${string}`;
+    calldata: `0x${string}`;
+    proposalId: `0x${string}`;
+};
+/**
+ * Builds calldata for voting on a DAO proposal.
+ *
+ * @example
+ * ```ts
+ * const tx = geo.daoSpaces.voteProposal({
+ *   authorSpaceId,
+ *   spaceId: daoSpaceId,
+ *   proposalId,
+ *   versionId: 1,
+ *   vote: 'YES',
+ * });
+ * ```
+ *
+ * @param context Client context containing the target network configuration.
+ * @param params Author space, DAO space, proposal ID, and vote option.
+ * @returns Target registry address and calldata for `GOVERNANCE.PROPOSAL_VOTED`.
+ * @throws When IDs are invalid or the configured network is missing `SPACE_REGISTRY_ADDRESS`.
+ */
+export declare function voteProposal(context: GeoClientContext, params: VoteProposalParams): {
+    to: `0x${string}`;
+    calldata: `0x${string}`;
+};
+/**
+ * Builds calldata for executing a passed DAO proposal.
+ *
+ * @example
+ * ```ts
+ * const tx = geo.daoSpaces.executeProposal({
+ *   authorSpaceId,
+ *   spaceId: daoSpaceId,
+ *   proposalId,
+ * });
+ * ```
+ *
+ * @param context Client context containing the target network configuration.
+ * @param params Author space, DAO space, and proposal ID.
+ * @returns Target registry address and calldata for `GOVERNANCE.PROPOSAL_EXECUTED`.
+ * @throws When IDs are invalid or the configured network is missing `SPACE_REGISTRY_ADDRESS`.
+ */
+export declare function executeProposal(context: GeoClientContext, params: ExecuteProposalParams): {
+    to: `0x${string}`;
+    calldata: `0x${string}`;
+};
+/**
+ * Internal helpers for constructing DAO proposal actions.
+ *
+ * These helpers only encode DAO-space action payloads for the higher-level
+ * proposal helpers in this module.
+ *
+ * @example
+ * ```ts
+ * const action = actions.addEditor(daoSpaceAddress, editorSpaceId);
+ * ```
+ *
+ * @internal
+ */
+export declare const actions: {
+    publishEdit: typeof encodePublishEditProposalAction;
+    addEditor: (daoSpaceAddress: `0x${string}`, spaceId: string) => ProposalAction;
+    removeEditor: (daoSpaceAddress: `0x${string}`, spaceId: string) => ProposalAction;
+    addMember: (daoSpaceAddress: `0x${string}`, spaceId: string) => ProposalAction;
+    removeMember: (daoSpaceAddress: `0x${string}`, spaceId: string) => ProposalAction;
+    updateVotingSettings: typeof encodeUpdateVotingSettingsAction;
+};
+export {};
+//# sourceMappingURL=dao-spaces.d.ts.map

package/dist/src/client/dao-spaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dao-spaces.d.ts","sourceRoot":"","sources":["../../../src/client/dao-spaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,qBAAqB,CAAC;AAmB9C,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EACL,KAAK,4BAA4B,EAGjC,KAAK,mBAAmB,EAGzB,MAAM,+CAA+C,CAAC;AACvD,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAKnC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAIrD,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,4BAA4B,EAC5B,wBAAwB,GAAG,uBAAuB,CACnD,GAAG;IACF,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,EAAE,GAAG,MAAM,CAAC;IACpB,qBAAqB,CAAC,EAAE,KAAK,MAAM,EAAE,EAAE,CAAC;IACxC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,KAAK,MAAM,EAAE,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,KAAK,MAAM,EAAE,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,EAAE,EAAE,CAAC;IACV,MAAM,EAAE,EAAE,GAAG,MAAM,CAAC;IACpB,eAAe,EAAE,KAAK,MAAM,EAAE,CAAC;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,8BAA8B,GAAG;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,KAAK,MAAM,EAAE,CAAC;IAC/B,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,kCAAkC,GAAG,IAAI,CAAC,8BAA8B,EAAE,YAAY,CAAC,GAAG;IAC7F,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,8BAA8B,GAAG;IACpE,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,8BAA8B,GAAG;IACvE,qBAAqB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,kCAAkC,GAAG;IACxE,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,kCAAkC,GAAG;IAC3E,qBAAqB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG,kCAAkC,GAAG;IACnF,cAAc,EAAE,mBAAmB,CAAC;CACrC,CAAC;AAoIF,iBAAS,+BAA+B,CAAC,eAAe,EAAE,KAAK,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG,cAAc,CAyBpG;AAkBD,iBAAS,gCAAgC,CACvC,eAAe,EAAE,KAAK,MAAM,EAAE,EAC9B,cAAc,EAAE,mBAAmB,GAClC,cAAc,CA2BhB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAsB,MAAM,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,oBAAoB;;;;;GA2CnF;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,oBAAoB;;;;EAKrF;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,WAAW,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,iBAAiB;;;;;;;GA4CrF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,sBAAsB;;;;EAMzF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,yBAAyB;;;;EAM/F;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,sBAAsB;;;;EAWzF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,yBAAyB;;;;EAW/F;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,iCAAiC;;;;EAW/G;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,8BAA8B;;;;EAwBzG;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,kBAAkB;;;EAwBjF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,qBAAqB;;;EAgBvF;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO;;iCAEW,KAAK,MAAM,EAAE,WAAW,MAAM;oCAE3B,KAAK,MAAM,EAAE,WAAW,MAAM;iCAEjC,KAAK,MAAM,EAAE,WAAW,MAAM;oCAE3B,KAAK,MAAM,EAAE,WAAW,MAAM;;CAG/D,CAAC"}