SnsSwapCanister
Defined in: packages/sns/src/swap.canister.ts:33
Extends
Section titled “Extends”Canister<SnsSwapService>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew SnsSwapCanister(id,service,certifiedService):SnsSwapCanister
Defined in: packages/utils/dist/services/canister.d.ts:7
Parameters
Section titled “Parameters”Principal
service
Section titled “service”_SERVICE
certifiedService
Section titled “certifiedService”_SERVICE
Returns
Section titled “Returns”SnsSwapCanister
Inherited from
Section titled “Inherited from”Canister<SnsSwapService>.constructor
Properties
Section titled “Properties”caller()
Section titled “caller()”
protectedcaller: (__namedParameters) =>_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:9
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”QueryParams
Returns
Section titled “Returns”_SERVICE
Inherited from
Section titled “Inherited from”Canister.caller
certifiedService
Section titled “certifiedService”
protectedreadonlycertifiedService:_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:6
Inherited from
Section titled “Inherited from”Canister.certifiedService
service
Section titled “service”
protectedreadonlyservice:_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:5
Inherited from
Section titled “Inherited from”Canister.service
Accessors
Section titled “Accessors”canisterId
Section titled “canisterId”Get Signature
Section titled “Get Signature”get canisterId():
Principal
Defined in: packages/utils/dist/services/canister.d.ts:8
Returns
Section titled “Returns”Principal
Inherited from
Section titled “Inherited from”Canister.canisterId
Methods
Section titled “Methods”getDerivedState()
Section titled “getDerivedState()”getDerivedState(
__namedParameters):Promise<SnsGetDerivedStateResponse>
Defined in: packages/sns/src/swap.canister.ts:84
Get sale buyers state
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”QueryParams
Returns
Section titled “Returns”Promise<SnsGetDerivedStateResponse>
getFinalizationStatus()
Section titled “getFinalizationStatus()”getFinalizationStatus(
params):Promise<SnsGetAutoFinalizationStatusResponse>
Defined in: packages/sns/src/swap.canister.ts:148
Get sale lifecycle state
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<SnsGetAutoFinalizationStatusResponse>
getLifecycle()
Section titled “getLifecycle()”getLifecycle(
params):Promise<SnsGetLifecycleResponse>
Defined in: packages/sns/src/swap.canister.ts:142
Get sale lifecycle state
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<SnsGetLifecycleResponse>
getOpenTicket()
Section titled “getOpenTicket()”getOpenTicket(
params):Promise<SnsSwapTicket|undefined>
Defined in: packages/sns/src/swap.canister.ts:100
Return a sale ticket if created and not yet removed (payment flow)
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<SnsSwapTicket | undefined>
getSaleParameters()
Section titled “getSaleParameters()”getSaleParameters(
__namedParameters):Promise<SnsGetSaleParametersResponse>
Defined in: packages/sns/src/swap.canister.ts:92
Get sale parameters
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”QueryParams
Returns
Section titled “Returns”Promise<SnsGetSaleParametersResponse>
getUserCommitment()
Section titled “getUserCommitment()”getUserCommitment(
params):Promise<SnsSwapBuyerState|undefined>
Defined in: packages/sns/src/swap.canister.ts:72
Get user commitment
Parameters
Section titled “Parameters”params
Section titled “params”SnsGetBuyerStateRequest & QueryParams
Returns
Section titled “Returns”Promise<SnsSwapBuyerState | undefined>
newSaleTicket()
Section titled “newSaleTicket()”newSaleTicket(
params):Promise<SnsSwapTicket>
Defined in: packages/sns/src/swap.canister.ts:117
Create a sale ticket (payment flow)
Parameters
Section titled “Parameters”params
Section titled “params”NewSaleTicketParams
Returns
Section titled “Returns”Promise<SnsSwapTicket>
notifyParticipation()
Section titled “notifyParticipation()”notifyParticipation(
params):Promise<SnsRefreshBuyerTokensResponse>
Defined in: packages/sns/src/swap.canister.ts:64
Notify of the user participating in the swap
Parameters
Section titled “Parameters”params
Section titled “params”RefreshBuyerTokensRequest
Returns
Section titled “Returns”Promise<SnsRefreshBuyerTokensResponse>
notifyPaymentFailure()
Section titled “notifyPaymentFailure()”notifyPaymentFailure():
Promise<SnsSwapTicket|undefined>
Defined in: packages/sns/src/swap.canister.ts:54
Notify of the payment failure to remove the ticket
Returns
Section titled “Returns”Promise<SnsSwapTicket | undefined>
state()
Section titled “state()”state(
params):Promise<GetStateResponse>
Defined in: packages/sns/src/swap.canister.ts:48
Get the state of the swap
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<GetStateResponse>
create()
Section titled “create()”
staticcreate(options):SnsSwapCanister
Defined in: packages/sns/src/swap.canister.ts:34
Parameters
Section titled “Parameters”options
Section titled “options”SnsCanisterOptions<_SERVICE>
Returns
Section titled “Returns”SnsSwapCanister